mirror of
https://gitee.com/dromara/sa-token.git
synced 2025-06-28 13:34:18 +08:00
完善readme介绍
This commit is contained in:
shengzhang
parent
0989bf8bb7
commit
f3742aeca7
65
README.md
65
README.md
@ -1,4 +1,4 @@
|
||||
<p align="center">
|
||||
**<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>
|
||||
@ -28,19 +28,37 @@
|
||||
|
||||
|
||||
## Sa-Token是什么？
|
||||
sa-token是一个轻量级Java权限认证框架，主要解决: 登录认证、权限认证、Session会话 等一系列权限相关问题
|
||||
sa-token是一个轻量级Java权限认证框架，主要解决：登录认证、权限认证、Session会话 等一系列权限相关问题
|
||||
|
||||
在架构设计上，`sa-token`拒绝引入复杂的概念，以实际业务需求为第一目标，业务上需要什么，sa-token就做什么，例如踢人下线、自动续签、同端互斥登录等常见业务在框架内**均可以一行代码调用实现**，简单粗暴，拒绝复杂！
|
||||
近年来，有关权限认证的解决方案层出不穷，例如单点登录、OAuth2.0、分布式Session等等难题，无一不有着各种优秀框架大行其道
|
||||
|
||||
对于传统Session会话模型的N多难题，例如难以分布式、水平扩展性差，难以兼容前后台分离环境，多会话管理混乱等，
|
||||
然而当我们把视线放低，那些最基础的有如：登录认证、权限认证、Session会话等基础问题却仍然被两大上古神兽 `Apache Shiro`、`Spring Security` 所把持
|
||||
|
||||
在此并非专门diss两大框架，诚然这两个框架背景强大，历史悠久，其生态也比较齐全
|
||||
|
||||
但是它们毕竟已经是十几年前的产物，那是一个写页面还在用 `jsp` 的时代，两大框架的很多功能都是为jsp这一套量身定做。
|
||||
|
||||
在前后台分离已成标配的今天，两大框架的很多设计理念已经比较滞后，已经不能和我们的项目进行无缝适配，很多功能点都需要进行二次封装，甚至找一大堆扩展插件才能集成，已经逐渐不太适合现代化项目的应用
|
||||
|
||||
所以，为什么不能有一个自底向上，从最基础的登录、权限做起，以业务需求为核心，做到开箱即用的轻量级权限认证框架？
|
||||
|
||||
秉承着这个目的，`sa-token` 诞生了！
|
||||
|
||||
|
||||
## 架构设计
|
||||
|
||||
在架构设计上，`sa-token`拒绝引入复杂的概念，以实际业务需求为第一目标，业务上需要什么，sa-token就做什么，
|
||||
例如：踢人下线、自动续签、同端互斥登录等常见业务，均可以在框架内**一行代码调用实现**，简单粗暴，拒绝复杂！
|
||||
|
||||
对于传统Session会话模型的N多难题，例如难以分布式、水平扩展性差，难以对接前后台分离环境，多会话管理混乱等，
|
||||
`sa-token`独创了以账号为主的`User-Session`模式，同时又兼容传统以token为主的`Token-Session`模式，两者彼此独立，互不干扰，
|
||||
让你在进行会话管理时如鱼得水，在`sa-token`的强力加持下，权限问题将不再成为业务逻辑的瓶颈！
|
||||
让你在进行会话管理时如鱼得水，在`sa-toekn`的强力加持下，权限问题将不再成为业务逻辑的瓶颈！
|
||||
|
||||
总的来说，与其它权限认证框架相比，`sa-token`具有以下优势：
|
||||
1. **更简单的上手步骤** ：可零配置启动框架，能自动化的均已自动化，不让你费脑子
|
||||
2. **更全面的功能示例** ：目前已集成几十项权限相关特性，涵盖了大部分业务场景的解决方案
|
||||
3. **更易用的API调用** ：同样的一个功能，可能在别的框架中需要上百行代码，但是在sa-token中统统一行代码调个方法即可解决
|
||||
4. **更高的扩展性** ：框架中几乎所有组件都提供了对应的扩展接口，90%以上的逻辑都是可以被按需重写的
|
||||
总的来说，与其它权限认证框架相比，你将会从以下方面感受到 `sa-token` 的优势：
|
||||
1. **简单** ：可零配置启动框架，真正的开箱即用，低成本上手
|
||||
2. **强大** ：目前已集成几十项权限相关特性，涵盖了大部分业务场景的解决方案
|
||||
3. **易用** ：同样的一个功能，在别的框架中可能需要上百行代码，在sa-token中统统一行代码解决
|
||||
4. **高扩展** ：框架中几乎所有组件都提供了扩展接口，90%以上的逻辑都可以按需重写
|
||||
|
||||
有了sa-token，你所有的权限认证问题，都不再是问题！
|
||||
|
||||
@ -101,21 +119,22 @@ sa-token的API众多，请恕此处无法为您逐一展示，更多示例请戳
|
||||
|
||||
## 涵盖功能
|
||||
- **登录验证** —— 轻松登录鉴权，并提供五种细分场景值
|
||||
- **权限验证** —— 适配RBAC模型，不同角色不同授权
|
||||
- **权限验证** —— 适配RBAC权限模型，不同角色不同授权
|
||||
- **Session会话** —— 专业的数据缓存中心
|
||||
- **踢人下线** —— 将违规用户立刻清退下线
|
||||
- **持久层扩展** —— 可集成redis、MongoDB等专业缓存中间件
|
||||
- **多账号认证体系** —— 比如一个商城项目的user表和admin表分开鉴权
|
||||
- **无Cookie模式** —— APP、小程序等前后台分离场景
|
||||
- **注解式鉴权** —— 优雅的将鉴权与业务代码分离
|
||||
- **路由拦截式鉴权** —— 设定全局路由拦截，并排除指定路由
|
||||
- **持久层扩展** —— 可集成Redis、Memcached等专业缓存中间件，重启数据不丢失
|
||||
- **分布式会话** —— 提供jwt集成和共享数据中心两种分布式会话方案
|
||||
- **模拟他人账号** —— 实时操作任意用户状态数据
|
||||
- **临时身份切换** —— 将会话身份临时切换为其它账号
|
||||
- **花式token生成** —— 内置六种token风格，还可自定义token生成策略
|
||||
- **自动续签** —— 提供两种token过期策略，灵活搭配使用，还可自动续签
|
||||
- **无Cookie模式** —— APP、小程序等前后台分离场景
|
||||
- **同端互斥登录** —— 像QQ一样手机电脑同时在线，但是两个手机上互斥登录
|
||||
- **组件自动注入** —— 零配置与Spring等框架集成
|
||||
- **多账号认证体系** —— 比如一个商城项目的user表和admin表分开鉴权
|
||||
- **花式token生成** —— 内置六种token风格，还可自定义token生成策略
|
||||
- **注解式鉴权** —— 优雅的将鉴权与业务代码分离
|
||||
- **路由拦截式鉴权** —— 设定全局路由拦截，并排除指定路由
|
||||
- **自动续签** —— 提供两种token过期策略，灵活搭配使用，还可自动续签
|
||||
- **会话治理** —— 提供方便灵活的会话查询接口
|
||||
- **组件自动注入** —— 零配置与Spring等框架集成
|
||||
- **更多功能正在集成中...** —— 如有您有好想法或者建议，欢迎加群交流
|
||||
|
||||
|
||||
@ -166,7 +185,12 @@ sa-token秉承着开放的思想，欢迎大家贡献代码，为框架添砖加
|
||||
- [初识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) 等平台连载中...欢迎投稿
|
||||
- 文章已在 [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的开源项目
|
||||
@ -190,3 +214,4 @@ QQ交流群：[1002350610 点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM)
|
||||
|
||||
|
||||
<br>
|
||||
**
|
||||
@ -1,4 +1,4 @@
|
||||
<p align="center">
|
||||
**<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>
|
||||
@ -28,19 +28,37 @@
|
||||
|
||||
|
||||
## Sa-Token是什么？
|
||||
sa-token是一个轻量级Java权限认证框架，主要解决: 登录认证、权限认证、Session会话 等一系列权限相关问题
|
||||
sa-token是一个轻量级Java权限认证框架，主要解决：登录认证、权限认证、Session会话 等一系列权限相关问题
|
||||
|
||||
在架构设计上，`sa-token`拒绝引入复杂的概念，以实际业务需求为第一目标，业务上需要什么，sa-token就做什么，例如踢人下线、自动续签、同端互斥登录等常见业务在框架内**均可以一行代码调用实现**，简单粗暴，拒绝复杂！
|
||||
近年来，有关权限认证的解决方案层出不穷，例如单点登录、OAuth2.0、分布式Session等等难题，无一不有着各种优秀框架大行其道
|
||||
|
||||
对于传统Session会话模型的N多难题，例如难以分布式、水平扩展性差，难以兼容前后台分离环境，多会话管理混乱等，
|
||||
然而当我们把视线放低，那些最基础的有如：登录认证、权限认证、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调用** ：同样的一个功能，可能在别的框架中需要上百行代码，但是在sa-token中统统一行代码调个方法即可解决
|
||||
4. **更高的扩展性** ：框架中几乎所有组件都提供了对应的扩展接口，90%以上的逻辑都是可以被按需重写的
|
||||
总的来说，与其它权限认证框架相比，你将会从以下方面感受到 `sa-token` 的优势：
|
||||
1. **简单** ：可零配置启动框架，真正的开箱即用，低成本上手
|
||||
2. **强大** ：目前已集成几十项权限相关特性，涵盖了大部分业务场景的解决方案
|
||||
3. **易用** ：同样的一个功能，在别的框架中可能需要上百行代码，在sa-token中统统一行代码解决
|
||||
4. **高扩展** ：框架中几乎所有组件都提供了扩展接口，90%以上的逻辑都可以按需重写
|
||||
|
||||
有了sa-token，你所有的权限认证问题，都不再是问题！
|
||||
|
||||
@ -101,21 +119,22 @@ sa-token的API众多，请恕此处无法为您逐一展示，更多示例请戳
|
||||
|
||||
## 涵盖功能
|
||||
- **登录验证** —— 轻松登录鉴权，并提供五种细分场景值
|
||||
- **权限验证** —— 适配RBAC模型，不同角色不同授权
|
||||
- **权限验证** —— 适配RBAC权限模型，不同角色不同授权
|
||||
- **Session会话** —— 专业的数据缓存中心
|
||||
- **踢人下线** —— 将违规用户立刻清退下线
|
||||
- **持久层扩展** —— 可集成redis、MongoDB等专业缓存中间件
|
||||
- **多账号认证体系** —— 比如一个商城项目的user表和admin表分开鉴权
|
||||
- **无Cookie模式** —— APP、小程序等前后台分离场景
|
||||
- **注解式鉴权** —— 优雅的将鉴权与业务代码分离
|
||||
- **路由拦截式鉴权** —— 设定全局路由拦截，并排除指定路由
|
||||
- **持久层扩展** —— 可集成Redis、Memcached等专业缓存中间件，重启数据不丢失
|
||||
- **分布式会话** —— 提供jwt集成和共享数据中心两种分布式会话方案
|
||||
- **模拟他人账号** —— 实时操作任意用户状态数据
|
||||
- **临时身份切换** —— 将会话身份临时切换为其它账号
|
||||
- **花式token生成** —— 内置六种token风格，还可自定义token生成策略
|
||||
- **自动续签** —— 提供两种token过期策略，灵活搭配使用，还可自动续签
|
||||
- **无Cookie模式** —— APP、小程序等前后台分离场景
|
||||
- **同端互斥登录** —— 像QQ一样手机电脑同时在线，但是两个手机上互斥登录
|
||||
- **组件自动注入** —— 零配置与Spring等框架集成
|
||||
- **多账号认证体系** —— 比如一个商城项目的user表和admin表分开鉴权
|
||||
- **花式token生成** —— 内置六种token风格，还可自定义token生成策略
|
||||
- **注解式鉴权** —— 优雅的将鉴权与业务代码分离
|
||||
- **路由拦截式鉴权** —— 设定全局路由拦截，并排除指定路由
|
||||
- **自动续签** —— 提供两种token过期策略，灵活搭配使用，还可自动续签
|
||||
- **会话治理** —— 提供方便灵活的会话查询接口
|
||||
- **组件自动注入** —— 零配置与Spring等框架集成
|
||||
- **更多功能正在集成中...** —— 如有您有好想法或者建议，欢迎加群交流
|
||||
|
||||
|
||||
@ -166,7 +185,12 @@ sa-token秉承着开放的思想，欢迎大家贡献代码，为框架添砖加
|
||||
- [初识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) 等平台连载中...欢迎投稿
|
||||
- 文章已在 [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的开源项目
|
||||
@ -190,3 +214,4 @@ QQ交流群：[1002350610 点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM)
|
||||
|
||||
|
||||
<br>
|
||||
**
|
||||
Loading…
Reference in New Issue
Block a user