⚡ v1.6.0 版本更新

2025-09-22 12:09:21 +08:00 · 2020-12-18 00:39:14 +08:00
parent d776501c3d
commit 4db058cdf0
14 changed files with 215 additions and 22 deletions
--- a/sa-token-doc/doc/README.md
+++ b/sa-token-doc/doc/README.md
@@ -1,11 +1,11 @@
 <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" style="margin-bottom: 10px;">
 </p>
-<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">sa-token v1.5.1</h1>
+<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">sa-token v1.6.0</h1>
 <h4 align="center">一个JavaWeb轻量级权限认证框架，功能全面，上手简单</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.5.1-2B9939"></a>
+	<a href="https://github.com/click33/sa-token"><img src="https://img.shields.io/badge/sa--token-v1.6.0-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>
@@ -57,6 +57,7 @@ StpUtil.checkLogin();
 - ⚡ **多账号认证体系** —— 比如一个商城项目的user表和admin表分开鉴权
 - ⚡ **无cookie模式** —— APP、小程序等前后台分离场景 
 - ⚡ **注解式鉴权** —— 优雅的将鉴权与业务代码分离
+- ⚡ **花式token生成** —— 内置六种token风格，还可自定义token生成策略
 - ⚡ **组件自动注入** —— 零配置与Spring等框架集成
 - ⚡ **更多功能正在集成中...** —— 如有您有好想法或者建议，欢迎加群交流

--- a/sa-token-doc/doc/_sidebar.md
+++ b/sa-token-doc/doc/_sidebar.md
@@ -15,6 +15,7 @@
 	- [模拟他人](/use/mock-person) 
 	- [多账号验证](/use/many-account) 
 	- [注解式鉴权](/use/at-check) 
+	- [花式token](/use/token-style) 
 	- [框架配置](/use/config) 

 - **其它**
--- a/sa-token-doc/doc/index.css
+++ b/sa-token-doc/doc/index.css
@@ -15,7 +15,7 @@

 /* 背景变黑 */
 .main-box [data-lang]{padding: 0px !important; border-radius: 10px; overflow: hidden;}
