/Sa-Token

一个轻量级 Java 权限认证框架，让鉴权变得简单、优雅！—— 登录认证、权限认证、分布式Session会话、微服务网关鉴权、单点登录、OAuth2.0

Primary LanguageJavaApache License 2.0Apache-2.0

logo

Sa-Token v1.38.0

一个轻量级 Java 权限认证框架，让鉴权变得简单、优雅！

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

Sa-Token 介绍

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

简单示例展示：（点击展开 / 折叠）

Sa-Token 旨在以简单、优雅的方式完成系统的权限认证部分，以登录认证为例，你只需要：

// 会话登录，参数填登录人的账号id 
StpUtil.login(10001);

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

如果一个接口需要登录后才能访问，我们只需调用以下代码：

// 校验当前客户端是否已经登录，如果未登录则抛出 `NotLoginException` 异常
StpUtil.checkLogin();

在 Sa-Token 中，大多数功能都可以一行代码解决：

踢人下线：

// 将账号id为 10077 的会话踢下线 
StpUtil.kickout(10077);

权限认证：

// 注解鉴权：只有具备 `user:add` 权限的会话才可以进入方法
@SaCheckPermission("user:add")
public String insert(SysUser user) {
    // ... 
    return "用户增加";
}

路由拦截鉴权：

// 根据路由划分模块，不同模块不同鉴权 
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 的 API 设计是多么的简单、优雅！

核心模块一览：（点击展开 / 折叠）
  • 登录认证 —— 单端登录、多端登录、同端互斥登录、七天内免登录。
  • 权限认证 —— 权限认证、角色认证、会话二级认证。
  • 踢人下线 —— 根据账号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。

sa-token-js

SSO 单点登录

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

系统架构 采用模式 简介 文档链接
前端同域 + 后端同 Redis 模式一 共享Cookie同步会话 文档、示例
前端不同域 + 后端同 Redis 模式二 URL重定向传播会话 文档、示例
前端不同域 + 后端 不同Redis 模式三 Http请求获取会话 文档、示例
  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 大致登录流程。

OAuth2 授权认证

Sa-Token-OAuth2 模块分为四种授权模式，解决不同场景下的授权需求

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

详细参考文档：https://sa-token.cc/doc.html#/oauth2/readme

开源集成案例

  • [ Snowy ]：国内首个国密前后分离快速开发平台，采用 Vue3 + AntDesignVue3 + Vite + SpringBoot + Mp + HuTool + SaToken。
  • [ RuoYi-Vue-Plus ]：重写RuoYi-Vue所有功能 集成 Sa-Token+Mybatis-Plus+Jackson+Xxl-Job+knife4j+Hutool+OSS 定期同步
  • [ RuoYi-Cloud-Plus ]：重写RuoYi-Cloud所有功能 整合 SpringCloudAlibaba Dubbo3.0 Sa-Token Mybatis-Plus MQ OSS ES Xxl-Job Docker 全方位升级 定期同步
  • [ EasyAdmin ]：一个基于SpringBoot2 + Sa-Token + Mybatis-Plus + Snakerflow + Layui 的后台管理系统，灵活多变可前后端分离，也可单体，内置代码生成器、权限管理、工作流引擎等
  • [ YC-Framework ]：致力于打造一款优秀的分布式微服务解决方案。
  • [ Pig-Satoken ]：重写 Pig 授权方式为 Sa-Token，其他代码不变。

还有更多优秀开源案例无法逐一展示，请参考：Awesome-Sa-Token

友情链接

  • [ OkHttps ]：轻量级 http 通信框架，API无比优雅，支持 WebSocket、Stomp 协议
  • [ Bean Searcher ]：专注高级查询的只读 ORM，使一行代码实现复杂列表检索！
  • [ Jpom ]：简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件。
  • [ TLog ]：一个轻量级的分布式日志标记追踪神器。
  • [ hippo4j ]：强大的动态线程池框架，附带监控报警功能。
  • [ hertzbeat ]：易用友好的开源实时监控告警系统，无需Agent，高性能集群，强大自定义监控能力。
  • [ Solon ]：一个更现代感的应用开发框架：更快、更小、更自由。

交流群

QQ交流群：936523917 点击加入

微信交流群：

(扫码添加微信，备注：sa-token，邀您加入群聊)


加入群聊的好处：

  • 第一时间收到框架更新通知。
  • 第一时间收到框架 bug 通知。
  • 第一时间收到新增开源案例通知。
  • 和众多大佬一起互相 (huá shuǐ) 交流 (mō yú)。