Skip to content

Latest commit

 

History

History
175 lines (128 loc) · 10.1 KB

README.md

File metadata and controls

175 lines (128 loc) · 10.1 KB

logo

sa-token v1.12.1

这可能是史上功能最全的Java权限认证框架!


在线资料

Sa-Token是什么?

sa-token是一个轻量级Java权限认证框架,主要解决: 登录认证、权限认证、Session会话 等一系列权限相关问题

在架构设计上,sa-token拒绝引入复杂的概念,以实际业务需求为第一目标,业务上需要什么,sa-token就做什么,例如踢人下线、自动续签、同端互斥登录等常见业务在框架内均可以一行代码调用实现,简单粗暴,拒绝复杂!

对于传统Session会话模型的N多难题,例如难以分布式、水平扩展性差,难以兼容前后台分离环境,多会话管理混乱等, sa-token独创了以账号为主的User-Session模式,同时又兼容传统以token为主的Token-Session模式,两者彼此独立,互不干扰, 让你在进行会话管理时如鱼得水,在sa-toekn的强力加持下,权限问题将不再成为业务逻辑的瓶颈!

总的来说,与其它权限认证框架相比,sa-token具有以下优势:

  1. 上手简单:可零配置启动框架,能自动化的均已自动化,不让你费脑子
  2. 功能强大:能集成的功能全部集成,不让你用个框架还要自己给框架打各种补丁
  3. API简单易用:同样的一个功能,可能在别的框架中需要上百行代码,但是在sa-token中统统一行代码调个方法即可解决
  4. 组件易于扩展:框架中几乎所有组件都提供了对应的扩展接口,90%以上的逻辑都是可以被按需重写的

有了sa-token,你所有的权限认证问题,都不再是问题!

代码示例

sa-token的API调用非常简单,有多简单呢?以登录验证为例,你只需要:

// 在登录时写入当前会话的账号id 
StpUtil.setLoginId(10001);	

// 然后在任意需要校验登录处调用以下API  
// 如果当前会话未登录,这句代码会抛出 `NotLoginException`异常
StpUtil.checkLogin();	

至此,我们已经借助sa-token框架完成登录授权!

此时的你小脑袋可能飘满了问号,就这么简单?自定义Realm呢?全局过滤器呢?我不用写各种配置文件吗?

事实上在此我可以负责的告诉你,在sa-token中,登录授权就是如此的简单,不需要什么全局过滤器,不需要各种乱七八糟的配置!只需要这一行简单的API调用,即可完成会话的登录授权!

当你受够Shiro、Security等框架的三拜九叩之后,你就会明白,相对于这些传统老牌框架,sa-token的API设计是多么的清爽!

权限认证示例 (只有具有user:add权限的会话才可以进入请求)

@SaCheckPermission("user:add")        
@RequestMapping("/user/insert")
public String insert(SysUser user) {
	return "用户增加";
}

将某个账号踢下线 (待到对方再次访问系统时会抛出NotLoginException异常)

// 使账号id为10001的会话注销登录
StpUtil.logoutByLoginId(10001); 

除了以上的功能,sa-token还可以一行代码完成以下功能:

StpUtil.setLoginId(10001);          // 标记当前会话登录的账号id
StpUtil.getLoginId();               // 获取当前会话登录的账号id
StpUtil.isLogin();                  // 获取当前会话是否已经登录, 返回true或false
StpUtil.logout();                   // 当前会话注销登录
StpUtil.logoutByLoginId(10001);     // 让账号为10001的会话注销登录(踢人下线)
StpUtil.hasRole("super-admin");     // 查询当前账号是否含有指定角色标识, 返回true或false
StpUtil.hasPermission("user:add");  // 查询当前账号是否含有指定权限, 返回true或false
StpUtil.getSession();               // 获取当前账号id的Session 
StpUtil.getSessionByLoginId(10001); // 获取账号id为10001的Session
StpUtil.getTokenValueByLoginId(10001);  // 获取账号id为10001的token令牌值
StpUtil.setLoginId(10001, "PC");        // 指定设备标识登录
StpUtil.logoutByLoginId(10001, "PC");   // 指定设备标识进行强制注销 (不同端不受影响)
StpUtil.switchTo(10044);                // 将当前会话身份临时切换为其它账号 

