From 64a0f4a6cdce8af131fc62c8f50ca0a3f195af29 Mon Sep 17 00:00:00 2001
From: RockMan <985449475@qq.com>
Date: Sun, 7 Feb 2021 12:01:51 +0800
Subject: [PATCH] =?UTF-8?q?=E6=99=9A=E4=B8=8Areadme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md                  | 106 ++++++++++++++++++-------------------
 sa-token-doc/doc/README.md | 106 ++++++++++++++++++-------------------
 2 files changed, 104 insertions(+), 108 deletions(-)

diff --git a/README.md b/README.md
index ce275d0a..4c0ba825 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 <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">
+	<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>
@@ -25,7 +25,7 @@
 - [需求提交：我们深知一个优秀的项目需要海纳百川，点我在线提交需求](http://sa-app.dev33.cn/wall.html?name=sa-token)
 
 - [开源不易，求鼓励，点个star吧](###)
- 
+
 
 ## Sa-Token是什么？
 sa-token是一个轻量级Java权限认证框架，主要解决：登录认证、权限认证、Session会话 等一系列权限相关问题
@@ -45,16 +45,14 @@ sa-token是一个轻量级Java权限认证框架，主要解决：登录认证
 秉承着这个目的，`sa-token` 诞生了！
 
 
-## 框架优点？
+## Sa-Token 优点？
 
-在架构设计上，`sa-token`拒绝引入复杂的概念，以实际业务需求为第一目标，业务上需要什么，sa-token就做什么，
-例如：踢人下线、自动续签、同端互斥登录等常见业务，均可以在框架内**一行代码调用实现**，简单粗暴，拒绝复杂！
+sa-token架构设计精简，不引入各种复杂的概念，如丝般顺滑的API调用，大量高级特性统统只需一行代码即可实现
+- 在sa-token之前，权限认证业务概念纷飞、代码复杂，在sa-token之后，权限认证将会变成：架构清晰，人人可写
+- 在sa-token之前，你会在百度上频繁搜索: xx框架如何集成Redis？前后台分离下如何鉴权？踢人下线的原理是什么？在sa-token之后，你将轻松知道这一切的答案
+- 在sa-token之前，权限认证、分布式会话、多账号体系认证，你需要找不同的框架，在sa-token之后，你只需要这一个框架就足够了
 
-对于传统Session会话模型的N多难题，例如难以分布式、水平扩展性差，难以对接前后台分离环境，多会话管理混乱等，
-`sa-token`独创了以账号为主的`User-Session`模式，同时又兼容传统以token为主的`Token-Session`模式，两者彼此独立，互不干扰，
-让你在进行会话管理时如鱼得水，在`sa-toekn`的强力加持下，权限问题将不再成为业务逻辑的瓶颈！
-
-总的来说，与其它权限认证框架相比，你将会从以下方面感受到 `sa-token` 的优势：
+与其它权限认证框架相比，你将会从以下方面感受到 `sa-token` 的优势：
 1. **简单** ：可零配置启动框架，真正的开箱即用，低成本上手
 2. **强大** ：目前已集成几十项权限相关特性，涵盖了大部分业务场景的解决方案
 3. **易用** ：如丝般顺滑的API调用，大量高级特性统统只需一行代码即可实现
@@ -63,17 +61,38 @@ sa-token是一个轻量级Java权限认证框架，主要解决：登录认证
 有了sa-token，你所有的权限认证问题，都不再是问题！
 
 
+## Sa-Token 能做什么？
+- **登录验证** —— 轻松登录鉴权，并提供五种细分场景值
+- **权限验证** —— 适配RBAC权限模型，不同角色不同授权
+- **Session会话** —— 专业的数据缓存中心
+- **踢人下线** —— 将违规用户立刻清退下线
+- **持久层扩展** —— 可集成Redis、Memcached等专业缓存中间件，重启数据不丢失
+- **分布式会话** —— 提供jwt集成和共享数据中心两种分布式会话方案
+- **模拟他人账号** —— 实时操作任意用户状态数据
+- **临时身份切换** —— 将会话身份临时切换为其它账号
+- **无Cookie模式** —— APP、小程序等前后台分离场景
+- **同端互斥登录** —— 像QQ一样手机电脑同时在线，但是两个手机上互斥登录
+- **多账号认证体系** —— 比如一个商城项目的user表和admin表分开鉴权
+- **花式token生成** —— 内置六种token风格，还可自定义token生成策略
+- **注解式鉴权** —— 优雅的将鉴权与业务代码分离
+- **路由拦截式鉴权** —— 设定全局路由拦截，并排除指定路由
+- **自动续签** —— 提供两种token过期策略，灵活搭配使用，还可自动续签
+- **会话治理** —— 提供方便灵活的会话查询接口
+- **组件自动注入** —— 零配置与Spring等框架集成
+- **更多功能正在集成中...** —— 如有您有好想法或者建议，欢迎加群交流
+
+
 ## 代码示例
 
 sa-token的API调用非常简单，有多简单呢？以登录验证为例，你只需要：
 
 ``` java
-// 在登录时写入当前会话的账号id 
-StpUtil.setLoginId(10001);	
+// 在登录时写入当前会话的账号id
+StpUtil.setLoginId(10001);
 
-// 然后在任意需要校验登录处调用以下API  
+// 然后在任意需要校验登录处调用以下API
 // 如果当前会话未登录，这句代码会抛出 `NotLoginException`异常
-StpUtil.checkLogin();	
+StpUtil.checkLogin();
 ```
 至此，我们已经借助sa-token框架完成登录授权！
 
@@ -85,59 +104,38 @@ StpUtil.checkLogin();
 
 权限认证示例 (只有具有`user:add`权限的会话才可以进入请求)
 ``` java
-@SaCheckPermission("user:add")        
+@SaCheckPermission("user:add")
 @RequestMapping("/user/insert")
 public String insert(SysUser user) {
-	return "用户增加";
+return "用户增加";
 }
 ```
 
 将某个账号踢下线 (待到对方再次访问系统时会抛出`NotLoginException`异常)
 ``` java
 // 使账号id为10001的会话注销登录
-StpUtil.logoutByLoginId(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.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);                // 将当前会话身份临时切换为其它账号 
+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提出或者加入群一起交流，对于社区的提出的功能要求，主要分为以下几类：
@@ -191,7 +189,7 @@ sa-token秉承着开放的思想，欢迎大家贡献代码，为框架添砖加
 [开源中国](https://my.oschina.net/u/3503445/blog/4897816)、
 [博客园](https://www.cnblogs.com/shengzhang/p/14275558.html)、
 [知乎](https://zhuanlan.zhihu.com/p/344106099)
-等平台连载中...欢迎投稿 
+等平台连载中...欢迎投稿
 
 
 ## 使用sa-token的开源项目
@@ -205,12 +203,12 @@ sa-token秉承着开放的思想，欢迎大家贡献代码，为框架添砖加
 
 
 ## 交流群
-QQ交流群：[1002350610 点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM) 
+QQ交流群：[1002350610 点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM)
 
 ![扫码加群](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/qq-group.png ':size=150')
 
- **微信群** ：
+**微信群** ：
 
 ![微信群](https://images.gitee.com/uploads/images/2021/0204/121632_63ee1287_1766140.png "sa-token-wx.jpg")
 
-<br>
\ No newline at end of file
+<br>
diff --git a/sa-token-doc/doc/README.md b/sa-token-doc/doc/README.md
index ce275d0a..4c0ba825 100644
--- a/sa-token-doc/doc/README.md
+++ b/sa-token-doc/doc/README.md
@@ -1,5 +1,5 @@
 <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">
+	<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>
@@ -25,7 +25,7 @@
 - [需求提交：我们深知一个优秀的项目需要海纳百川，点我在线提交需求](http://sa-app.dev33.cn/wall.html?name=sa-token)
 
 - [开源不易，求鼓励，点个star吧](###)
- 
+
 
 ## Sa-Token是什么？
 sa-token是一个轻量级Java权限认证框架，主要解决：登录认证、权限认证、Session会话 等一系列权限相关问题
@@ -45,16 +45,14 @@ sa-token是一个轻量级Java权限认证框架，主要解决：登录认证
 秉承着这个目的，`sa-token` 诞生了！
 
 
-## 框架优点？
+## Sa-Token 优点？
 
-在架构设计上，`sa-token`拒绝引入复杂的概念，以实际业务需求为第一目标，业务上需要什么，sa-token就做什么，
-例如：踢人下线、自动续签、同端互斥登录等常见业务，均可以在框架内**一行代码调用实现**，简单粗暴，拒绝复杂！
+sa-token架构设计精简，不引入各种复杂的概念，如丝般顺滑的API调用，大量高级特性统统只需一行代码即可实现
+- 在sa-token之前，权限认证业务概念纷飞、代码复杂，在sa-token之后，权限认证将会变成：架构清晰，人人可写
+- 在sa-token之前，你会在百度上频繁搜索: xx框架如何集成Redis？前后台分离下如何鉴权？踢人下线的原理是什么？在sa-token之后，你将轻松知道这一切的答案
+- 在sa-token之前，权限认证、分布式会话、多账号体系认证，你需要找不同的框架，在sa-token之后，你只需要这一个框架就足够了
 
-对于传统Session会话模型的N多难题，例如难以分布式、水平扩展性差，难以对接前后台分离环境，多会话管理混乱等，
-`sa-token`独创了以账号为主的`User-Session`模式，同时又兼容传统以token为主的`Token-Session`模式，两者彼此独立，互不干扰，
-让你在进行会话管理时如鱼得水，在`sa-toekn`的强力加持下，权限问题将不再成为业务逻辑的瓶颈！
-
-总的来说，与其它权限认证框架相比，你将会从以下方面感受到 `sa-token` 的优势：
+与其它权限认证框架相比，你将会从以下方面感受到 `sa-token` 的优势：
 1. **简单** ：可零配置启动框架，真正的开箱即用，低成本上手
 2. **强大** ：目前已集成几十项权限相关特性，涵盖了大部分业务场景的解决方案
 3. **易用** ：如丝般顺滑的API调用，大量高级特性统统只需一行代码即可实现
@@ -63,17 +61,38 @@ sa-token是一个轻量级Java权限认证框架，主要解决：登录认证
 有了sa-token，你所有的权限认证问题，都不再是问题！
 
 
+## Sa-Token 能做什么？
+- **登录验证** —— 轻松登录鉴权，并提供五种细分场景值
+- **权限验证** —— 适配RBAC权限模型，不同角色不同授权
+- **Session会话** —— 专业的数据缓存中心
+- **踢人下线** —— 将违规用户立刻清退下线
+- **持久层扩展** —— 可集成Redis、Memcached等专业缓存中间件，重启数据不丢失
+- **分布式会话** —— 提供jwt集成和共享数据中心两种分布式会话方案
+- **模拟他人账号** —— 实时操作任意用户状态数据
+- **临时身份切换** —— 将会话身份临时切换为其它账号
+- **无Cookie模式** —— APP、小程序等前后台分离场景
+- **同端互斥登录** —— 像QQ一样手机电脑同时在线，但是两个手机上互斥登录
+- **多账号认证体系** —— 比如一个商城项目的user表和admin表分开鉴权
+- **花式token生成** —— 内置六种token风格，还可自定义token生成策略
+- **注解式鉴权** —— 优雅的将鉴权与业务代码分离
+- **路由拦截式鉴权** —— 设定全局路由拦截，并排除指定路由
+- **自动续签** —— 提供两种token过期策略，灵活搭配使用，还可自动续签
+- **会话治理** —— 提供方便灵活的会话查询接口
+- **组件自动注入** —— 零配置与Spring等框架集成
+- **更多功能正在集成中...** —— 如有您有好想法或者建议，欢迎加群交流
+
+
 ## 代码示例
 
 sa-token的API调用非常简单，有多简单呢？以登录验证为例，你只需要：
 
 ``` java
-// 在登录时写入当前会话的账号id 
-StpUtil.setLoginId(10001);	
+// 在登录时写入当前会话的账号id
+StpUtil.setLoginId(10001);
 
-// 然后在任意需要校验登录处调用以下API  
+// 然后在任意需要校验登录处调用以下API
 // 如果当前会话未登录，这句代码会抛出 `NotLoginException`异常
-StpUtil.checkLogin();	
+StpUtil.checkLogin();
 ```
 至此，我们已经借助sa-token框架完成登录授权！
 
@@ -85,59 +104,38 @@ StpUtil.checkLogin();
 
 权限认证示例 (只有具有`user:add`权限的会话才可以进入请求)
 ``` java
-@SaCheckPermission("user:add")        
+@SaCheckPermission("user:add")
 @RequestMapping("/user/insert")
 public String insert(SysUser user) {
-	return "用户增加";
+return "用户增加";
 }
 ```
 
 将某个账号踢下线 (待到对方再次访问系统时会抛出`NotLoginException`异常)
 ``` java
 // 使账号id为10001的会话注销登录
-StpUtil.logoutByLoginId(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.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);                // 将当前会话身份临时切换为其它账号 
+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提出或者加入群一起交流，对于社区的提出的功能要求，主要分为以下几类：
@@ -191,7 +189,7 @@ sa-token秉承着开放的思想，欢迎大家贡献代码，为框架添砖加
 [开源中国](https://my.oschina.net/u/3503445/blog/4897816)、
 [博客园](https://www.cnblogs.com/shengzhang/p/14275558.html)、
 [知乎](https://zhuanlan.zhihu.com/p/344106099)
-等平台连载中...欢迎投稿 
+等平台连载中...欢迎投稿
 
 
 ## 使用sa-token的开源项目
@@ -205,12 +203,12 @@ sa-token秉承着开放的思想，欢迎大家贡献代码，为框架添砖加
 
 
 ## 交流群
-QQ交流群：[1002350610 点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM) 
+QQ交流群：[1002350610 点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM)
 
 ![扫码加群](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/qq-group.png ':size=150')
 
- **微信群** ：
+**微信群** ：
 
 ![微信群](https://images.gitee.com/uploads/images/2021/0204/121632_63ee1287_1766140.png "sa-token-wx.jpg")
 
-<br>
\ No newline at end of file
+<br>