sa-token/sa-token-doc
2023-04-21 23:41:12 +08:00
..
api update sa-token-doc/api/sa-token-dao.md. 2022-12-26 15:00:15 +00:00
doc 增加常见报错问答 2023-03-26 11:30:17 +08:00
fun update sa-token-doc/fun/session-model.md. 2023-02-27 05:00:33 +00:00
micro Id-Token 模块更名为 Same-Token 2022-10-24 12:25:22 +08:00
more 同步赞助名单 2023-04-21 23:41:12 +08:00
oauth2 update sa-token-doc/oauth2/oauth2-server.md. 2023-01-29 07:55:00 +00:00
plugin !243 update sa-token-doc/plugin/alone-redis.md. 2023-03-31 07:09:36 +00:00
sso 优化文档 2023-04-10 08:13:23 +08:00
start solon集成示例 2023-04-14 14:40:37 +08:00
static 同步赞助名单 2023-04-21 23:41:12 +08:00
up 优化文档 2023-04-10 08:13:23 +08:00
use 优化文档 2023-04-10 08:13:23 +08:00
_sidebar.md 文档增加 solon 集成示例 2023-04-14 14:37:12 +08:00
doc.html 增加商业赞助链接 2023-04-17 19:00:13 +08:00
index.html 增加商业赞助链接 2023-04-17 19:00:13 +08:00
logo.png 重构文档结构 2022-10-10 00:59:08 +08:00
README.md 增加常见报错问答 2023-03-26 11:30:17 +08:00

logo

Sa-Token v1.34.0

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


前言:️️

为了保证新同学不迷路,请允许我唠叨一下:无论您从何处看到本篇文章,最新开发文档永远在:https://sa-token.cc 建议收藏在浏览器书签,如果您已经身处本网站下,则请忽略此条说明。

本文档将会尽力讲解每个功能的设计原因、应用场景,用心阅读文档,你学习到的将不止是 Sa-Token 框架本身,更是绝大多数场景下权限设计的最佳实践。

Sa-Token 介绍

Sa-Token 是一个轻量级 Java 权限认证框架,主要解决:登录认证权限认证单点登录OAuth2.0分布式Session会话微服务网关鉴权 等一系列权限相关问题。

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 设计是多么的简单、优雅!

Sa-Token 功能一览

Sa-Token 目前主要五大功能模块登录认证、权限认证、单点登录、OAuth2.0、微服务鉴权。

  • 登录认证 —— 单端登录、多端登录、同端互斥登录、七天内免登录
  • 权限认证 —— 权限认证、角色认证、会话二级认证
  • Session会话 —— 全端共享Session、单端独享Session、自定义Session
  • 踢人下线 —— 根据账号id踢人下线、根据Token值踢人下线
  • 账号封禁 —— 登录封禁、按照业务分类封禁、按照处罚阶梯封禁
  • 持久层扩展 —— 可集成Redis、Memcached等专业缓存中间件重启数据不丢失
  • 分布式会话 —— 提供jwt集成、共享数据中心两种分布式会话方案
  • 微服务网关鉴权 —— 适配Gateway、ShenYu、Zuul等常见网关的路由拦截认证
  • 单点登录 —— 内置三种单点登录模式无论是否跨域、是否共享Redis都可以搞定
  • OAuth2.0认证 —— 轻松搭建 OAuth2.0 服务支持openid模式
  • 二级认证 —— 在已登录的基础上再次认证,保证安全性
  • Basic认证 —— 一行代码接入 Http Basic 认证
  • 独立Redis —— 将权限缓存与业务缓存分离
  • 临时Token认证 —— 解决短时间的Token授权问题
  • 模拟他人账号 —— 实时操作任意用户状态数据
  • 临时身份切换 —— 将会话身份临时切换为其它账号
  • 前后端分离 —— APP、小程序等不支持Cookie的终端
  • 同端互斥登录 —— 像QQ一样手机电脑同时在线但是两个手机上互斥登录
  • 多账号认证体系 —— 比如一个商城项目的user表和admin表分开鉴权
  • Token风格定制 —— 内置六种Token风格还可自定义Token生成策略、自定义Token前缀
  • 注解式鉴权 —— 优雅的将鉴权与业务代码分离
  • 路由拦截式鉴权 —— 根据路由拦截鉴权可适配restful模式
  • 自动续签 —— 提供两种Token过期策略灵活搭配使用还可自动续签
  • 会话治理 —— 提供方便灵活的会话查询接口
  • 记住我模式 —— 适配[记住我]模式,重启浏览器免验证
  • 密码加密 —— 提供密码加密模块可快速MD5、SHA1、SHA256、AES、RSA加密
  • 全局侦听器 —— 在用户登陆、注销、被踢下线等关键性操作时进行一些AOP操作
  • 开箱即用 —— 提供SpringMVC、WebFlux等常见web框架starter集成包真正的开箱即用
  • 更多功能正在集成中... —— 如有您有好想法或者建议,欢迎加群交流

功能结构图:

sa-token-js

开源仓库 Star 趋势

github-chart

如果 Sa-Token 帮助到了您,希望您可以为其点上一个 star 码云GitHub

使用Sa-Token的开源项目

参考:Sa-Token 生态

交流群

QQ交流群707350988 点击加入

微信交流群:

微信群

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


加入群聊的好处:

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