SpringBoot?使用?Sa-Token?完成權(quán)限認(rèn)證的操作方法
一、設(shè)計(jì)思路
所謂權(quán)限認(rèn)證，核心邏輯就是判斷一個(gè)賬號(hào)是否擁有指定權(quán)限：
- 有，就讓你通過。
- 沒有？那么禁止訪問！
深入到底層數(shù)據(jù)中，就是每個(gè)賬號(hào)都會(huì)擁有一個(gè)權(quán)限碼集合，框架來校驗(yàn)這個(gè)集合中是否包含指定的權(quán)限碼。
例如：當(dāng)前賬號(hào)擁有權(quán)限碼集合 ["user-add", "user-delete", "user-get"]，這時(shí)候我來校驗(yàn)權(quán)限 "user-update"，則其結(jié)果就是：驗(yàn)證失敗，禁止訪問。
動(dòng)態(tài)演示圖：
所以現(xiàn)在問題的核心就是：
- 如何獲取一個(gè)賬號(hào)所擁有的的權(quán)限碼集合？
- 本次操作需要驗(yàn)證的權(quán)限碼是哪個(gè)？
接下來，我們將介紹在 SpringBoot 中如何使用 Sa-Token 完成權(quán)限認(rèn)證操作。
Sa-Token 是一個(gè)輕量級(jí) java 權(quán)限認(rèn)證框架，主要解決登錄認(rèn)證、權(quán)限認(rèn)證、單點(diǎn)登錄、OAuth2、微服務(wù)網(wǎng)關(guān)鑒權(quán) 等一系列權(quán)限相關(guān)問題。
Gitee 開源地址：https://gitee.com/dromara/sa-token
首先在項(xiàng)目中引入 Sa-Token 依賴：
<!-- Sa-Token 權(quán)限認(rèn)證 -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-boot-starter</artifactId>
<version>1.34.0</version>
</dependency>
注：如果你使用的是 SpringBoot 3.x，只需要將 sa-token-spring-boot-starter 修改為 sa-token-spring-boot3-starter 即可。
二、獲取當(dāng)前賬號(hào)權(quán)限碼集合
因?yàn)槊總€(gè)項(xiàng)目的需求不同，其權(quán)限設(shè)計(jì)也千變?nèi)f化，因此 [ 獲取當(dāng)前賬號(hào)權(quán)限碼集合 ] 這一操作不可能內(nèi)置到框架中，
所以 Sa-Token 將此操作以接口的方式暴露給你，以方便你根據(jù)自己的業(yè)務(wù)邏輯進(jìn)行重寫。
你需要做的就是新建一個(gè)類，實(shí)現(xiàn) StpInterface接口，例如以下代碼：
/**
* 自定義權(quán)限驗(yàn)證接口擴(kuò)展
*/
@Component // 保證此類被SpringBoot掃描，完成Sa-Token的自定義權(quán)限驗(yàn)證擴(kuò)展
public class StpInterfaceImpl implements StpInterface {
/**
* 返回一個(gè)賬號(hào)所擁有的權(quán)限碼集合
*/
@Override
public List<String> getPermissionList(Object loginId, String loginType) {
// 本list僅做模擬，實(shí)際項(xiàng)目中要根據(jù)具體業(yè)務(wù)邏輯來查詢權(quán)限
List<String> list = new ArrayList<String>();
list.add("101");
list.add("user.add");
list.add("user.update");
list.add("user.get");
// list.add("user.delete");
list.add("art.*");
return list;
}
/**
* 返回一個(gè)賬號(hào)所擁有的角色標(biāo)識(shí)集合 (權(quán)限與角色可分開校驗(yàn))
*/
@Override
public List<String> getRoleList(Object loginId, String loginType) {
// 本list僅做模擬，實(shí)際項(xiàng)目中要根據(jù)具體業(yè)務(wù)邏輯來查詢角色
List<String> list = new ArrayList<String>();
list.add("admin");
list.add("super-admin");
return list;
}
}參數(shù)解釋：
- loginId：賬號(hào)id，即你在調(diào)用
StpUtil.login(id)時(shí)寫入的標(biāo)識(shí)值。 - loginType：賬號(hào)體系標(biāo)識(shí)，此處可以暫時(shí)忽略，在 [ 多賬戶認(rèn)證 ] 章節(jié)下會(huì)對(duì)這個(gè)概念做詳細(xì)的解釋。
注意點(diǎn)：
類上一定要加上 @Component 注解，保證組件被 Springboot 掃描到，成功注入到 Sa-Token 框架內(nèi)。
三、權(quán)限校驗(yàn)
啟動(dòng)類：
@SpringBootApplication
public class SaTokenCaseApplication {
public static void main(String[] args) {
SpringApplication.run(SaTokenCaseApplication.class, args);
System.out.println("\n啟動(dòng)成功：Sa-Token配置如下：" + SaManager.getConfig());
}
}
然后就可以用以下api來鑒權(quán)了
// 獲?。寒?dāng)前賬號(hào)所擁有的權(quán)限集合
StpUtil.getPermissionList();
// 判斷：當(dāng)前賬號(hào)是否含有指定權(quán)限, 返回 true 或 false
StpUtil.hasPermission("user.add");
// 校驗(yàn)：當(dāng)前賬號(hào)是否含有指定權(quán)限, 如果驗(yàn)證未通過，則拋出異常: NotPermissionException
StpUtil.checkPermission("user.add");
// 校驗(yàn)：當(dāng)前賬號(hào)是否含有指定權(quán)限 [指定多個(gè)，必須全部驗(yàn)證通過]
StpUtil.checkPermissionAnd("user.add", "user.delete", "user.get");
// 校驗(yàn)：當(dāng)前賬號(hào)是否含有指定權(quán)限 [指定多個(gè)，只要其一驗(yàn)證通過即可]
StpUtil.checkPermissionOr("user.add", "user.delete", "user.get");擴(kuò)展：NotPermissionException 對(duì)象可通過 getLoginType() 方法獲取具體是哪個(gè) StpLogic 拋出的異常
四、角色校驗(yàn)
在Sa-Token中，角色和權(quán)限可以獨(dú)立驗(yàn)證
// 獲取：當(dāng)前賬號(hào)所擁有的角色集合
StpUtil.getRoleList();
// 判斷：當(dāng)前賬號(hào)是否擁有指定角色, 返回 true 或 false
StpUtil.hasRole("super-admin");
// 校驗(yàn)：當(dāng)前賬號(hào)是否含有指定角色標(biāo)識(shí), 如果驗(yàn)證未通過，則拋出異常: NotRoleException
StpUtil.checkRole("super-admin");
// 校驗(yàn)：當(dāng)前賬號(hào)是否含有指定角色標(biāo)識(shí) [指定多個(gè)，必須全部驗(yàn)證通過]
StpUtil.checkRoleAnd("super-admin", "shop-admin");
// 校驗(yàn)：當(dāng)前賬號(hào)是否含有指定角色標(biāo)識(shí) [指定多個(gè)，只要其一驗(yàn)證通過即可]
StpUtil.checkRoleOr("super-admin", "shop-admin");擴(kuò)展：NotRoleException 對(duì)象可通過 getLoginType() 方法獲取具體是哪個(gè) StpLogic 拋出的異常
五、攔截全局異常
有同學(xué)要問，鑒權(quán)失敗，拋出異常，然后呢？要把異常顯示給用戶看嗎？當(dāng)然不可以！
你可以創(chuàng)建一個(gè)全局異常攔截器，統(tǒng)一返回給前端的格式，參考：
@RestControllerAdvice
public class GlobalExceptionHandler {
// 全局異常攔截
@ExceptionHandler
public SaResult handlerException(Exception e) {
e.printStackTrace();
return SaResult.error(e.getMessage());
}
}六、權(quán)限通配符
Sa-Token允許你根據(jù)通配符指定泛權(quán)限，例如當(dāng)一個(gè)賬號(hào)擁有art.*的權(quán)限時(shí)，art.add、art.delete、art.update都將匹配通過
// 當(dāng)擁有 art.* 權(quán)限時(shí)
StpUtil.hasPermission("art.add"); // true
StpUtil.hasPermission("art.update"); // true
StpUtil.hasPermission("goods.add"); // false
// 當(dāng)擁有 *.delete 權(quán)限時(shí)
StpUtil.hasPermission("art.delete"); // true
StpUtil.hasPermission("user.delete"); // true
StpUtil.hasPermission("user.update"); // false
// 當(dāng)擁有 *.js 權(quán)限時(shí)
StpUtil.hasPermission("index.js"); // true
StpUtil.hasPermission("index.css"); // false
StpUtil.hasPermission("index.html"); // false!> 上帝權(quán)限：當(dāng)一個(gè)賬號(hào)擁有 "*" 權(quán)限時(shí)，他可以驗(yàn)證通過任何權(quán)限碼 （角色認(rèn)證同理）
七、如何把權(quán)限精確到按鈕級(jí)？
權(quán)限精確到按鈕級(jí)的意思就是指：權(quán)限范圍可以控制到頁面上的每一個(gè)按鈕是否顯示。
思路：如此精確的范圍控制只依賴后端已經(jīng)難以完成，此時(shí)需要前端進(jìn)行一定的邏輯判斷。
如果是前后端一體項(xiàng)目，可以參考：Thymeleaf 標(biāo)簽方言，如果是前后端分離項(xiàng)目，則：
- 在登錄時(shí)，把當(dāng)前賬號(hào)擁有的所有權(quán)限碼一次性返回給前端。
- 前端將權(quán)限碼集合保存在
localStorage或其它全局狀態(tài)管理對(duì)象中。 - 在需要權(quán)限控制的按鈕上，使用 js 進(jìn)行邏輯判斷，例如在
Vue框架中我們可以使用如下寫法：
<button v-if="arr.indexOf('user.delete') > -1">刪除按鈕</button>
其中：arr是當(dāng)前用戶擁有的權(quán)限碼數(shù)組，user.delete是顯示按鈕需要擁有的權(quán)限碼，刪除按鈕是用戶擁有權(quán)限碼才可以看到的內(nèi)容。
注意：以上寫法只為提供一個(gè)參考示例，不同框架有不同寫法，大家可根據(jù)項(xiàng)目技術(shù)棧靈活封裝進(jìn)行調(diào)用。
八、前端有了鑒權(quán)后端還需要鑒權(quán)嗎？
需要！
前端的鑒權(quán)只是一個(gè)輔助功能，對(duì)于專業(yè)人員這些限制都是可以輕松繞過的，為保證服務(wù)器安全，無論前端是否進(jìn)行了權(quán)限校驗(yàn)，后端接口都需要對(duì)會(huì)話請(qǐng)求再次進(jìn)行權(quán)限校驗(yàn)！
九、來個(gè)小示例，加深一下印象
新建 JurAuthController，復(fù)制以下代碼
package com.pj.cases.use;
import java.util.List;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import cn.dev33.satoken.stp.StpUtil;
import cn.dev33.satoken.util.SaResult;
/**
* Sa-Token 權(quán)限認(rèn)證示例
*
* @author kong
* @since 2022-10-13
*/
@RestController
@RequestMapping("/jur/")
public class JurAuthController {
/*
* 前提1：首先調(diào)用登錄接口進(jìn)行登錄，代碼在 com.pj.cases.use.LoginAuthController 中有詳細(xì)解釋，此處不再贅述
* ---- http://localhost:8081/acc/doLogin?name=zhang&pwd=123456
*
* 前提2：項(xiàng)目實(shí)現(xiàn) StpInterface 接口，代碼在 com.pj.satoken.StpInterfaceImpl
* Sa-Token 將從此實(shí)現(xiàn)類獲取 每個(gè)賬號(hào)擁有哪些權(quán)限。
*
* 然后我們就可以使用以下示例中的代碼進(jìn)行鑒權(quán)了
*/
// 查詢權(quán)限 ---- http://localhost:8081/jur/getPermission
@RequestMapping("getPermission")
public SaResult getPermission() {
// 查詢權(quán)限信息 ，如果當(dāng)前會(huì)話未登錄，會(huì)返回一個(gè)空集合
List<String> permissionList = StpUtil.getPermissionList();
System.out.println("當(dāng)前登錄賬號(hào)擁有的所有權(quán)限：" + permissionList);
// 查詢角色信息 ，如果當(dāng)前會(huì)話未登錄，會(huì)返回一個(gè)空集合
List<String> roleList = StpUtil.getRoleList();
System.out.println("當(dāng)前登錄賬號(hào)擁有的所有角色：" + roleList);
// 返回給前端
return SaResult.ok()
.set("roleList", roleList)
.set("permissionList", permissionList);
}
// 權(quán)限校驗(yàn) ---- http://localhost:8081/jur/checkPermission
@RequestMapping("checkPermission")
public SaResult checkPermission() {
// 判斷：當(dāng)前賬號(hào)是否擁有一個(gè)權(quán)限，返回 true 或 false
// 如果當(dāng)前賬號(hào)未登錄，則永遠(yuǎn)返回 false
StpUtil.hasPermission("user.add");
StpUtil.hasPermissionAnd("user.add", "user.delete", "user.get"); // 指定多個(gè)，必須全部擁有才會(huì)返回 true
StpUtil.hasPermissionOr("user.add", "user.delete", "user.get"); // 指定多個(gè)，只要擁有一個(gè)就會(huì)返回 true
// 校驗(yàn)：當(dāng)前賬號(hào)是否擁有一個(gè)權(quán)限，校驗(yàn)不通過時(shí)會(huì)拋出 `NotPermissionException` 異常
// 如果當(dāng)前賬號(hào)未登錄，則永遠(yuǎn)校驗(yàn)失敗
StpUtil.checkPermission("user.add");
StpUtil.checkPermissionAnd("user.add", "user.delete", "user.get"); // 指定多個(gè)，必須全部擁有才會(huì)校驗(yàn)通過
StpUtil.checkPermissionOr("user.add", "user.delete", "user.get"); // 指定多個(gè)，只要擁有一個(gè)就會(huì)校驗(yàn)通過
return SaResult.ok();
}
// 角色校驗(yàn) ---- http://localhost:8081/jur/checkRole
@RequestMapping("checkRole")
public SaResult checkRole() {
// 判斷：當(dāng)前賬號(hào)是否擁有一個(gè)角色，返回 true 或 false
// 如果當(dāng)前賬號(hào)未登錄，則永遠(yuǎn)返回 false
StpUtil.hasRole("admin");
StpUtil.hasRoleAnd("admin", "ceo", "cfo"); // 指定多個(gè)，必須全部擁有才會(huì)返回 true
StpUtil.hasRoleOr("admin", "ceo", "cfo"); // 指定多個(gè)，只要擁有一個(gè)就會(huì)返回 true
// 校驗(yàn)：當(dāng)前賬號(hào)是否擁有一個(gè)角色，校驗(yàn)不通過時(shí)會(huì)拋出 `NotRoleException` 異常
// 如果當(dāng)前賬號(hào)未登錄，則永遠(yuǎn)校驗(yàn)失敗
StpUtil.checkRole("admin");
StpUtil.checkRoleAnd("admin", "ceo", "cfo"); // 指定多個(gè)，必須全部擁有才會(huì)校驗(yàn)通過
StpUtil.checkRoleOr("admin", "ceo", "cfo"); // 指定多個(gè)，只要擁有一個(gè)就會(huì)校驗(yàn)通過
return SaResult.ok();
}
// 權(quán)限通配符 ---- http://localhost:8081/jur/wildcardPermission
@RequestMapping("wildcardPermission")
public SaResult wildcardPermission() {
// 前提條件：在 StpInterface 實(shí)現(xiàn)類中，為賬號(hào)返回了 "art.*" 泛權(quán)限
StpUtil.hasPermission("art.add"); // 返回 true
StpUtil.hasPermission("art.delete"); // 返回 true
StpUtil.hasPermission("goods.add"); // 返回 false，因?yàn)榍熬Y不符合
// * 符合可以出現(xiàn)在任意位置，比如權(quán)限碼的開頭，當(dāng)賬號(hào)擁有 "*.delete" 時(shí)
StpUtil.hasPermission("goods.add"); // false
StpUtil.hasPermission("goods.delete"); // true
StpUtil.hasPermission("art.delete"); // true
// 也可以出現(xiàn)在權(quán)限碼的中間，比如當(dāng)賬號(hào)擁有 "shop.*.user" 時(shí)
StpUtil.hasPermission("shop.add.user"); // true
StpUtil.hasPermission("shop.delete.user"); // true
StpUtil.hasPermission("shop.delete.goods"); // false，因?yàn)楹缶Y不符合
// 注意點(diǎn)：
// 1、上帝權(quán)限：當(dāng)一個(gè)賬號(hào)擁有 "*" 權(quán)限時(shí)，他可以驗(yàn)證通過任何權(quán)限碼
// 2、角色校驗(yàn)也可以加 * ，指定泛角色，例如： "*.admin"，暫不贅述
return SaResult.ok();
}
}代碼注釋已針對(duì)每一步操作做出詳細(xì)解釋，大家可根據(jù)可參照注釋中的訪問鏈接進(jìn)行逐步測(cè)試。
參考資料
- Sa-Token 文檔：https://sa-token.cc
- Gitee 倉庫地址：https://gitee.com/dromara/sa-token
- GitHub 倉庫地址：https://github.com/dromara/sa-token
到此這篇關(guān)于SpringBoot權(quán)限認(rèn)證Sa-Token的使用總結(jié)的文章就介紹到這了,更多相關(guān)SpringBoot Sa-Token使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java是一種面向?qū)ο蟮木幊陶Z言,它提供了一個(gè)非常強(qiáng)大的類庫,其中一個(gè)基本類是Object類,下面這篇文章主要給大家介紹了Java中Object類用法的相關(guān)資料,文中通過實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-04-04
在 Java 中,比較對(duì)象的方法有多種多樣,每種都有其適用的場(chǎng)景,通過深入理解 equals() 方法、Comparable 接口和 Comparator 接口,我們能夠更好地處理對(duì)象之間的比較,使代碼更加靈活、清晰和健壯,本文給大家介紹Java 中比較對(duì)象的用法,感興趣的朋友一起看看吧2023-12-12
Java詳解對(duì)象終止方法finalize()的用法
在前面的 jvm 中, 需要補(bǔ)充幾個(gè)部分的內(nèi)容, 接著來看 finalize() 機(jī)制, 它可以使接近死亡的對(duì)象復(fù)活, 下來我們來看是怎么一回事2022-05-05
Java如何根據(jù)文件名前綴自動(dòng)分組圖片文件
一大堆文件（比如圖片）堆在一個(gè)目錄下,它們的命名規(guī)則遵循一定的格式,混在一起很難管理,所以本文小編就和大家介紹一下如何使用Java根據(jù)文件名前綴自動(dòng)分組圖片文件吧2025-05-05
這篇文章主要介紹了nacos如何修改默認(rèn)的用戶名密碼問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-01-01
Java實(shí)現(xiàn)雪花算法(snowflake)
這篇文章主要介紹了Java實(shí)現(xiàn)雪花算法(snowflake)，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-08-08
這篇文章主要介紹了Java 線程池的相關(guān)資料，幫助大家更好的理解和學(xué)習(xí)Java，感興趣的朋友可以了解下2020-08-08
這篇文章主要介紹了RabbitMQ 如何解決消息冪等性的問題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-07-07
這篇文章主要給大家介紹了關(guān)于Springboot配置圖片虛擬映射的相關(guān)資料,文中通過實(shí)例代碼介紹的非常詳細(xì),對(duì)大家學(xué)習(xí)或者使用springboot具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2021-11-11
本篇文章主要分享了java中遍歷map的兩種方式，代碼簡潔明了，有需要的朋友可以參考下，希望會(huì)有所幫助2016-12-12