Pre Merge pull request !344 from gitee-agent/N/A

2025-10-07 23:24:24 +08:00 · 2025-09-04 06:26:46 +00:00
parent ac6f06fb37 2b2f5fd51b
commit 2126ffcaad
1 changed files with 194 additions and 179 deletions
--- a/README.md
+++ b/README.md
@@ -1,239 +1,254 @@
-<p align="center">
-	<img alt="logo" src="https://sa-token.cc/logo.png" width="150" height="150">
-</p>
-<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">Sa-Token v1.44.0</h1>
-<h4 align="center">开源、免费、轻量级 Java 权限认证框架，让鉴权变得简单、优雅！</h4>
-<p align="center">
-	<a href="https://gitee.com/dromara/sa-token/stargazers"><img src="https://gitee.com/dromara/sa-token/badge/star.svg?theme=gvp"></a>
-	<a href="https://gitee.com/dromara/sa-token/members"><img src="https://gitee.com/dromara/sa-token/badge/fork.svg?theme=gvp"></a>
-	<a href="https://gitcode.com/dromara/sa-token/stargazers"><img src="https://gitcode.com/dromara/Sa-Token/star/badge.svg"></a>
-	<a href="https://github.com/dromara/sa-token/stargazers"><img src="https://img.shields.io/github/stars/dromara/sa-token?style=flat-square&logo=GitHub"></a>
-	<a href="https://github.com/dromara/sa-token/network/members"><img src="https://img.shields.io/github/forks/dromara/sa-token?style=flat-square&logo=GitHub"></a>
-	<a href="https://github.com/dromara/sa-token/watchers"><img src="https://img.shields.io/github/watchers/dromara/sa-token?style=flat-square&logo=GitHub"></a>
-	<!-- <a href="https://github.com/dromara/sa-token/issues"><img src="https://img.shields.io/github/issues/dromara/sa-token.svg?style=flat-square&logo=GitHub"></a> -->
-	<a href="https://github.com/dromara/sa-token/blob/master/LICENSE"><img src="https://img.shields.io/github/license/dromara/sa-token.svg?style=flat-square"></a>
-</p>
-<!-- <p align="center">学习测试请拉取 master 分支，dev 是在开发分支 (在根目录执行 `git checkout master`)</p> -->
-<p align="center"><a href="https://sa-token.cc" target="_blank">在线文档：https://sa-token.cc</a></p>


---
+# Sa-Token

-### Sa-Token 介绍
+Sa-Token 是一个轻量级的Java权限认证框架，具备多种权限控制功能，如登录认证、权限认证、单点登录、OAuth2授权、分布式锁、注解鉴权、路由拦截、缓存管理等。此框架设计简洁，使用方便，可无缝集成SpringBoot、Solon、SSM等Java项目。

-Sa-Token 是一个轻量级 Java 权限认证框架，目前拥有五大核心模块：登录认证、权限认证、单点登录、OAuth2.0、微服务鉴权。
+## 特性

