# sa-token **Repository Path**: solonlab/sa-token ## Basic Information - **Project Name**: sa-token - **Description**: 这可能是史上功能最全的Java权限认证框架！目前已集成——登录认证、权限认证、分布式Session会话、微服务网关鉴权、单点登录、OAuth2.0、踢人下线、Redis集成、前后台分离、记住我模式、模拟他人账号、临时身份切换、账号封禁、多账号认证体系、注解式鉴权、路由拦截式鉴权、花式token生成、自动续签、同端互斥登录、会话治理、密码加密、jwt集成、Spring集成、WebFlux集成... - **Primary Language**: Java - **License**: Apache-2.0 - **Default Branch**: dev - **Homepage**: http://sa-token.dev33.cn/ - **GVP Project**: No ## Statistics - **Stars**: 6 - **Forks**: 4471 - **Created**: 2021-05-30 - **Last Updated**: 2026-05-31 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

logo

Sa-Token v1.45.0

✨ 开源、免费、一站式 java 权限认证框架，让鉴权变得简单、优雅！

在线文档：https://sa-token.cc

--- ### 📝 前言： 回望 2020 年初，我为 Sa-Token 提交第一行代码之际，彼时市面上 Java 缺少的不仅是一个简洁好用的鉴权框架，更是一整套清晰、自洽的权限架构设计思想。 因此，这几年间我将大量时间倾注在 Sa-Token 的文档编写，几乎每一章节、每一句话、每一个字都经过反复修改、精细打磨，以求做到最清晰、干练、易懂的表述。用心阅读文档，你学习到的将不止是 Sa-Token 框架本身，更是绝大多数场景下权限设计的最佳实践。 ### 🛠️ Sa-Token 介绍 Sa-Token 是一个轻量级 Java 权限认证框架，目前拥有五大核心模块：登录认证、权限认证、单点登录、OAuth2.0、微服务鉴权。 **你还在手搓以下功能？Stop ⚠️ 让 Sa-Token 来！** ![sa-token-jss](https://sa-token.cc/big-file/index/intro/sa-token-jss--tran.png) 要在 SpringBoot 项目中使用 Sa-Token，你只需要在 pom.xml 中引入依赖： ``` xml cn.dev33 sa-token-spring-boot-starter 1.45.0 ``` 除了支持 SpringBoot2、Sa-Token 还为 SpringBoot3/4、Solon、JFinal 等常见 Web 框架提供集成包，做到真正的开箱即用。
简单示例展示：（点击展开 / 折叠） Sa-Token 旨在以简单、优雅的方式完成系统的权限认证部分，以登录认证为例，你只需要： ``` java // 会话登录，参数填登录人的账号id StpUtil.login(10001); ``` 无需实现任何接口，无需创建任何配置文件，只需要这一句静态代码的调用，便可以完成会话登录认证。 如果一个接口需要登录后才能访问，我们只需调用以下代码： ``` java // 校验当前客户端是否已经登录，如果未登录则抛出 `NotLoginException` 异常 StpUtil.checkLogin(); ``` 在 Sa-Token 中，大多数功能都可以一行代码解决： 踢人下线： ``` java // 将账号id为 10077 的会话踢下线 StpUtil.kickout(10077); ``` 权限认证： ``` java // 注解鉴权：只有具备 `user:add` 权限的会话才可以进入方法 @SaCheckPermission("user:add") public String insert(SysUser user) { // ... return "用户增加"; } ``` 路由拦截鉴权： ``` 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("/**"); ``` **如果您曾经使用过 Shiro、SpringSecurity，在切换到 Sa-Token 后，您将体会到质的飞跃。**
核心模块一览：（点击展开 / 折叠） - **登录认证** —— 单端登录、多端登录、同端互斥登录、七天内免登录。 - **权限认证** —— 权限认证、角色认证、会话二级认证。 - **踢人下线** —— 根据账号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。
### 🍃 SSO 单点登录 Sa-Token SSO 分为三种模式，可解决：`同域、跨域、共享Redis、跨Redis、前后端一体、前后端分离、纯 js、vue2、vue3、java 项目、非 java 项目` 等架构下的 SSO 认证需求： ![sa-token-jss](https://sa-token.cc/big-file/doc/sso/sa-token-sso--white.png) | 系统架构 | 采用模式 | 简介 | 文档链接 | | :-------- | :-------- |:----------------| :-------- | | 前端同域 + 后端同 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) | 1. 前端同域：就是指多个系统可以部署在同一个主域名之下，比如：`c1.domain.com`、`c2.domain.com`、`c3.domain.com` 2. 后端同 Redis：就是指多个系统可以连接同一个 Redis，共享会话数据。 3. 如果无法做到前端同域、后端同 Redis，可以走托底的模式三：Http请求校验 ticket 获取会话。 4. 提供：NoSdk 模式示例 + sso-server 接口文档，非 Sa-Token 项目、非 java 项目也可以对接。 5. 提供：多重安全校验：域名校验、ticket校验、参数签名校验，有效防 ticket 劫持，防请求重放等攻击。 6. 提供：大量实战痛点教学：sso-server 前后端分离设计、sso-client 前后端分离设计、用户数据同步/迁移方案设计。 7. 提供：直接可运行的 demo 示例，助你快速熟悉 SSO 大致登录流程。 8. 提供：深度细节优化，参数防丢：笔者曾试验多个SSO框架，均有参数丢失情况，比如登录前是：`http://a.com?id=1&name=2`，登录成功后就变成了：`http://a.com?id=1`，Sa-Token-SSO 内有专门算法保证了参数不丢失，登录成功后精准原路返回。 ### 🍂 OAuth2 授权认证 Sa-Token OAuth2 模块分为四种授权模式，解决不同场景下的授权需求 | 授权模式 | 简介 | | :-------- | :-------- | | 授权码式 | OAuth2 标准授权步骤，server 端下放 code，client 端获取 code 码兑换 access_token | | 隐藏式 | 备用选择，server 端使用 URL 重定向方式直接将 access_token 下放到 client 端页面 | | 密码式 | client 直接拿着用户的账号密码换取授权 access_token | | 客户端凭证式 | server 端针对 client 级别的 client_token，代表应用自身的资源授权 | 详细参考文档：[https://sa-token.cc/doc.html#/oauth2/readme](https://sa-token.cc/doc.html#/oauth2/readme) ### 📖❓ 疑问解答 **1、Sa-Token 功能全不全？** 七年磨一剑：五大核心模块(登录、鉴权、SSO、OAuth2、微服务) + 众多实用插件 (短 token、jwt 集成、API 参数签名、API Key 秘钥授权...) 我们提供的不只是权限认证，我们提供的是一站式解决方案。 **2、Sa-Token 好不好学？** 中文文档 + 中文代码注释 + 中文交流社区 + 大量实战案例博客 + 多个视频教程 + 大量优秀开源项目集成案例。 **3、Sa-Token 用的人多不多？** 截止统计日 (2026-1-25) 起，Sa-Token 在： - Gitee 关注量达到 48627 Star，位列平台所有推荐项目排行榜第一名。 - GitHub 关注量达到 18523 Star，是主要竞争框架 Spring Security 的 1.97 倍，Apache Shiro 的 4.19 倍。 - 25+ 微信粉丝群 (500人)，8+ QQ粉丝群 (1000人 or 2000人) ，在线文档访问量月PV 20万+。 这是众多开发者用脚投票的数据，相信这些数据比任何言语都能证明 Sa-Token 的热度。 **4、Sa-Token 有哪些权威认证？** 曾获荣誉包括但不限于：Gitee GVP 最有价值开源项目、GitCode G-Star 优质开源项目、OSCHINA 2021 人气指数 TOP 30 开源项目、OSCHINA 2022 年度最火热中国开源项目社区之一、开放原子基金会2023快速成长开源项目、 Dromara 组织顶尖项目（之一）、可信开源社区共同体预备成员、所在开源社区 “Dromara” 荣获《2024中国互联网发展创新与投资大赛（开源）》二等奖。 Gitee High Star 计划项目(5000+star)。Gitee 2025年度开源项目 Web应用开发 Top 2。 **5、Sa-Token 收费吗？** Sa-Token 采用 Apache-2.0 开源协议，承诺框架本身与在线文档永久免费开放。当然如果您有心赞助 Sa-Token，我们也不回避：[赞助链接](https://sa-token.cc/doc.html#/more/sa-token-donate)。 我们将定期同步赞助者名单到在线文档展示。（您需要注意的一点是：该赞助仅为友情赞助，不提供任何商业交换） **6、Sa-Token 是封装的 SpringSecurity 吗？是套壳 ApacheShiro 吗？** 不是。Sa-Token 不是一个后台模板，也不是针对 xx 框架的二次封装套壳，而是从 0 开始的纯血自研框架，核心包零依赖，完全自主可控的架构内核 + 众多主流框架的集成适配。 #### 证书 ⭐ 奖杯 🏆 荣誉展示
### 🚀 优秀开源集成案例 - [[ Snowy ]](https://gitee.com/xiaonuobase/snowy)：国内首个国密前后分离快速开发平台，采用 Vue3 + Vite + SpringBoot + Mp + HuTool + SaToken。 - [[ RuoYi-Vue-Plus ]](https://gitee.com/dromara/RuoYi-Vue-Plus)：重写RuoYi-Vue所有功能 集成 Sa-Token、Mybatis-Plus、Xxl-Job、knife4j、OSS 定期同步。 - [[ Smart-Admin ]](https://gitee.com/lab1024/smart-admin)：SmartAdmin 国内首个以「高质量代码」为核心，「简洁、高效、安全」中后台快速开发平台。 - [[ 橙单 ]](https://gitee.com/orangeform/orange-admin)： 橙单中台化低代码生成器。可完整支持多应用、多租户、多渠道、工作流、框架技术栈自由组合等。 - [[ 灯灯 ]](https://gitee.com/dromara/lamp-cloud)： 专注于多租户解决方案的中后台快速开发平台。支持独立数据库、共享数据架构 和 非租户模式 ✨ - [[ 拾壹博客 ]](https://gitee.com/quequnlong/shiyi-blog)：一款 vue + springboot 前后端分离的博客系统。 还有更多优秀开源案例无法逐一展示，请参考：[Awesome-Sa-Token](https://gitee.com/sa-token/awesome-sa-token) ### 🌍 其它语言版本 Sa-Token 社区成员贡献了多语言实现版本： - Rust 版本：[https://gitee.com/sa-tokens/sa-token-rust](https://gitee.com/sa-tokens/sa-token-rust) - Go 版本：[https://gitee.com/sa-tokens/sa-token-go](https://gitee.com/sa-tokens/sa-token-go) - PHP 版本：[https://gitee.com/jinan-jimeng-network_0/real-token](https://gitee.com/jinan-jimeng-network_0/real-token) 我们诚邀对上述语言较为熟练的开发者，一起建设相关版本。🤝 ### 🔗 友情链接 - [[ 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种数据库的管理。 ### 📦 代码托管 - 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) - AtomGit：[https://atomgit.com/dromara/sa-token](https://atomgit.com/dromara/sa-token) ### 📚 示例大全 **我们为框架几乎所有技术点均单独制作了对应的集成示例，此压缩包共计 60+ Demo**：涵盖 Sa-Token 登录认证、权限认证、SSO 单点登录、OAUth2 统一认证、微服务鉴权、API Key 认证、JWT集成、跨系统调用参数签名校验 等鉴权认证的方方面面。 下载地址：[https://sa-token.cc/doc.html#/more/download-demos](https://sa-token.cc/doc.html#/more/download-demos) ### 💬 交流群 QQ交流群：1098917026 [点击加入](https://qm.qq.com/q/26OFBGd2Zy) 微信交流群： PS：扫码添加微信 (备注：sa-token)，邀您加入群聊。
微信群 加入群聊的好处： - 第一时间收到框架更新通知。 - 第一时间收到框架 bug 通知。 - 第一时间收到新增开源案例通知。 - 和众多大佬一起互相 (huá shuǐ) 交流 (mō yú) 🖐️🐟️。