mirror of
https://gitee.com/dromara/sa-token.git
synced 2024-11-30 10:58:05 +08:00
216 lines
12 KiB
Markdown
216 lines
12 KiB
Markdown
<p align="center">
|
||
<img alt="logo" src="https://gitee.com/sz6/sa-token/raw/master/sa-token-doc/doc/logo.png" width="150" height="150">
|
||
</p>
|
||
<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">sa-token v1.12.1</h1>
|
||
<h4 align="center">这可能是史上功能最全的Java权限认证框架！</h4>
|
||
<h4 align="center">
|
||
<a href="https://gitee.com/sz6/sa-token/stargazers"><img src="https://gitee.com/sz6/sa-token/badge/star.svg"></a>
|
||
<a href="https://github.com/click33/sa-token"><img src="https://img.shields.io/badge/sa--token-v1.12.1-2B9939"></a>
|
||
<a href="https://github.com/click33/sa-token/stargazers"><img src="https://img.shields.io/github/stars/click33/sa-token"></a>
|
||
<a href="https://github.com/click33/sa-token/watchers"><img src="https://img.shields.io/github/watchers/click33/sa-token"></a>
|
||
<a href="https://github.com/click33/sa-token/network/members"><img src="https://img.shields.io/github/forks/click33/sa-token"></a>
|
||
<a href="https://github.com/click33/sa-token/issues"><img src="https://img.shields.io/github/issues/click33/sa-token.svg"></a>
|
||
<a href="https://github.com/click33/sa-token/blob/master/LICENSE"><img src="https://img.shields.io/github/license/click33/sa-token.svg"></a>
|
||
</h4>
|
||
|
||
---
|
||
|
||
|
||
## 在线资料
|
||
|
||
- [官网首页：http://sa-token.dev33.cn/](http://sa-token.dev33.cn/)
|
||
|
||
- [在线文档：http://sa-token.dev33.cn/doc/index.html](http://sa-token.dev33.cn/doc/index.html)
|
||
|
||
- [需求提交：我们深知一个优秀的项目需要海纳百川，点我在线提交需求](http://sa-app.dev33.cn/wall.html?name=sa-token)
|
||
|
||
- [开源不易，求鼓励，点个star吧](###)
|
||
|
||
|
||
## Sa-Token是什么？
|
||
sa-token是一个轻量级Java权限认证框架，主要解决：登录认证、权限认证、Session会话 等一系列权限相关问题
|
||
|
||
近年来，有关权限认证的解决方案层出不穷，例如单点登录、OAuth2.0、分布式Session等等难题，无一不有着各种优秀框架大行其道
|
||
|
||
然而当我们把视线放低，那些最基础的有如：登录认证、权限认证、Session会话等基础问题却一直被两大上古神兽 `Apache Shiro`、`Spring Security` 所把持
|
||
|
||
在此并非专门diss此两大框架，诚然两大框架背景强大，历史悠久，其生态也比较齐全
|
||
|
||
但是它们毕竟已经是十几年前的产物，那是一个还在用 `jsp` 写页面的时代，两大框架的很多功能都是为jsp那一套量身定做。
|
||
|
||
在前后台分离已成标配的今天，两大框架的很多设计理念已经比较滞后，已经不能和我们的项目进行无缝适配，很多功能点都需要进行二次封装，甚至找一大堆扩展插件才能集成，已经逐渐不太适合现代化项目的应用
|
||
|
||
所以，为什么不能有一个自底向上，从最基础的登录、权限做起，以业务需求为核心，做到开箱即用的轻量级权限认证框架？
|
||
|
||
秉承着这个目的，`sa-token` 诞生了！
|
||
|
||
|
||
## 框架优点？
|
||
|
||
在架构设计上，`sa-token`拒绝引入复杂的概念，以实际业务需求为第一目标，业务上需要什么，sa-token就做什么，
|
||
例如：踢人下线、自动续签、同端互斥登录等常见业务，均可以在框架内**一行代码调用实现**，简单粗暴，拒绝复杂！
|
||
|
||
对于传统Session会话模型的N多难题，例如难以分布式、水平扩展性差，难以对接前后台分离环境，多会话管理混乱等，
|
||
`sa-token`独创了以账号为主的`User-Session`模式，同时又兼容传统以token为主的`Token-Session`模式，两者彼此独立，互不干扰，
|
||
让你在进行会话管理时如鱼得水，在`sa-toekn`的强力加持下，权限问题将不再成为业务逻辑的瓶颈！
|
||
|
||
总的来说，与其它权限认证框架相比，你将会从以下方面感受到 `sa-token` 的优势：
|
||
1. **简单** ：可零配置启动框架，真正的开箱即用，低成本上手
|
||
2. **强大** ：目前已集成几十项权限相关特性，涵盖了大部分业务场景的解决方案
|
||
3. **易用** ：如丝般顺滑的API调用，大量高级特性统统只需一行代码即可实现
|
||
4. **高扩展** ：几乎所有组件都提供了扩展接口，90%以上的逻辑都可以按需重写
|
||
|
||
有了sa-token，你所有的权限认证问题，都不再是问题！
|
||
|
||
|
||
## 代码示例
|
||
|
||
sa-token的API调用非常简单，有多简单呢？以登录验证为例，你只需要：
|
||
|
||
``` java
|
||
// 在登录时写入当前会话的账号id
|
||
StpUtil.setLoginId(10001);
|
||
|
||
// 然后在任意需要校验登录处调用以下API
|
||
// 如果当前会话未登录，这句代码会抛出 `NotLoginException`异常
|
||
StpUtil.checkLogin();
|
||
```
|
||
至此，我们已经借助sa-token框架完成登录授权！
|
||
|
||
此时的你小脑袋可能飘满了问号，就这么简单？自定义Realm呢？全局过滤器呢？我不用写各种配置文件吗？
|
||
|
||
事实上在此我可以负责的告诉你，在sa-token中，登录授权就是如此的简单，不需要什么全局过滤器，不需要各种乱七八糟的配置！只需要这一行简单的API调用，即可完成会话的登录授权！
|
||
|
||
当你受够Shiro、Security等框架的三拜九叩之后，你就会明白，相对于这些传统老牌框架，sa-token的API设计是多么的清爽！
|
||
|
||
权限认证示例 (只有具有`user:add`权限的会话才可以进入请求)
|
||
``` java
|
||
@SaCheckPermission("user:add")
|
||
@RequestMapping("/user/insert")
|
||
public String insert(SysUser user) {
|
||
return "用户增加";
|
||
}
|
||
```
|
||
|
||
将某个账号踢下线 (待到对方再次访问系统时会抛出`NotLoginException`异常)
|
||
``` java
|
||
// 使账号id为10001的会话注销登录
|
||
StpUtil.logoutByLoginId(10001);
|
||
```
|
||
|
||
除了以上的示例，sa-token还可以一行代码完成以下功能：
|
||
``` java
|
||
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、Memcached等专业缓存中间件，重启数据不丢失
|
||
- **分布式会话** —— 提供jwt集成和共享数据中心两种分布式会话方案
|
||
- **模拟他人账号** —— 实时操作任意用户状态数据
|
||
- **临时身份切换** —— 将会话身份临时切换为其它账号
|
||
- **无Cookie模式** —— APP、小程序等前后台分离场景
|
||
- **同端互斥登录** —— 像QQ一样手机电脑同时在线，但是两个手机上互斥登录
|
||
- **多账号认证体系** —— 比如一个商城项目的user表和admin表分开鉴权
|
||
- **花式token生成** —— 内置六种token风格，还可自定义token生成策略
|
||
- **注解式鉴权** —— 优雅的将鉴权与业务代码分离
|
||
- **路由拦截式鉴权** —— 设定全局路由拦截，并排除指定路由
|
||
- **自动续签** —— 提供两种token过期策略，灵活搭配使用，还可自动续签
|
||
- **会话治理** —— 提供方便灵活的会话查询接口
|
||
- **组件自动注入** —— 零配置与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与需求墙进行贡献
|
||
|
||
|
||
## 贡献者名单
|
||
[省长](https://gitee.com/sz6)、
|
||
[RockMan](https://gitee.com/njx33)、
|
||
[click33](https://github.com/click33)、
|
||
[AppleOfGray](https://gitee.com/appleOfGray)、
|
||
[Auster](https://github.com/auster9021)、
|
||
[ZhuBJ0510](https://gitee.com/zhubj0510)、
|
||
[legg](https://gitee.com/legg321)、
|
||
[xiaoshitou](https://gitee.com/smallstoneZ)、
|
||
[zhangjiaxiaozhuo](https://gitee.com/zhangjiaxiaozhuo)、
|
||
[离你多远](https://gitee.com/liniduoyuan)
|
||
|
||
|
||
## 知乎专栏
|
||
- [初识sa-token，一行代码搞定登录授权！](https://zhuanlan.zhihu.com/p/344106099)
|
||
- [一个登录功能也能玩出这么多花样？sa-token带你轻松搞定多地登录、单地登录、同端互斥登录](https://zhuanlan.zhihu.com/p/344511415)
|
||
- [浅谈踢人下线的设计思路！（附代码实现方案）](https://zhuanlan.zhihu.com/p/345844002)
|
||
- 文章已在 [csdn](https://blog.csdn.net/shengzhang_/article/details/112593247)、
|
||
[掘金](https://juejin.cn/post/6917250126650015751)、
|
||
[开源中国](https://my.oschina.net/u/3503445/blog/4897816)、
|
||
[博客园](https://www.cnblogs.com/shengzhang/p/14275558.html)、
|
||
[知乎](https://zhuanlan.zhihu.com/p/344106099)
|
||
等平台连载中...欢迎投稿
|
||
|
||
|
||
## 使用sa-token的开源项目
|
||
[**[ sa-plus]** 一个基于springboot架构的快速开发框架，内置代码生成器](https://gitee.com/sz6/sa-plus)
|
||
|
||
如果您的项目使用了sa-token，欢迎提交pr
|
||
|
||
|
||
## 友情链接
|
||
[**[ okhttps ]** 一个轻量级http通信框架，API设计无比优雅，支持 WebSocket 以及 Stomp 协议](https://gitee.com/ejlchina-zhxu/okhttps)
|
||
|
||
|
||
## 交流群
|
||
QQ交流群：[1002350610 点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM)
|
||
|
||
|
||
|
||
**微信群** ：
|
||
|
||
|
||
|
||
<br> |