快捷導(dǎo)航

一文學(xué)會使用sa-token解決網(wǎng)站權(quán)限驗證

更新時間：2023年07月18日 11:36:37 作者：省長[機(jī)智]

這篇文章主要為大家介紹了使用sa-token解決網(wǎng)站權(quán)限驗證方法詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

sa-token是什么？

sa-token是一個JavaWeb輕量級權(quán)限認(rèn)證框架，其API調(diào)用非常簡單，有多簡單呢？以登錄驗證為例，你只需要：

// 在登錄時寫入當(dāng)前會話的賬號id 
StpUtil.setLoginId(10001);    
// 然后在任意需要校驗登錄處調(diào)用以下API  
// --- 如果當(dāng)前會話未登錄，這句代碼會拋出 `NotLoginException`異常
StpUtil.checkLogin();

沒有復(fù)雜的封裝！不要任何的配置！只需這兩行簡單的調(diào)用，即可輕松完成系統(tǒng)登錄鑒權(quán)！

與其它權(quán)限認(rèn)證框架相比，sa-token盡力保證兩點(diǎn)：

上手簡單：能自動化的配置全部自動化，不讓你費(fèi)腦子
功能強(qiáng)大：能涵蓋的功能全部涵蓋，不讓你用個框架還要自己給框架打各種補(bǔ)丁

如果上面的示例能夠證明sa-token的簡單，那么以下API則可以證明sa-token的強(qiáng)大

StpUtil.setLoginId(10001);          // 標(biāo)記當(dāng)前會話登錄的賬號id
StpUtil.getLoginId();               // 獲取當(dāng)前會話登錄的賬號id
StpUtil.isLogin();                  // 獲取當(dāng)前會話是否已經(jīng)登錄, 返回true或false
StpUtil.logout();                   // 當(dāng)前會話注銷登錄
StpUtil.logoutByLoginId(10001);     // 讓賬號為10001的會話注銷登錄（踢人下線）
StpUtil.hasRole("super-admin");     // 查詢當(dāng)前賬號是否含有指定角色標(biāo)識, 返回true或false
StpUtil.hasPermission("user:add");  // 查詢當(dāng)前賬號是否含有指定權(quán)限, 返回true或false
StpUtil.getSession();               // 獲取當(dāng)前賬號id的Session 
StpUtil.getSessionByLoginId(10001); // 獲取賬號id為10001的Session
StpUtil.getTokenValueByLoginId(10001);  // 獲取賬號id為10001的token令牌值

涵蓋功能

登錄驗證 —— 輕松登錄鑒權(quán)，并提供五種細(xì)分場景值
權(quán)限驗證 —— 攔截違規(guī)調(diào)用，不同角色不同授權(quán)
Session會話 —— 專業(yè)的數(shù)據(jù)緩存中心
踢人下線 —— 將違規(guī)用戶立刻清退下線
模擬他人賬號 —— 實時操作任意用戶狀態(tài)數(shù)據(jù)
持久層擴(kuò)展 —— 可集成redis、MongoDB等專業(yè)緩存中間件
多賬號認(rèn)證體系 —— 比如一個商城項目的user表和admin表分開鑒權(quán)
無Cookie模式 —— APP、小程序等前后臺分離場景
注解式鑒權(quán) —— 優(yōu)雅的將鑒權(quán)與業(yè)務(wù)代碼分離
花式token生成 —— 內(nèi)置六種token風(fēng)格，還可自定義token生成策略
自動續(xù)簽 —— 提供兩種token過期策略，靈活搭配使用，還可自動續(xù)簽
組件自動注入 —— 零配置與Spring等框架集成
更多功能正在集成中... —— 如有您有好想法或者建議，歡迎加群交流
...

SpringBoot集成示例

1、創(chuàng)建項目

在IDE中新建一個Springboot項目，例如：sa-token-demo-springboot（不會的同學(xué)請自行百度或者參考github示例）

2、設(shè)置jar包依賴

在 pom.xml 中添加依賴：

<!-- sa-token 權(quán)限認(rèn)證, 在線文檔：http://sa-token.dev33.cn/ -->
<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-boot-starter</artifactId>
    <version>1.8.0</version>
</dependency>

3、配置文件

你可以零配置啟動項目
但同時你也可以在application.yml中增加如下配置，定制性使用框架：

spring: 
    # sa-token配置
    sa-token: 
        # token名稱 (同時也是cookie名稱)
        token-name: satoken
        # token有效期，單位s 默認(rèn)30天, -1代表永不過期 
        timeout: 2592000
        # token臨時有效期 (指定時間內(nèi)無操作就視為token過期) 單位: 秒
        activity-timeout: -1
        # 是否允許同一賬號并發(fā)登錄 (為true時允許一起登錄, 為false時新登錄擠掉舊登錄) 
        allow-concurrent-login: false
        # 在多人登錄同一賬號時，是否共用一個token (為true時所有登錄共用一個token, 為false時每次登錄新建一個token) 
        is-share: false
        # token風(fēng)格
        token-style: uuid

如果你習(xí)慣于 application.properties 類型的配置文件，那也很好辦:

springboot properties與yml 配置文件的區(qū)別

4、創(chuàng)建主類

在項目中新建包 com.pj ，在此包內(nèi)新建主類 SaTokenDemoApplication.java，輸入以下代碼：

@SpringBootApplication
public class SaTokenDemoApplication {
    public static void main(String[] args) throws JsonProcessingException {
        SpringApplication.run(SaTokenDemoApplication.class, args); // run-->         
        System.out.println("啟動成功：sa-token配置如下：" + SaTokenManager.getConfig());
    }
}