Sa-Token之註解鑒權：優雅的將鑒權與業務代碼分離！
Sa-Token之註解鑒權：優雅的將鑒權與業務代碼分離！
Sa-Token 介紹：
Sa-Token 是一個輕量級 Java 權限認證框架，主要解決：登錄認證、權限認證、Session會話、單點登錄、OAuth2.0、微服務網關鑒權 等一系列權限相關問題。
今天，我們主要介紹一下 Sa-Token 中的註解鑒權，它可以讓我們：優雅的將鑒權與業務代碼分離！
前置工作：
1、首先我們在 pom.xml 引入依賴：
<!-- Sa-Token 權限認證 -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-boot-starter</artifactId>
<version>1.26.0</version>
</dependency>
2、註冊 Sa-Token 的註解攔截器
/**
* Sa-Token 配置類
*/
@Configuration
public class SaTokenConfigure implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new SaAnnotationInterceptor()).addPathPatterns("/**").excludePathPatterns("");
}
}
3、實現 StpInterface 接口，返回每個賬號擁有的權限碼集合
/**
* 自定義權限驗證接口擴展
*/
@Component
public class StpInterfaceImpl implements StpInterface {
// 返回一個賬號所擁有的權限碼集合
@Override
public List<String> getPermissionList(Object loginId, String loginType) {
return Arrays.asList("101", "user-add", "user-delete", "user-update", "user-get", "article-get");
}
// 返回一個賬號所擁有的角色標識集合
@Override
public List<String> getRoleList(Object loginId, String loginType) {
return Arrays.asList("admin", "super-admin");
}
}
4、然後創建登錄接口：
/**
* 登錄測試
*/
@RestController
public class LoginController {
// 測試登錄 ---- //localhost:8081/doLogin?name=zhang&pwd=123456
@RequestMapping("doLogin")
public SaResult doLogin(String name, String pwd) {
// 此處僅作模擬示例，真實項目需要從數據庫中查詢數據進行比對
if("zhang".equals(name) && "123456".equals(pwd)) {
StpUtil.login(10001);
return SaResult.ok("登錄成功");
}
return SaResult.error("登錄失敗");
}
// 測試註銷 ---- //localhost:8081/logout
@RequestMapping("logout")
public SaResult logout() {
StpUtil.logout();
return SaResult.ok();
}
}
5、啟動類
@SpringBootApplication
public class SaTokenDemoApplication {
public static void main(String[] args) {
SpringApplication.run(SaTokenDemoApplication.class, args);
}
}
OK，前置工作完畢，現在我們就可以開始使用 Sa-Token 註解鑒權了！
@SaCheckLogin: 登錄認證 —— 只有登錄之後才能進入該方法@SaCheckRole("admin"): 角色認證 —— 必須具有指定角色標識才能進入該方法@SaCheckPermission("user:add"): 權限認證 —— 必須具有指定權限才能進入該方法@SaCheckSafe: 二級認證校驗 —— 必須二級認證之後才能進入該方法@SaCheckBasic: HttpBasic認證 —— 只有通過 Basic 認證後才能進入該方法
登錄認證：
/**
* 註解鑒權測試
*/
@RestController
@RequestMapping("/at/")
public class AtController {
// 登錄認證，登錄之後才可以進入方法 ---- //localhost:8081/at/checkLogin
@SaCheckLogin
@RequestMapping("checkLogin")
public SaResult checkLogin() {
return SaResult.ok();
}
}
註：@SaCheckLogin註解可以加在類上，效果等同於標註在此類的所有方法上
權限認證：
@RestController
@RequestMapping("/at/")
public class AtController {
// 權限認證，具備user-add權限才可以進入方法 ---- //localhost:8081/at/checkPermission
@SaCheckPermission("user-add")
@RequestMapping("checkPermission")
public SaResult checkPermission() {
return SaResult.ok();
}
// 權限認證，同時具備所有權限才可以進入 ---- //localhost:8081/at/checkPermissionAnd
@SaCheckPermission({"user-add", "user-delete", "user-update"})
@RequestMapping("checkPermissionAnd")
public SaResult checkPermissionAnd() {
return SaResult.ok();
}
// 權限認證，只要具備其中一個就可以進入 ---- //localhost:8081/at/checkPermissionOr
@SaCheckPermission(value = {"user-add", "user-delete", "user-update"}, mode = SaMode.OR)
@RequestMapping("checkPermissionOr")
public SaResult checkPermissionOr() {
return SaResult.ok();
}
}
角色認證：
@RestController
@RequestMapping("/at/")
public class AtController {
// 角色認證，只有具備admin角色才可以進入 ---- //localhost:8081/at/checkRole
@SaCheckRole("admin")
@RequestMapping("checkRole")
public SaResult checkRole() {
return SaResult.ok();
}
}
註：@SaCheckRole 與 @SaCheckPermission 類似，可以指定 and | or 模式
二級認證：
@RestController
@RequestMapping("/at/")
public class AtController {
// 完成二級認證 ---- //localhost:8081/at/openSafe
@RequestMapping("openSafe")
public SaResult openSafe() {
StpUtil.openSafe(200); // 打開二級認證，有效期為200秒
return SaResult.ok();
}
// 通過二級認證後才可以進入 ---- //localhost:8081/at/checkSafe
@SaCheckSafe
@RequestMapping("checkSafe")
public SaResult checkSafe() {
return SaResult.ok();
}
}
註：必須先經過StpUtil.openSafe(200)打開二級認證，才可以通過 @SaCheckSafe 的檢查。
HttpBasic認證：
@RestController
@RequestMapping("/at/")
public class AtController {
// 通過Basic認證後才可以進入 ---- //localhost:8081/at/checkBasic
@SaCheckBasic(account = "sa:123456")
@RequestMapping("checkBasic")
public SaResult checkBasic() {
return SaResult.ok();
}
}
當我們訪問這個接口時，瀏覽器會強制彈出一個表單：
當我們輸入賬號密碼後 （sa / 123456），才可以繼續訪問數據：
總結
通過以上示例我們可以看出，Sa-Token 的註解鑒權還是非常強大的，能夠簡單、靈活的幫我我們完成鑒權需求。