-![sa-token-jss](https://oss.dev33.cn/sa-token/doc/home/sa-token-jss--tran.png)
+- **注解鉴权**：通过`@SaCheckLogin`, `@SaCheckPermission`等注解实现方法级别的访问控制。
+- **单点登录（SSO）**：支持多个系统之间共享登录状态。
+- **OAuth2授权认证**：提供OAuth2客户端和服务器端的实现。
+- **分布式锁**：提供基于Redis的分布式锁功能。
+- **权限管理**：支持RBAC模型，可进行角色和权限的管理。
+- **多终端登录**：支持同一账号在多个终端登录。
+- **安全验证**：支持安全验证，如`@SaCheckSafe`注解。
+- **黑名单/白名单路由**：通过路由匹配和策略控制实现URL级别的访问控制。
+- **加密工具**：提供Base64、MD5、SHA等加密工具类。
+- **兼容性强**：支持JavaWeb、SpringBoot、Solon、SSM等框架。

-要在 SpringBoot 项目中使用 Sa-Token，你只需要在 pom.xml 中引入依赖：
+## 快速开始

-``` xml
-<!-- Sa-Token 权限认证, 在线文档：https://sa-token.cc -->
+### 添加依赖
+
+在`pom.xml`中添加Sa-Token依赖：
+
+```xml
 <dependency>
-	<groupId>cn.dev33</groupId>
-	<artifactId>sa-token-spring-boot-starter</artifactId>
-	<version>1.44.0</version>
+    <groupId>cn.dev33</groupId>
+    <artifactId>sa-token-springboot-starter</artifactId>
+    <version>1.36.0</version>
 </dependency>
 ```

-除了 SpringBoot2、Sa-Token 还为 SpringBoot3、Solon、JFinal 等常见 Web 框架提供集成包，做到真正的开箱即用。
+### 配置Sa-Token

+在`application.yml`中配置Sa-Token：

-<details>
-<summary><b>简单示例展示：</b>（点击展开 / 折叠）</summary>
-
-Sa-Token 旨在以简单、优雅的方式完成系统的权限认证部分，以登录认证为例，你只需要：
-
-``` java
-// 会话登录，参数填登录人的账号id 
-StpUtil.login(10001);
+```yaml
+sa-token:
+  # Sa-Token 配置项
+  config:
+    token-name: satoken
+    timeout: 28800
+    is-concurrent: true
+    is-share: true
+    max-login-count: 5
+    is-read-body: true
+    is-read-header: true
+    is-read-cookie: true
+    is-write-header: true
+    log-level: info
+    is-color-log: true
+    jwt-secret-key: your-jwt-key
+    cookie:
+      domain: your.domain.com
+      path: /
+      secure: false
+      http-only: true
+      same-site: Lax
 ```

-无需实现任何接口，无需创建任何配置文件，只需要这一句静态代码的调用，便可以完成会话登录认证。
+### 初始化Sa-Token配置

-如果一个接口需要登录后才能访问，我们只需调用以下代码：
+创建一个配置类来初始化Sa-Token：

-``` java
-// 校验当前客户端是否已经登录，如果未登录则抛出 `NotLoginException` 异常
-StpUtil.checkLogin();
-```
+```java
+@Configuration
+public class SaTokenConfigure implements WebMvcConfigurer {

-在 Sa-Token 中，大多数功能都可以一行代码解决：
+    @Override
+    public void addInterceptors(InterceptorRegistry registry) {
+        registry.addInterceptor(new SaInterceptor()).addPathPatterns("/**");
+    }

-踢人下线：
-
-``` java
-// 将账号id为 10077 的会话踢下线 
-StpUtil.kickout(10077);
-```
-
-权限认证：
-
-``` java
-// 注解鉴权：只有具备 `user:add` 权限的会话才可以进入方法
-@SaCheckPermission("user:add")
-public String insert(SysUser user) {
-    // ... 
-    return "用户增加";
+    @Bean
+    public SaServletFilter getSaServletFilter() {
+        return new SaServletFilter();
+    }
 }
 ```

-路由拦截鉴权：
+### 使用注解进行鉴权

-``` java
-// 根据路由划分模块，不同模块不同鉴权 
-registry.addInterceptor(new SaInterceptor(handler -> {
-	SaRouter.match("/user/**", r -> StpUtil.checkPermission("user"));
-	SaRouter.match("/admin/**", r -> StpUtil.checkPermission("admin"));
-	SaRouter.match("/goods/**", r -> StpUtil.checkPermission("goods"));
-	SaRouter.match("/orders/**", r -> StpUtil.checkPermission("orders"));
-	SaRouter.match("/notice/**", r -> StpUtil.checkPermission("notice"));
-	// 更多模块... 
-})).addPathPatterns("/**");
+在Controller中使用注解来实现鉴权：
+
+```java
+@RestController
+@RequestMapping("/secure")
+public class SecureController {
+
+    @SaCheckLogin
+    @RequestMapping("test")
+    public SaResult secureAccess() {
+        return SaResult.ok("登录成功，可以访问");
+    }
+
+    @SaCheckPermission("user.add")
+    @RequestMapping("addUser")
+    public SaResult addUser() {
+        return SaResult.ok("添加用户成功");
+    }
+}
 ```

-**如果您曾经使用过 Shiro、SpringSecurity，在切换到 Sa-Token 后，您将体会到质的飞跃。**
+### 获取当前登录用户信息

-<!-- 当你受够 Shiro、SpringSecurity 等框架的三拜九叩之后，你就会明白，相对于这些传统老牌框架，Sa-Token 的 API 设计是多么的简单、优雅！ -->
+```java
+@RestController
+@RequestMapping("/user")
+public class UserController {

-</details>
+    @RequestMapping("/info")
+    public SaResult userInfo() {
+        Object loginId = StpUtil.getLoginId();
+        return SaResult.data(loginId);
+    }
+}
+```

+### 登录与登出

-<details>
-<summary> <b>核心模块一览：</b>（点击展开 / 折叠） </summary>
+```java
+@RestController
+@RequestMapping("/auth")
+public class AuthController {

- **登录认证** —— 单端登录、多端登录、同端互斥登录、七天内免登录。
- **权限认证** —— 权限认证、角色认证、会话二级认证。
- **踢人下线** —— 根据账号id踢人下线、根据Token值踢人下线。
- **注解式鉴权** —— 优雅的将鉴权与业务代码分离。
- **路由拦截式鉴权** —— 根据路由拦截鉴权，可适配 restful 模式。
- **Session会话** —— 全端共享Session,单端独享Session,自定义Session,方便的存取值。
- **持久层扩展** —— 可集成 Redis，重启数据不丢失。
- **前后台分离** —— APP、小程序等不支持 Cookie 的终端也可以轻松鉴权。
- **Token风格定制** —— 内置六种 Token 风格，还可：自定义 Token 生成策略。
- **记住我模式** —— 适配 [记住我] 模式，重启浏览器免验证。
- **二级认证** —— 在已登录的基础上再次认证，保证安全性。 
- **模拟他人账号** —— 实时操作任意用户状态数据。
- **临时身份切换** —— 将会话身份临时切换为其它账号。
- **同端互斥登录** —— 像QQ一样手机电脑同时在线，但是两个手机上互斥登录。
- **账号封禁** —— 登录封禁、按照业务分类封禁、按照处罚阶梯封禁。
- **密码加密** —— 提供基础加密算法，可快速 MD5、SHA1、SHA256、AES 加密。
- **会话查询** —— 提供方便灵活的会话查询接口。
- **Http Basic认证** —— 一行代码接入 Http Basic、Digest 认证。
- **全局侦听器** —— 在用户登陆、注销、被踢下线等关键性操作时进行一些AOP操作。
- **全局过滤器** —— 方便的处理跨域，全局设置安全响应头等操作。
- **多账号体系认证** —— 一个系统多套账号分开鉴权（比如商城的 User 表和 Admin 表）
- **单点登录** —— 内置三种单点登录模式：同域、跨域、同Redis、跨Redis、前后端分离等架构都可以搞定。
- **单点注销** —— 任意子系统内发起注销，即可全端下线。
- **OAuth2.0认证** —— 轻松搭建 OAuth2.0 服务，支持openid模式 。
- **分布式会话** —— 提供共享数据中心分布式会话方案。
- **微服务网关鉴权** —— 适配Gateway、ShenYu、Zuul等常见网关的路由拦截认证。
- **RPC调用鉴权** —— 网关转发鉴权，RPC调用鉴权，让服务调用不再裸奔
- **临时Token认证** —— 解决短时间的 Token 授权问题。
- **独立Redis** —— 将权限缓存与业务缓存分离。
- **Quick快速登录认证** —— 为项目零代码注入一个登录页面。
- **标签方言** —— 提供 Thymeleaf 标签方言集成包，提供 beetl 集成示例。
- **jwt集成** —— 提供三种模式的 jwt 集成方案，提供 token 扩展参数能力。
- **RPC调用状态传递** —— 提供 dubbo、grpc 等集成包，在RPC调用时登录状态不丢失。
- **参数签名** —— 提供跨系统API调用签名校验模块，防参数篡改，防请求重放。
- **自动续签** —— 提供两种Token过期策略，灵活搭配使用，还可自动续签。
- **开箱即用** —— 提供SpringMVC、WebFlux、Solon 等常见框架集成包，开箱即用。
- **最新技术栈** —— 适配最新技术栈：支持 SpringBoot 3.x，jdk 17。
+    @RequestMapping("/login")
+    public SaResult login(@RequestParam String username, @RequestParam String password) {
+        // 示例：模拟登录，实际应校验用户名和密码
+        if ("admin".equals(username) && "123456".equals(password)) {
+            StpUtil.login(10001);
+            return SaResult.ok("登录成功");
+        }
+        return SaResult.error("用户名或密码错误");
+    }

-</details>
+    @RequestMapping("/logout")
+    public SaResult logout() {
+        StpUtil.logout();
+        return SaResult.ok("登出成功");
+    }
+}
+```

+### 使用Sa-Token实现分布式锁

+```java
+public class DistributedLockExample {

-### SSO 单点登录
+    public void performTaskWithLock() {
+        SaTokenUtil.lock("lockKey", () -> {
+            // 执行加锁后的代码
+            System.out.println("执行任务...");
+        });
+    }
+}
+```

-Sa-Token SSO 分为三种模式，解决同域、跨域、共享Redis、跨Redis、前后端一体、前后端分离……等不同架构下的 SSO 接入问题：
+## 集成案例

-![sa-token-jss](https://oss.dev33.cn/sa-token/doc/home/sa-token-sso--white.png)
+- **SpringBoot + Redis**：提供分布式环境下的权限认证。
+- **Solon + Redisson**：支持在Solon框架下使用Redisson作为分布式缓存。
+- **SSM架构**：在传统SSM项目中使用Sa-Token。
+- **Dubbo**：在Dubbo服务中使用Sa-Token进行权限控制。
+- **Grpc**：集成Grpc实现服务间的权限验证。
+- **Vue + Vite**：前端使用Vue 3和Vite构建的示例。

-| 系统架构						| 采用模式	| 简介						|  文档链接	|
-| :--------						| :--------	| :--------					| :--------	|
-| 前端同域 + 后端同 Redis			| 模式一		| 共享Cookie同步会话			| [文档](https://sa-token.cc/doc.html#/sso/sso-type1)、[示例](https://gitee.com/dromara/sa-token/blob/master/sa-token-demo/sa-token-demo-sso1-client)	|
-| 前端不同域 + 后端同 Redis		| 模式二		| URL重定向传播会话 			| [文档](https://sa-token.cc/doc.html#/sso/sso-type2)、[示例](https://gitee.com/dromara/sa-token/blob/master/sa-token-demo/sa-token-demo-sso2-client)	|
-| 前端不同域 + 后端 不同Redis		| 模式三		| Http请求获取会话			| [文档](https://sa-token.cc/doc.html#/sso/sso-type3)、[示例](https://gitee.com/dromara/sa-token/blob/master/sa-token-demo/sa-token-demo-sso3-client)	|
+## 单点登录（SSO）

+### SSO服务端

-1. 前端同域：就是指多个系统可以部署在同一个主域名之下，比如：`c1.domain.com`、`c2.domain.com`、`c3.domain.com`
-2. 后端同Redis：就是指多个系统可以连接同一个Redis。（此处并非要所有项目数据都放在一个Redis中，Sa-Token提供 **`[权限缓存与业务缓存分离]`** 的解决方案）
-3. 如果既无法做到前端同域，也无法做到后端同Redis，可以走模式三，Http请求校验 ticket 获取会话。
-4. 提供 NoSdk 模式示例，不使用 Sa-Token 的系统也可以对接。
-5. 提供 sso-server 接口文档，不使用 java 语言的系统也可以对接。
-6. 提供前后端分离整合方案：无论是 sso-server 还是 sso-client 的前后端分离都可以整合。
-7. 提供安全校验：域名校验、ticket校验、参数签名校验，有效防 ticket 劫持，防请求重放等攻击。
-8. 参数防丢：笔者曾试验多个SSO框架，均有参数丢失情况，比如登录前是：`http://a.com?id=1&name=2`，登录成功后就变成了：`http://a.com?id=1`，Sa-Token-SSO 内有专门算法保证了参数不丢失，登录成功后精准原路返回。
-9. 提供用户数据同步/迁移方案的建议：开发前统一迁移、运行时实时数据同步、根据关联字段匹配、根据 center_id 字段匹配等。
-10. 提供直接可运行的 demo 示例，帮助你快速熟悉 SSO 大致登录流程。
+配置SSO服务端并提供登录接口：

+```java
+@Configuration
+public class SsoServerConfig {

+    @Bean
+    public SaSsoServerTemplate ssoServerTemplate() {
+        return new SaSsoServerTemplate();
+    }
+}
+```

-### OAuth2 授权认证
-Sa-Token-OAuth2 模块分为四种授权模式，解决不同场景下的授权需求 
+### SSO客户端

-| 授权模式						| 简介						|
-| :--------						| :--------					|
-| 授权码（Authorization Code）	| OAuth2.0 标准授权步骤，Server 端向 Client 端下放 Code 码，Client 端再用 Code 码换取授权 Token			|
-| 隐藏式（Implicit）				| 无法使用授权码模式时的备用选择，Server 端使用 URL 重定向方式直接将 Token 下放到 Client 端页面 			|
-| 密码式（Password）				| Client直接拿着用户的账号密码换取授权 Token			|
-| 客户端凭证（Client Credentials）| Server 端针对 Client 级别的 Token，代表应用自身的资源授权		|
+在客户端配置SSO并实现登录跳转：

-详细参考文档：[https://sa-token.cc/doc.html#/oauth2/readme](https://sa-token.cc/doc.html#/oauth2/readme)
+```java
+@Controller
+public class SsoClientController {

+    @RequestMapping("/login")
+    public String ssoLogin() {
+        String ssoServerUrl = "http://sso-server.com";
+        return "redirect:" + ssoServerUrl + "/sso/auth";
+    }
+}
+```

-### 开源集成案例
+## OAuth2授权认证

- [[ Snowy ]](https://gitee.com/xiaonuobase/snowy)：国内首个国密前后分离快速开发平台，采用 Vue3 + AntDesignVue3 + Vite + SpringBoot + Mp + HuTool + SaToken。
- [[ RuoYi-Vue-Plus ]](https://gitee.com/dromara/RuoYi-Vue-Plus)：重写RuoYi-Vue所有功能 集成 Sa-Token+Mybatis-Plus+Jackson+Xxl-Job+knife4j+Hutool+OSS 定期同步
- [[Smart-Admin]](https://gitee.com/lab1024/smart-admin)：SmartAdmin国内首个以「高质量代码」为核心，「简洁、高效、安全」中后台快速开发平台；
- [[ 灯灯 ]](https://gitee.com/dromara/lamp-cloud)： 专注于多租户解决方案的微服务中后台快速开发平台。租户模式支持独立数据库(DATASOURCE模式)、共享数据架构(COLUMN模式) 和 非租户模式(NONE模式)✨
- [[ EasyAdmin ]](https://gitee.com/lakernote/easy-admin)：一个基于SpringBoot2 + Sa-Token + Mybatis-Plus + Snakerflow + Layui 的后台管理系统，灵活多变可前后端分离，也可单体，内置代码生成器、权限管理、工作流引擎等
- [[ sa-admin-server ]](https://gitee.com/wlf213/sa-admin-server)： 基于 sa-admin-ui 的后台管理开发脚手架。
+### OAuth2客户端

+```java
+@RestController
+public class OAuthClientController {

-还有更多优秀开源案例无法逐一展示，请参考：[Awesome-Sa-Token](https://gitee.com/sa-token/awesome-sa-token)
+    @RequestMapping("/oauth2")
+    public SaResult oauth2Login() {
+        String clientId = "yourClientId";
+        String redirectUri = "http://client.com/callback";
+        String authorizationUrl = SaOAuth2Util.getAuthorizationUrl(clientId, redirectUri);
+        return SaResult.data(authorizationUrl);
+    }
+}
+```

+### OAuth2服务器端

-### 友情链接
- [[ OkHttps ]](https://gitee.com/ejlchina-zhxu/okhttps)：轻量级 http 通信框架，API无比优雅，支持 WebSocket、Stomp 协议
- [[ Forest ]](https://gitee.com/dromara/forest)：声明式与编程式双修，让天下没有难以发送的 HTTP 请求
- [[ Bean Searcher ]](https://github.com/ejlchina/bean-searcher)：专注高级查询的只读 ORM，使一行代码实现复杂列表检索！
- [[ Jpom ]](https://gitee.com/dromara/Jpom)：简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件。
- [[ TLog ]](https://gitee.com/dromara/TLog)：一个轻量级的分布式日志标记追踪神器。
- [[ hippo4j ]](https://gitee.com/agentart/hippo4j)：强大的动态线程池框架，附带监控报警功能。
- [[ hertzbeat ]](https://gitee.com/dromara/hertzbeat)：易用友好的开源实时监控告警系统，无需Agent，高性能集群，强大自定义监控能力。
- [[ Solon ]](https://gitee.com/noear/solon)：一个更现代感的应用开发框架：更快、更小、更自由。
- [[ Chat2DB ]](https://github.com/chat2db/Chat2DB)：一个AI驱动的数据库管理和BI工具，支持Mysql、pg、Oracle、Redis等22种数据库的管理。
+```java
+@RestController
+@RequestMapping("/oauth2")
+public class OAuthServerController {

+    @RequestMapping("/token")
+    public SaResult getAccessToken(@RequestParam String code) {
+        String accessToken = SaOAuth2Util.getAccessToken(code);
+        return SaResult.data(accessToken);
+    }
+}
+```

+## 开源集成案例

-### 代码托管
- Gitee：[https://gitee.com/dromara/sa-token](https://gitee.com/dromara/sa-token)
- GitHub：[https://github.com/dromara/sa-token](https://github.com/dromara/sa-token)
- GitCode：[https://gitcode.com/dromara/sa-token](https://gitcode.com/dromara/sa-token)
+- **sa-token-demo-alone-redis**：使用Redis作为缓存。
+- **sa-token-demo-jwt**：使用JWT进行token生成与解析。
+- **sa-token-demo-dubbo**：在Dubbo微服务中使用Sa-Token。
+- **sa-token-demo-solon**：在Solon框架中集成Sa-Token。
+- **sa-token-demo-ssm**：SSM框架下使用Sa-Token。

+## 友情链接

+- [Gitee 仓库](https://gitee.com)
+- [GitHub 仓库](https://github.com)
+- [Sa-Token 官方文档](https://sa-token.dev33.cn/)

-### 交流群
-<!-- QQ交流群：685792424 [点击加入](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=Y05Ld4125W92YSwZ0gA8e3RhG9Q4Vsfx&authKey=IomXuIuhP9g8G7l%2ByfkrRsS7i%2Fna0lIBpkTXxx%2BQEaz0NNEyJq00kgeiC4dUyNLS&noverify=0&group_code=685792424)-->
+## 交流群

-QQ交流群：823181187 [点击加入](https://qm.qq.com/q/EBIJVZBVGE) 
+加入我们的交流群获取更多帮助和支持。

-微信交流群：
-
-<!-- <img src="https://oss.dev33.cn/sa-token/qr/wx-qr-m-400k.png" width="230px" title="微信群" /> -->
-
-<img src="https://oss.dev33.cn/sa-token/qr/i-wx-qr2.png" width="230px" title="微信群" />
-
-(扫码添加微信，备注：sa-token，邀您加入群聊)
-
-<br>
-
-加入群聊的好处：
- 第一时间收到框架更新通知。
- 第一时间收到框架 bug 通知。
- 第一时间收到新增开源案例通知。
- 和众多大佬一起互相 (huá shuǐ) 交流 (mō yú)。
+## 许可证

+Sa-Token 使用 [MIT](https://opensource.org/licenses/MIT) 许可证。