lsm/sa-token
1
0
Fork 0
mirror of https://gitee.com/dromara/sa-token.git synced 2025-09-20 02:29:27 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

优化文档

Browse Source
This commit is contained in:
click33
2021-07-08 01:59:49 +08:00
parent d333b07c58
commit 03d0f235d4
11 changed files with 34 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
sa-token-doc/doc/index.html
View File

@@ -50,8 +50,9 @@
<div id="app">加载中...</div> <div id="app">加载中...</div>
</div> </div>
<script> <script>
var saTokenTopVersion = '1.21.0'; // Sa-Token最新版本
var name = '<img style="width: 60px; height: 60px; vertical-align: middle;" src="logo.png" alt="logo" /> '; var name = '<img style="width: 60px; height: 60px; vertical-align: middle;" src="logo.png" alt="logo" /> ';
name += '<b style="font-size: 28px; vertical-align: middle;">Sa-Token</b> <sub>v1.21.0</sub>' name += '<b style="font-size: 28px; vertical-align: middle;">Sa-Token</b> <sub>v' + saTokenTopVersion + '</sub>'
window.$docsify = { window.$docsify = {
name: name, // 名字 name: name, // 名字
repo: 'https://github.com/dromara/sa-token', // github地址 repo: 'https://github.com/dromara/sa-token', // github地址
@@ -83,6 +84,16 @@
}, },
plugins: [ // 自定义插件 plugins: [ // 自定义插件
function(hook, vm) { function(hook, vm) {
// 解析之前执行
hook.beforeEach(function(content) {
try{
var reg = /\$\{sa.top.version\}/g;
content = content.replace(reg, window.saTokenTopVersion);
}catch(e){
//
}
return content;
});
// 每次路由切换时，解析内容之后执行 // 每次路由切换时，解析内容之后执行
hook.afterEach(function(html) { hook.afterEach(function(html) {
var url = 'https://gitee.com/dromara/sa-token/tree/dev/sa-token-doc/doc/' + vm.route.file; var url = 'https://gitee.com/dromara/sa-token/tree/dev/sa-token-doc/doc/' + vm.route.file;

2
sa-token-doc/doc/plugin/alone-redis.md
View File

@@ -17,7 +17,7 @@ Sa-Token默认的Redis集成方式会把权限数据和业务缓存放在一起
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-alone-redis</artifactId> <artifactId>sa-token-alone-redis</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```

2
sa-token-doc/doc/plugin/aop-at.md
View File

@@ -11,7 +11,7 @@
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-aop</artifactId> <artifactId>sa-token-spring-aop</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```

2
sa-token-doc/doc/plugin/quick-login.md
View File

@@ -49,7 +49,7 @@ Sa-Token-Quick-Login的定位是这样的场景：你的项目需要一个登录
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-quick-login</artifactId> <artifactId>sa-token-quick-login</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```

2
sa-token-doc/doc/plugin/temp-token.md
View File

@@ -60,7 +60,7 @@ SaTempUtil.getTimeout(token);
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-temp-jwt</artifactId> <artifactId>sa-token-temp-jwt</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```

10
sa-token-doc/doc/sso/sso-type2.md
View File

@@ -40,14 +40,14 @@
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-boot-starter</artifactId> <artifactId>sa-token-spring-boot-starter</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
<!-- Sa-Token整合redis (使用jackson序列化方式) --> <!-- Sa-Token整合redis (使用jackson序列化方式) -->
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-dao-redis-jackson</artifactId> <artifactId>sa-token-dao-redis-jackson</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.apache.commons</groupId> <groupId>org.apache.commons</groupId>
@@ -147,14 +147,14 @@ public class SaSsoServerApplication {
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-boot-starter</artifactId> <artifactId>sa-token-spring-boot-starter</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
<!-- Sa-Token 整合redis (使用jackson序列化方式) --> <!-- Sa-Token 整合redis (使用jackson序列化方式) -->
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-dao-redis-jackson</artifactId> <artifactId>sa-token-dao-redis-jackson</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.apache.commons</groupId> <groupId>org.apache.commons</groupId>
@@ -165,7 +165,7 @@ public class SaSsoServerApplication {
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-alone-redis</artifactId> <artifactId>sa-token-alone-redis</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```

16
sa-token-doc/doc/start/download.md
View File

@@ -14,7 +14,7 @@
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-boot-starter</artifactId> <artifactId>sa-token-spring-boot-starter</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```
@@ -25,7 +25,7 @@
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-reactor-spring-boot-starter</artifactId> <artifactId>sa-token-reactor-spring-boot-starter</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```
@@ -36,7 +36,7 @@
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-servlet</artifactId> <artifactId>sa-token-servlet</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```
@@ -47,7 +47,7 @@
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-core</artifactId> <artifactId>sa-token-core</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```
<!---------------------------- tabs:end ------------------------------> <!---------------------------- tabs:end ------------------------------>
@@ -57,19 +57,19 @@
<!-- tabs:start --> <!-- tabs:start -->
<!-- tab:SpringMVC环境 （ServletAPI） --> <!-- tab:SpringMVC环境 （ServletAPI） -->
``` xml ``` xml
implementation 'cn.dev33:sa-token-spring-boot-starter:1.21.0' implementation 'cn.dev33:sa-token-spring-boot-starter:${sa.top.version}'
``` ```
<!-- tab:WebFlux环境 （Reactor） --> <!-- tab:WebFlux环境 （Reactor） -->
``` xml ``` xml
implementation 'cn.dev33:sa-token-reactor-spring-boot-starter:1.21.0' implementation 'cn.dev33:sa-token-reactor-spring-boot-starter:${sa.top.version}'
``` ```
<!-- tab:Servlet容器环境 --> <!-- tab:Servlet容器环境 -->
``` xml ``` xml
implementation 'cn.dev33:sa-token-servlet:1.21.0' implementation 'cn.dev33:sa-token-servlet:${sa.top.version}'
``` ```
<!-- tab:其它 --> <!-- tab:其它 -->
``` xml ``` xml
implementation 'cn.dev33:sa-token-core:1.21.0' implementation 'cn.dev33:sa-token-core:${sa.top.version}'
``` ```
<!-- tabs:end --> <!-- tabs:end -->

2
sa-token-doc/doc/start/example.md
View File

@@ -17,7 +17,7 @@
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-boot-starter</artifactId> <artifactId>sa-token-spring-boot-starter</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```

2
sa-token-doc/doc/start/webflux-example.md
View File

@@ -19,7 +19,7 @@ WebFlux基于Reactor响应式模型开发，有着与标准ServletAPI完全不
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-reactor-spring-boot-starter</artifactId> <artifactId>sa-token-reactor-spring-boot-starter</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```

4
sa-token-doc/doc/use/dao-extend.md
View File

@@ -14,7 +14,7 @@ Sa-token默认将会话数据保存在内存中，此模式读写速度最快，
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-dao-redis</artifactId> <artifactId>sa-token-dao-redis</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```
优点：兼容性好，缺点：Session序列化后基本不可读，对开发者来讲等同于乱码 优点：兼容性好，缺点：Session序列化后基本不可读，对开发者来讲等同于乱码
@@ -26,7 +26,7 @@ Sa-token默认将会话数据保存在内存中，此模式读写速度最快，
<dependency> <dependency>
<groupId>cn.dev33</groupId> <groupId>cn.dev33</groupId>
<artifactId>sa-token-dao-redis-jackson</artifactId> <artifactId>sa-token-dao-redis-jackson</artifactId>
<version>1.21.0</version> <version>${sa.top.version}</version>
</dependency> </dependency>
``` ```
优点：Session序列化后可读性强，可灵活手动修改，缺点：兼容性稍差 优点：Session序列化后可读性强，可灵活手动修改，缺点：兼容性稍差