name: sa-token-dev description: >- Sa-Token(cn.dev33)Java 权限认证框架开发助手。 在 Java / Spring Boot 项目中开发任何登录、注册、登出、认证、鉴权、权限、角色、token、 会话管理、接口保护、路由拦截、SSO 单点登录、OAuth2.0、JWT、踢人下线、账号封禁、记住我、 二级认证、多账号体系、微服务网关鉴权相关功能时使用本技能——无论用户是否提到 Sa-Token (login / logout / authentication / authorization / permission / role / session / JWT / SSO / access control)。 项目依赖已含 sa-token(sa-token-spring-boot*-starter 系列,覆盖 SpringBoot 2/3/4 与 WebFlux 响应式变体)或代码出现 StpUtil / StpInterface / @SaCheckLogin / @SaCheckPermission / @SaCheckRole / SaInterceptor / SaRouter / SaSession 时必须使用本技能; 项目尚无任何认证框架时,先主动询问用户是否引入 Sa-Token 再开发。 不适用于:已使用 Spring Security / Shiro 的项目(不建议迁移)、纯 JWT 自实现方案、非 Java 语言。 agent_created: true version: 2.1.1 slug: sa-token-dev displayName: Sa-Token 开发助手
面向日常 Java 开发的 Sa-Token 编码助手。推荐 1.45.0+(最新稳定版),1.40.x 及以上全线适用,核心 API(StpUtil / SaInterceptor / StpInterface / SaSession 等)保持向后兼容,新版本可能在已有基础上新增方法,本 skill 中的示例在 1.40.x ~ 最新版均可直接使用。历史版本差异已在文中以 v1.xx.0+ 标注。
采用完全本地自包含策略:所有知识沉淀于本地 references/,运行时不依赖任何外部文档站点。
| SpringBoot | starter 坐标 | 环境 |
|---|---|---|
| 2.x | sa-token-spring-boot-starter |
Servlet (SpringMVC) |
| 3.x | sa-token-spring-boot3-starter |
Servlet (SpringMVC) |
| 4.x | sa-token-spring-boot4-starter |
Servlet (SpringMVC) |
| 2.x (响应式) | sa-token-reactor-spring-boot-starter |
WebFlux / Gateway |
| 3.x (响应式) | sa-token-reactor-spring-boot3-starter |
WebFlux / Gateway |
| 4.x (响应式) | sa-token-reactor-spring-boot4-starter |
WebFlux / Gateway |
sa-token-spring-boot-starter 和 sa-token-reactor-spring-boot-starter,项目无法启动。sa-token-redis-template + commons-pool2,分布式场景必须。spring.redis 改为 spring.data.redis。任务涉及登录、注册、认证、鉴权、权限、token、会话、SSO、OAuth2 等编码——即使用户没提 Sa-Token——先检索项目依赖(在 pom.xml / build.gradle 中搜 sa-token、spring-security、shiro):
7w4.net提供免费和付费技能下载。
| 探测结果 | 动作 |
|---|---|
依赖含 sa-token-* |
直接激活本技能,走下方流程 |
| 无 sa-token,也无 Spring Security / Shiro | 主动询问用户是否引入 Sa-Token(轻量、零配置可启动,登录/权限/SSO/OAuth2 一站式);同意 → 按「版本与依赖」表 + references/01-setup.md 引入后继续;拒绝 → 退出本技能,不再打扰 |
| 已使用 Spring Security / Shiro | 告知不适用并退出,不建议迁移 |
| 信号 | 判定 |
|---|---|
| Java/SpringBoot 项目中的登录/注册/认证/鉴权/权限/token/会话/SSO 任务(未指明框架) | 激活,先执行「第 0 步」依赖探测 |
依赖含 sa-token-* / 代码用 StpUtil / SaInterceptor / SaRouter |
激活 |
提到 @SaCheckLogin / @SaCheckPermission / @SaCheckRole / @SaIgnore / "Sa-Token" / "sa-token" |
激活 |
| SSO 单点登录 / OAuth2.0 / 微服务网关鉴权 / JWT / API-Key / API 签名 | 激活 |
| 已使用 Spring Security / Shiro 的项目 | 不适用(不建议迁移) |
| 非 Java 语言(Go / Python / Node.js) | 不适用 |
| 纯 JWT 自实现(无 Sa-Token 依赖) | 不适用 |
检查点:判定为「不适用」→ 告知用户当前问题不在 Sa-Token 范围,建议退出本技能。
| 需求场景(关键词) | 读取文件 | 同时警告 |
|---|---|---|
| 依赖、starter 选择、yml 配置、最小示例、生产配置清单 | references/01-setup.md |
SpringBoot 版本决定 starter 坐标;零配置可启动但生产需调 timeout/is-concurrent |
| 登录、登出、会话查询、Token 查询、timeout vs active-timeout、登录流程 | references/02-login-auth.md |
timeout 与 active-timeout 是两个独立机制;v1.29.0+ renewTimeout 可续期 |
| 权限认证、角色认证、StpInterface、通配符、RBAC 设计模式 | references/03-permission.md |
必须实现 StpInterface;后端必须再次校验;通配符 * 代表全通过 |
| 注解鉴权(@SaCheck*、SaMode、orRole、@SaIgnore、@SaCheckOr)、注解 vs 路由选型 | references/04-annotation.md |
必须先注册 SaInterceptor 否则注解无效;粗粒度用路由、细粒度用注解、可混用 |
| 路由拦截鉴权(SaInterceptor / SaRouter / match / free / stop / back)、全局白名单 | references/05-interceptor-route.md |
SaInterceptor 注册后注解才生效;路由做白名单 + 注解做细粒度(推荐混用) |
| Session 会话(Account/Token/Custom)、三大作用域 | references/06-session.md |
SaSession ≠ HttpSession,不可混用 |
| 集成 Redis、前后端分离 token 传递、Redis 部署模式 | references/07-redis-frontsep.md |
SB3.x 前缀 spring.data.redis;前端塞 header,参数名即 tokenName;分布式场景必须 |
| StpUtil 常用 API(登录/踢人/封禁/二级认证/身份切换/多账号) | references/08-api-stputil.md |
踢人 vs 注销 vs 顶人场景值不同;kickout 与 disable 不同、封禁需先踢下线 |
| 排错:NotLoginException 场景值、异常码、注解不生效、跨域、反代 uri、过滤器异常 | references/09-pitfalls.md |
NotLoginException 7 种场景值;过滤器/跨域异常不进 @ExceptionHandler |
| Agent 常见错误与最佳实践(核心价值,每次生成代码前必看) | references/10-antipattern.md |
28 条 antipattern,生成代码前必对照 |
| 高级特性:记住我、同端互斥、账号封禁、二级认证、身份切换、多账号、密码加密、Token 风格/前缀、全局侦听器/过滤器、Http Basic/Digest | references/11-advanced.md |
v1.31.0+ login 不再自动校验封禁需显式 checkDisable;记住我本质是 Cookie 持久 vs 临时(前后端分离需前端控制);同端互斥需 is-concurrent=false + device;二级认证 openSafe+checkSafe(@SaCheckSafe);多账号推荐 StpKit 门面、LoginType 不可运行时改;Token 前缀与值间必须有空格、Cookie 模式需额外配置 |
| SSO 单点登录(三种模式)、OAuth2.0(四种授权模式)、SSO vs OAuth2 选型 | references/12-sso-oauth2.md |
三种模式选型看前端是否同域+后端是否同 Redis;SSO vs OAuth2 选型;allow-url 生产必须配详细地址 |
| 微服务:分布式 Session、网关统一鉴权、内部服务隔离(Same-Token)、依赖引入 | references/13-micro-service.md |
网关用 Reactor 依赖、子服务用 Servlet;SaReactorFilter 全局过滤器;Redis 必须;Feign 内部调用需传 Same-Token |
| 插件:JWT、API-Key、API 签名、AOP 注解、临时 Token、Alone Redis、SpEL 表达式 | references/14-plugin.md |
JWT 是可选 token 风格(非默认):有状态场景用 simple-uuid token 风格(不引 JWT)即可;仅当用户要 JWT 格式时才在 Simple/Mixin/Stateless 中选——Simple=JWT+Redis(推荐),Mixin=JWT+Redis 且登录数据内嵌 Token,Stateless=JWT 无 Redis 不支持踢人;网关用 Reactor 依赖 |
以下代码模式命中时主动提醒用户;更完整的强制规则见「核心强约束」。
| 代码模式 | 主动提醒 |
|---|---|
is-share: true + 需要踢人/顶人下线 |
is-share=true 时多端共用 token,踢人语义变化,需向用户说明 |
SSO allow-url: "*" |
生产环境必须配置为详细 URL(详见 12-sso-oauth2.md) |
active-timeout 配了但自动续签不理解 |
getLoginId/checkLogin 等调用时自动续签;关闭用 autoRenew=false |
| Feign 内部调用未传 Same-Token | 子服务会拒绝未携带 Same-Token 的请求(详见 13-micro-service.md) |
@SaCheckDisable 不指定 service |
校验全账号封禁;分类封禁需指定 service |
@SaCheck* 注解依赖 SaInterceptor,默认关闭。必须先 registry.addInterceptor(new SaInterceptor()).addPathPatterns("/**") 注册,注解才生效。高版本 SpringBoot(≥2.6.x)可能需额外加 @EnableWebMvc。StpUtil.getSession() 返回的 SaSession 与 HttpSession 无任何关系,互不通。用 Sa-Token 时统一使用 SaSession,不要混用。StpUtil.checkPermission() 或 @SaCheckPermission 再次校验。StpInterface 实现类(@Component),返回权限码和角色集合。不实现则所有权限/角色校验通过。timeout 是长久有效期(默认 30 天),active-timeout 是最低活跃频率(超时冻结)。两者独立,任一过期 token 不可用。-1 代表永久/不限制。logout=正常退出;kickout=被动踢下线(场景值 -5);replaced=被顶下线(场景值 -4)。is-share 和 is-concurrent 配置影响行为。StpUtil.disable(id, time) 不会自动让已登录用户下线。需先 StpUtil.kickout(id) 再 disable。v1.31.0+ login() 不再自动校验封禁,需显式 checkDisable。sa-token-spring-boot-starter(Servlet)和 sa-token-reactor-spring-boot-starter(Reactor)不可同时引入同一项目。SaTokenInfo,前端塞 header(参数名即 tokenName,默认 satoken)。SaServletFilter / SaReactorFilter 中抛出的异常不进入 Spring 全局异常处理器,必须通过 .setError() 处理。spring.redis.*,SpringBoot 3.x 用 spring.data.redis.*。配错导致连接失败。simple-uuid token 风格 + Redis 即可,无需引入 JWT;仅当用户要 JWT 自包含/可读格式时引入 sa-token-jwt(Simple 模式,JWT + Redis)。无状态场景必须 JWT(StpLogicJwtForStateless,不要 Redis,不支持踢人/active-timeout)。Mixin 才同时需要 JWT + Redis(登录数据内嵌 Token)。不要默认假设用 JWT。以下场景存在多条技术路线,Agent 不可擅自替用户选择。须先简要说明选项差异,确认方向后再编码。
| # | 触发信号 | 必须确认的问题 | 选项差异 | 默认推荐(用户未指定时) |
|---|---|---|---|---|
| C1 | 用户提到 "JWT" / "无状态" / "不要 Redis" / "水平扩展" / "token 风格" / "自包含 token" | ① 是否要无状态(不依赖 Redis)?② 是否要 JWT 风格 token(自包含/可读)? | 有状态 + simple-uuid token(默认,最常用):Redis 存会话,无需 JWT,功能完整(踢人/Session/active-timeout) 有状态 + JWT(Simple):JWT 自包含 token + Redis,功能完整 无状态(Stateless):必须 JWT,不要 Redis,不支持踢人/Session/active-timeout Mixin:JWT + Redis,登录数据内嵌 Token,不支持踢人/顶人 |
有状态 + simple-uuid token;用户已显式声明"无状态/不要 Redis"视为已确认,直接 Stateless |
| C2 | 用户提到 "SSO" / "单点登录" | ① 各子系统前端是否同域?② 各子系统后端是否共享同一 Redis? | 模式一:前端同域 + 后端同 Redis → 共享 Cookie 模式二:前端不同域 + 后端同 Redis → URL 重定向 + Ticket 模式三:前端不同域 + 后端不同 Redis → HTTP 请求校验 |
按条件自动判定(同域同 Redis → 模式一) |
| C3 | 用户提到 "登录" / "认证"(未明确前后端分离) | ① 前端是浏览器渲染页面,还是 App/小程序/SPA?② 是否前后端分离? | Cookie 模式:浏览器自动管理,login() 后自动注入 Header 模式:前后端分离,后端返回 tokenValue,前端塞 header |
Cookie(浏览器);Header(前后端分离/App/小程序) |
| C4 | 用户提到 "鉴权" / "权限" / "保护接口" | ① 需要粗粒度(路径级)还是细粒度(接口/方法级)?② 是否有全局白名单? | 路由拦截:SaInterceptor + SaRouter,粗粒度,路径匹配 注解:@SaCheck,细粒度,方法级 混用*:路由做白名单 + 注解做细粒度(推荐) |
混用(路由全局 + 注解细粒度) |
| C5 | 用户提到 "微服务" / "网关" | ① 是否需要无状态(不依赖 Redis)?② 是否需要踢人/active-timeout? | Redis 方案:有状态,支持踢人/active-timeout/Session(推荐) JWT Stateless:无状态,不依赖 Redis,但不支持踢人/active-timeout |
Redis 方案(功能完整) |
| C6 | 用户提到 "多账号" / "多体系" / "多端" | ① 需要几套独立登录体系?② 各体系是否需要不同 timeout/配置? | StpKit 门面模式:每个体系独立 StpLogic,可独立配置 单账号 + device 参数:同一体系区分设备类型 |
按体系数量决定(≥2 套 → StpKit) |
执行规则: 1. 检测到触发信号 → 先向用户提出确认问题,不要直接生成代码。 2. 用户未明确回答 → 使用「默认推荐」列的策略,但在输出中标注"未确认,已使用默认方案"。 3. 用户确认方向 → 按选择生成代码,不再追问。 4. 一个需求命中多个检查点 → 逐一确认,全部完成后一次性生成代码。
10-antipattern.md 对照常见错误。references/09-pitfalls.md。StpUtil 源码为准,本 skill 未覆盖的新增功能参考 sa-token.cc 官方文档。sa-token-jwt 显式依赖 hutool-jwt,hutool 5.8.13/5.8.14 存在类型转换问题,建议避开。这个 Skill 对 Java 权限认证开发很有帮助,文档结构清晰、内容全面,核心约束和常见错误总结实用,能有效避免踩坑,版本差异说明也很细致。不过复杂场景的解释有时不够直接,搜索定位特定问题不够便捷,整体易用性还有提升空间。总体是个好帮手,但使用体验可以做得更好。