sa-token的API众多,请恕此处无法为您逐一展示,更多示例请戳官方在线文档

涵盖功能

  • 登录验证 —— 轻松登录鉴权,并提供五种细分场景值
  • 权限验证 —— 适配RBAC模型,不同角色不同授权
  • Session会话 —— 专业的数据缓存中心
  • 踢人下线 —— 将违规用户立刻清退下线
  • 持久层扩展 —— 可集成redis、MongoDB等专业缓存中间件
  • 多账号认证体系 —— 比如一个商城项目的user表和admin表分开鉴权
  • 无Cookie模式 —— APP、小程序等前后台分离场景
  • 注解式鉴权 —— 优雅的将鉴权与业务代码分离
  • 路由拦截式鉴权 —— 设定全局路由拦截,并排除指定路由
  • 模拟他人账号 —— 实时操作任意用户状态数据
  • 临时身份切换 —— 将会话身份临时切换为其它账号
  • 花式token生成 —— 内置六种token风格,还可自定义token生成策略
  • 自动续签 —— 提供两种token过期策略,灵活搭配使用,还可自动续签
  • 同端互斥登录 —— 像QQ一样手机电脑同时在线,但是两个手机上互斥登录
  • 组件自动注入 —— 零配置与Spring等框架集成
  • 会话治理 —— 提供方便灵活的会话查询接口
  • 更多功能正在集成中... —— 如有您有好想法或者建议,欢迎加群交流

迭代模式

sa-token的功能提案主要来源于社区,这意味着人人都可以参与到sa-token的功能定制,决定框架的未来走向, 如果你有好的想法,可以在issues提出或者加入群一起交流,对于社区的提出的功能要求,主要分为以下几类:

  • 对框架新增特性功能且比较简单,会在第一时间进行开发
  • 对框架新增特性功能但比较复杂,会延后几个版本制定相应的计划后进行开发
  • 与框架设计理念不太相符,或超出权限认证范畴,将会视需求人数决定是否开发

参与贡献

众人拾柴火焰高,万丈高楼众人起! sa-token秉承着开放的思想,欢迎大家贡献代码,为框架添砖加瓦,对框架有卓越贡献者将会出现在贡献者名单里

  1. 在gitee或者github上fork一份代码到自己的仓库
  2. clone自己的仓库到本地电脑
  3. 在本地电脑修改、commit、push
  4. 提交pr(点击:New Pull Request)
  5. 等待合并

作者寄语:参与贡献不光只有提交代码一个选择,点一个star、提一个issues都是对开源项目的促进, 如果框架帮助到了你,欢迎你把框架推荐给你的朋友、同事使用,为sa-token的推广做一份贡献

建议贡献的地方

目前框架的主要有以下部分需要大家一起参与贡献:

  • 核心代码:该部分需要开发者了解整个框架的架构,遵循已有代码规范进行bug修复或提交新功能
  • 文档部分:需要以清晰明了的语句书写文档,力求简单易读,授人以鱼同时更授人以渔
  • 社区建设:如果框架帮助到了您,希望您可以加入qq群参与交流,对不熟悉框架的新人进行排难解惑
  • 框架推广:一个优秀的开源项目不能仅靠闭门造车,它还需要一定的推广方案让更多的人一起参与到项目中
  • 其它部分:您可以参考项目issues与需求墙进行贡献

知乎专栏

使用sa-token的开源项目

[ sa-plus] 一个基于springboot架构的快速开发框架,内置代码生成器

如果您的项目使用了sa-token,欢迎提交pr

友情链接

[ okhttps ] 一个轻量级http通信框架,API设计无比优雅,支持 WebSocket 以及 Stomp 协议

交流群

QQ交流群:1002350610 点击加入

扫码加群