-.main-box [class^="lang-"]{/* color: red !important; */ border: 0px red solid; padding: 1.2em; background-color: #222; color: #FFF;}
+.main-box [class^="lang-"]{/* color: red !important; */ border: 0px red solid; padding: 1.2em; background-color: #282828; color: #FFF;}
 .main-box [class^="lang-api"]{color: #FFF;}


--- a/sa-token-doc/doc/index.html
+++ b/sa-token-doc/doc/index.html
@@ -7,7 +7,7 @@
 		<meta name="description" content="Description">
 		<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
 		<meta name="keywords" content="sa-token|sa-token框架|sa-token文档|sa-token在线文档|权限认证框架">
-		<meta name="description" content="sa-token是一个JavaWeb权限认证框架，强大、简单、好用，登录验证、权限验证、自定义session会话、踢人下线、持久层扩展、无cookie模式、模拟他人账号、多账号体系、注解式鉴权、Spring集成...，零配置开箱即用，覆盖所有应用场景，你所需要的功能，这里都有">
+		<meta name="description" content="sa-token是一个JavaWeb权限认证框架，强大、简单、好用，登录验证、权限验证、自定义session会话、踢人下线、持久层扩展、无cookie模式、模拟他人账号、多账号体系、注解式鉴权、花式token、Spring集成...，零配置开箱即用，覆盖所有应用场景，你所需要的功能，这里都有">
 		<link rel="stylesheet" href="https://unpkg.com/docsify@4.11.3/lib/themes/vue.css">
 		<link rel="stylesheet" href="./index.css">
 		<link rel="shortcut icon" type="image/x-icon" href="logo.png">
@@ -34,7 +34,7 @@
 		</div>
 		<script>
 			var name = '<img style="width: 50px; height: 50px; vertical-align: middle;" src="logo.png" alt="logo" /> ';
-			name += '<b style="font-size: 24px; vertical-align: middle;">sa-token</b> <sub>v1.5.1</sub>'
+			name += '<b style="font-size: 24px; vertical-align: middle;">sa-token</b> <sub>v1.6.0</sub>'
 			window.$docsify = {
 				name: name, // 名字 
 				repo: 'https://github.com/click33/sa-token', // github地址 
--- a/sa-token-doc/doc/more/update-log.md
+++ b/sa-token-doc/doc/more/update-log.md
@@ -1,5 +1,12 @@
 # 更新日志 

+
+### 2020-12-17 @v1.6.0
+- 新增：花式token生成方案 **[重要]** 
+- 优化：优化`readme.md` 
+- 修复：修复`SaCookieOper`与`SaTokenAction`无法自动注入的问题 
+
+
 ### 2020-12-16 @v1.5.1
 - 新增：细化未登录异常类型，提供五种场景值：未提供token、token无效、token已过期 、token已被顶下线、token已被踢下线 **[重要]**
 - 修复：修复`StpUtil.getSessionByLoginId(String loginId)`方法转换key出错的bug，感谢群友 @(＃°Д°)、@一米阳光 发现的bug 
@@ -13,6 +20,7 @@
 - 优化：优化`readme.md` 
 - 升级：开源协议修改为`MIT`

+
 ### 2020-9-7 @v1.4.0
 - 优化：修改一些函数、变量名称，使其更符合阿里java代码规范
 - 优化：`tokenValue`的读取优先级改为：`request` > `body` > `header` > `cookie`
@@ -21,6 +29,7 @@
 - 新增：新增`getSessionByLoginId(Object loginId, boolean isCreate)`方法
 - 修复：修复文档部分错误，修正群号码

+
 ### 2020-5-2 @v1.3.0
 - 新增：新增 `StpUtil.checkLogin()` 方法，更符合语义化的鉴权方法
 - 新增：注册拦截器时可设置 `StpLogic` ，方便不同模块不同鉴权方式
@@ -29,13 +38,16 @@
 - 修复：修复文档部分不正确之处
 - 新增：新增文档的友情链接

+
 ### 2020-3-7 @v1.2.0
 - 新增：新增注解式验证，可在路由方法中使用注解进行权限验证
 - 参考：[注解式验证](use/at-check)

+
 ### 2020-2-12 @v1.1.0
 - 修复：修复`StpUtil.getLoginId(T defaultValue)`取值转换错误的bug

+
 ### 2020-2-4 @v1.0.0
 - 第一个版本出炉 
 - GitHub：[https://github.com/click33/sa-token](https://github.com/click33/sa-token)
--- a/sa-token-doc/doc/start/download.md
+++ b/sa-token-doc/doc/start/download.md
@@ -9,7 +9,7 @@
 <dependency>
 	<groupId>cn.dev33</groupId>
 	<artifactId>sa-token</artifactId>
-	<version>1.5.1</version>
+	<version>1.6.0</version>
 </dependency>
 ```

@@ -29,7 +29,7 @@


 ## jar包下载
-[点击下载：sa-token-1.5.1.jar](https://oss.dev33.cn/sa-token/sa-token-1.5.1.jar)
+[点击下载：sa-token-1.6.0.jar](https://oss.dev33.cn/sa-token/sa-token-1.6.0.jar)



--- a/sa-token-doc/doc/start/example.md
+++ b/sa-token-doc/doc/start/example.md
@@ -18,7 +18,7 @@
 <dependency>
 	<groupId>cn.dev33</groupId>
 	<artifactId>sa-token</artifactId>
-	<version>1.5.1</version>
+	<version>1.6.0</version>
 </dependency>
 ```

--- a/sa-token-doc/doc/use/config.md
+++ b/sa-token-doc/doc/use/config.md
@@ -12,6 +12,7 @@
 | isReadBody	| Boolean	| true		| 是否尝试从请求体里读取token														|
 | isReadHead	| Boolean	| true		| 是否尝试从header里读取token														|
 | isReadCookie	| Boolean	| true		| 是否尝试从cookie里读取token														|
+| tokenStyle	| String	| uuid		| token风格, 参考：[花式token](/use/token-style)										|
 | isV			| Boolean	| true		| 是否在初始化配置时打印版本字符画													|


@@ -37,6 +38,7 @@
 			config.setIsReadBody(true);		// 是否尝试从请求体里读取token
 			config.setIsReadHead(true);		// 是否尝试从header里读取token
 			config.setIsReadCookie(true);		// 是否尝试从cookie里读取token
+			config.setTokenStyle("uuid"); 		// token风格 
 			config.setIsV(true);					// 是否在初始化配置时打印版本字符画
 			return config;
 		}
@@ -62,6 +64,8 @@ spring:
        is-read-head: true
        # 是否尝试从cookie里读取token
        is-read-cookie: true
+        # token风格
+        token-style: uuid
        # 是否在初始化配置时打印版本字符画
        is-v: true
 ```
--- a/sa-token-doc/doc/use/token-style.md
+++ b/sa-token-doc/doc/use/token-style.md
@@ -0,0 +1,115 @@
+# 花式token
+
+本篇介绍token生成的各种风格，以及自定义token生成策略
+
+--- 
+
+
+## 内置风格
+
+- sa-token默认的token生成策略是uuid风格, 其模样类似于：`623368f0-ae5e-4475-a53f-93e4225f16ae`<br>
+- 如果你对这种风格不太感冒，还可以将token生成设置为其他风格，
+- 怎么设置呢？只需要在yml配置文件里设置 `spring.sa-token.token-style=风格类型` 即可，其有多种取值： <br>
+
+
+1. token-style=`uuid`，uuid风格 **(默认风格)**
+``` html
+	623368f0-ae5e-4475-a53f-93e4225f16ae
+```
+
+2. token-style=`simple-uuid`，同上，uuid风格, 只不过去掉了下划线：
+``` html
+	6fd4221395024b5f87edd34bc3258ee8
+```
+
+3. token-style=`random-32`，随机32位字符串：
+``` html
+	qEjyPsEA1Bkc9dr8YP6okFr5umCZNR6W
+```
+
+4. token-style=`random-64`，随机64位字符串：
+``` html
+	v4ueNLEpPwMtmOPMBtOOeIQsvP8z9gkMgIVibTUVjkrNrlfra5CGwQkViDjO8jcc
+```
+
+5. token-style=`random-128`，随机128位字符串：
+``` html
+	nojYPmcEtrFEaN0Otpssa8I8jpk8FO53UcMZkCP9qyoHaDbKS6dxoRPky9c6QlftQ0pdzxRGXsKZmUSrPeZBOD6kJFfmfgiRyUmYWcj4WU4SSP2ilakWN1HYnIuX0Olj
+```
+
+6. token-style=`tik`，tik风格：
+``` html
+	gr_SwoIN0MC1ewxHX_vfCW3BothWDZMMtx__
+```
+
+
+## 自定义token生成策略
+- 如果你觉着以上风格都不是你喜欢的类型，那么你还可以**自定义token生成策略**，来定制化token生成风格 <br>
+- 怎么做呢？只需要重写`SaTokenAction`接口的`createToken`方法即可
+
+
+#### 参考步骤如下：
+1. 新建文件`MySaTokenAction.java`，继承`SaTokenActionDefaultImpl`默认实现类, 并添加上注解`@Component`，保证此类被`springboot`扫描到
+``` java 
+	package com.pj.satoken;
+
+	import org.springframework.stereotype.Component;
+	import cn.dev33.satoken.action.SaTokenActionDefaultImpl;
+
+	/**
+	 * 继承sa-token行为Bean默认实现, 重写部分逻辑 
+	 */
+	@Component
+	public class MySaTokenAction extends SaTokenActionDefaultImpl {
+		// 重写token生成策略 
+		@Override
+		public String createToken(Object loginId, String loginKey) {
+			return SaTokenInsideUtil.getRandomString(60);	// 随机60位字符串
+		}
+	}
+```
+
+2. 再次调用 `StpUtil.setLoginId(10001)`方法进行登录，观察其生成的token样式
+``` html
+	gfuPSwZsnUhwgz08GTCH4wOgasWtc3odP4HLwXJ7NDGOximTvT4OlW19zeLH
+```
+
+
+
+## 以雪花算法生成token
+在此再举一个例子，以`自定义token生成策略`的方式集成`雪花算法`来生成token
+
+1. 首先我们需要找一个合适的类库，帮助我们生成雪花算法唯一id，在此推荐 [Hutool](https://hutool.cn/docs/#/) ，在`pom.xml`里添加依赖：
+``` xml
+	<dependency>
+	    <groupId>cn.hutool</groupId>
+	    <artifactId>hutool-all</artifactId>
+	    <version>5.5.4</version>
+	</dependency>
+```
+
+2. 同上，我们需要新建文件`MySaTokenAction.java`，继承`SaTokenActionDefaultImpl`默认实现类, 并添加上注解`@Component`，保证此类被`springboot`扫描到
+``` java 
+	package com.pj.satoken;
+
+	import org.springframework.stereotype.Component;
+	import cn.dev33.satoken.action.SaTokenActionDefaultImpl;
+	import cn.hutool.core.util.IdUtil;
+
+	/**
+	 * 继承sa-token行为Bean默认实现, 重写部分逻辑 
+	 */
+	@Component
+	public class MySaTokenAction extends SaTokenActionDefaultImpl {
+		// 重写token生成策略 
+		@Override
+		public String createToken(Object loginId, String loginKey) {
+			return IdUtil.getSnowflake(1, 1).nextIdStr();	// 以雪花算法生成token 
+		}
+	}
+```
+
+3. 再次调用 `StpUtil.setLoginId(10001)`方法进行登录，观察其生成的token样式: 
+``` html
+	1339604338175250432
+```
--- a/sa-token-doc/index.html
+++ b/sa-token-doc/index.html
@@ -7,7 +7,7 @@
 		<meta name="description" content="Description">
 		<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
 		<meta name="keywords" content="sa-token|sa-token框架|sa-token文档|sa-token在线文档|权限认证框架">
-		<meta name="description" content="sa-token是一个JavaWeb权限认证框架，强大、简单、好用，登录验证、权限验证、自定义session会话、踢人下线、持久层扩展、无cookie模式、模拟他人账号、多账号体系、注解式鉴权、Spring集成...，零配置开箱即用，覆盖所有应用场景，你所需要的功能，这里都有">
+		<meta name="description" content="sa-token是一个JavaWeb权限认证框架，强大、简单、好用，登录验证、权限验证、自定义session会话、踢人下线、持久层扩展、无cookie模式、模拟他人账号、多账号体系、注解式鉴权、花式token、Spring集成...，零配置开箱即用，覆盖所有应用场景，你所需要的功能，这里都有">
 		<link rel="stylesheet" href="https://unpkg.com/docsify@4.11.3/lib/themes/vue.css">
 		<link rel="shortcut icon" type="image/x-icon" href="doc/logo.png">
 		<link rel="stylesheet" href="index.css">
@@ -43,10 +43,10 @@
 			<!-- 内容部分 -->
 			<div class="main-box">
 				<div class="content-box">
-					<h1>sa-token<small>v1.5.1</small></h1>
+					<h1>sa-token<small>v1.6.0</small></h1>
 					<div class="sub-title">一个JavaWeb轻量级权限认证框架，功能全面，上手简单</div>
 					<!-- <p>0配置开箱即用，低学习成本</p> -->
-					<p>登录验证、权限验证、自定义session会话、踢人下线、持久层扩展、无cookie模式、模拟他人账号、多账号体系、注解式鉴权、Spring集成...</p>
+					<p>登录验证、权限验证、自定义session会话、踢人下线、持久层扩展、无cookie模式、模拟他人账号、多账号体系、注解式鉴权、花式token、Spring集成...</p>
 					<p>零配置开箱即用，覆盖所有应用场景，你所需要的功能，这里都有</p>
 					<div class="btn-box">
 						<a href="https://github.com/click33/sa-token" target="_blank">GitHub</a>