mirror of
https://gitee.com/dromara/sa-token.git
synced 2025-04-04 23:39:27 +08:00
docs: 完善 Redis 集成文档
This commit is contained in:
click33
parent
258e379570
commit
75df0597a0
@ -86,7 +86,7 @@
|
||||
- [临时Token认证](/plugin/temp-token)
|
||||
- [Quick-Login快速登录插件](/plugin/quick-login)
|
||||
- [Alone独立Redis插件](/plugin/alone-redis)
|
||||
- [持久层扩展](/plugin/dao-extend)
|
||||
- [缓存层扩展](/plugin/dao-extend)
|
||||
- [和 Thymeleaf 集成](/plugin/thymeleaf-extend)
|
||||
- [和 Freemarker 集成](/plugin/freemarker-extend)
|
||||
- [注解鉴权 SpEL 表达式](/plugin/spel-at)
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# 持久层扩展
|
||||
# 缓存层扩展
|
||||
---
|
||||
|
||||
对于权限框架来讲，最容易碰到的扩展点便是数据存储方式，为了方便对接不同的缓存中间件，Sa-Token将所有数据持久化操作抽象到SaTokenDao接口，
|
||||
|
||||
@ -9,63 +9,23 @@ Sa-Token 默认将数据保存在内存中，此模式读写速度最快，且
|
||||
为此，Sa-Token 提供了扩展接口，你可以轻松将会话数据存储在一些专业的缓存中间件上（比如 Redis），
|
||||
做到重启数据不丢失，而且保证分布式环境下多节点的会话一致性。
|
||||
|
||||
以下是框架提供的 Redis 集成包：
|
||||
|
||||
---
|
||||
|
||||
### 方式1、Sa-Token 整合 Redis （使用 jdk 默认序列化方式）
|
||||
### 1、Sa-Token 整合 RedisTemplate
|
||||
|
||||
RedisTemplate 是 SpringBoot 官方推荐的 Redis 客户端，Sa-Token 提供基于 RedisTemplate 的 Redis 整合方案：
|
||||
|
||||
<!---------------------------- tabs:start ------------------------------>
|
||||
<!-------- tab:Maven 方式 -------->
|
||||
``` xml
|
||||
<!-- Sa-Token 整合 Redis （使用 jdk 默认序列化方式） -->
|
||||
<!-- Sa-Token 整合 RedisTemplate -->
|
||||
<dependency>
|
||||
<groupId>cn.dev33</groupId>
|
||||
<artifactId>sa-token-redis</artifactId>
|
||||
<artifactId>sa-token-redis-template</artifactId>
|
||||
<version>${sa.top.version}</version>
|
||||
</dependency>
|
||||
```
|
||||
<!-------- tab:Gradle 方式 -------->
|
||||
``` gradle
|
||||
// Sa-Token 整合 Redis （使用 jdk 默认序列化方式）
|
||||
implementation 'cn.dev33:sa-token-redis:${sa.top.version}'
|
||||
```
|
||||
<!---------------------------- tabs:end ------------------------------>
|
||||
|
||||
优点：兼容性好，缺点：Session 序列化后基本不可读，对开发者来讲等同于乱码。
|
||||
|
||||
|
||||
### 方式2、Sa-Token 整合 Redis（使用 jackson 序列化方式）
|
||||
|
||||
<!---------------------------- tabs:start ------------------------------>
|
||||
<!-------- tab:Maven 方式 -------->
|
||||
``` xml
|
||||
<!-- Sa-Token 整合 Redis （使用 jackson 序列化方式） -->
|
||||
<dependency>
|
||||
<groupId>cn.dev33</groupId>
|
||||
<artifactId>sa-token-redis-jackson</artifactId>
|
||||
<version>${sa.top.version}</version>
|
||||
</dependency>
|
||||
```
|
||||
<!-------- tab:Gradle 方式 -------->
|
||||
``` gradle
|
||||
// Sa-Token 整合 Redis （使用 jackson 序列化方式）
|
||||
implementation 'cn.dev33:sa-token-redis-jackson:${sa.top.version}'
|
||||
```
|
||||
<!---------------------------- tabs:end ------------------------------>
|
||||
|
||||
优点：Session 序列化后可读性强，可灵活手动修改，缺点：兼容性稍差。
|
||||
|
||||
|
||||
### 集成 Redis 请注意：
|
||||
|
||||
|
||||
**1. 无论使用哪种序列化方式，你都必须为项目提供一个 Redis 实例化方案，例如：**
|
||||
|
||||
<!---------------------------- tabs:start ------------------------------>
|
||||
<!-------- tab:Maven 方式 -------->
|
||||
``` xml
|
||||
<!-- 提供Redis连接池 -->
|
||||
<!-- 提供 Redis 连接池 -->
|
||||
<dependency>
|
||||
<groupId>org.apache.commons</groupId>
|
||||
<artifactId>commons-pool2</artifactId>
|
||||
@ -73,13 +33,113 @@ implementation 'cn.dev33:sa-token-redis-jackson:${sa.top.version}'
|
||||
```
|
||||
<!-------- tab:Gradle 方式 -------->
|
||||
``` gradle
|
||||
// 提供Redis连接池
|
||||
// Sa-Token 整合 RedisTemplate
|
||||
implementation 'cn.dev33:sa-token-redis-template:${sa.top.version}'
|
||||
|
||||
// 提供 Redis 连接池
|
||||
implementation 'org.apache.commons:commons-pool2'
|
||||
```
|
||||
<!---------------------------- tabs:end ------------------------------>
|
||||
|
||||
|
||||
**2. 引入了依赖，我还需要为 Redis 配置连接信息吗？** <br>
|
||||
Redis 的集成有多种方式，缓存的方案也不止 Redis 一种，Sa-Token 为缓存方案提供多种扩展实现。
|
||||
|
||||
如果你对 Sa-Token 还不太熟悉，或者只想“省心省事”，我们推荐你直接使用上述的 RedisTemplate 集成方案，而不必进行过多研究。到此为止，你可以跳转到下一章节了。
|
||||
|
||||
如果你想对缓存方案再进行一下深入探究，那么你可以参考：[缓存层扩展](/plugin/dao-extend)
|
||||
|
||||
|
||||
### 2、自定义序列化方案
|
||||
|
||||
如果你按照上述 RedisTemplate 方案进行集成测试，会发现框架在 Redis 中是以 json 格式存储数据的。可以自定义数据序列化格式吗？当然是可以的。
|
||||
|
||||
框架的默认序列化层调用为 `String 序列化` -> `JSON 序列化`。要自定义数据序列化方式你可以从这两方面入手：
|
||||
|
||||
|
||||
#### 自定义 JSON 序列化方案：
|
||||
|
||||
先说较为底层的 `JSON 序列化`，如果你引入的是 sa-token-spring-boot-starter 集成包 (含SpringBoot3) ，那么框架将会自动引入 Jackson 框架作为 JSON 序列化方案。
|
||||
|
||||
如果你想更换为其它 JSON 解析框架，可以引入相关依赖：
|
||||
|
||||
|
||||
<!------------------------------ tabs:start ------------------------------>
|
||||
|
||||
<!------------- tab:Fastjson ------------->
|
||||
``` xml
|
||||
<!-- Sa-Token 整合 Fastjson -->
|
||||
<dependency>
|
||||
<groupId>cn.dev33</groupId>
|
||||
<artifactId>sa-token-fastjson</artifactId>
|
||||
<version>${sa.top.version}</version>
|
||||
</dependency>
|
||||
```
|
||||
Gradle 参考：`implementation 'cn.dev33:sa-token-fastjson:${sa.top.version}'`
|
||||
|
||||
<!------------- tab:Fastjson2 ------------->
|
||||
``` xml
|
||||
<!-- Sa-Token 整合 Fastjson2 -->
|
||||
<dependency>
|
||||
<groupId>cn.dev33</groupId>
|
||||
<artifactId>sa-token-fastjson2</artifactId>
|
||||
<version>${sa.top.version}</version>
|
||||
</dependency>
|
||||
```
|
||||
Gradle 参考：`implementation 'cn.dev33:sa-token-fastjson2:${sa.top.version}'`
|
||||
|
||||
<!------------- tab:Snack3 ------------->
|
||||
``` xml
|
||||
<!-- Sa-Token 整合 Snack3 -->
|
||||
<dependency>
|
||||
<groupId>cn.dev33</groupId>
|
||||
<artifactId>sa-token-snack3</artifactId>
|
||||
<version>${sa.top.version}</version>
|
||||
</dependency>
|
||||
```
|
||||
Gradle 参考：`implementation 'cn.dev33:sa-token-snack3:${sa.top.version}'`
|
||||
|
||||
<!---------------------------- tabs:end ------------------------------>
|
||||
|
||||
|
||||
#### 自定义 String 序列化方案：
|
||||
|
||||
或者你想更直接点，不使用 json 序列化方案，也是可以的。你可以直接自定义数据的 String 序列化方案：
|
||||
|
||||
<!------------------------------ tabs:start ------------------------------>
|
||||
|
||||
<!------------- tab:jdk序列化 (base64编码) ------------->
|
||||
``` java
|
||||
// 设置序列化方案: jdk序列化 (base64编码)
|
||||
@PostConstruct
|
||||
public void rewriteComponent() {
|
||||
SaManager.setSaSerializerTemplate(new SaSerializerTemplateForJdkUseBase64());
|
||||
}
|
||||
```
|
||||
|
||||
<!------------- tab:jdk序列化 (16进制编码) ------------->
|
||||
``` java
|
||||
// 设置序列化方案: jdk序列化 (16进制编码)
|
||||
@PostConstruct
|
||||
public void rewriteComponent() {
|
||||
SaManager.setSaSerializerTemplate(new SaSerializerTemplateForJdkUseHex());
|
||||
}
|
||||
```
|
||||
|
||||
<!------------- tab:jdk序列化 (ISO-8859-1编码) ------------->
|
||||
``` java
|
||||
// 设置序列化方案: jdk序列化 (ISO-8859-1编码)
|
||||
@PostConstruct
|
||||
public void rewriteComponent() {
|
||||
SaManager.setSaSerializerTemplate(new SaSerializerTemplateForJdkUseISO_8859_1());
|
||||
}
|
||||
```
|
||||
<!---------------------------- tabs:end ------------------------------>
|
||||
|
||||
|
||||
|
||||
### 3、集成 Redis 请注意：
|
||||
|
||||
**1. 引入了依赖，我还需要为 Redis 配置连接信息吗？** <br>
|
||||
需要！只有项目初始化了正确的 Redis 实例，`Sa-Token`才可以使用 Redis 进行数据持久化，参考以下`yml配置`：
|
||||
|
||||
<!---------------------------- tabs:start ------------------------------>
|
||||
@ -132,24 +192,19 @@ spring.redis.lettuce.pool.min-idle=0
|
||||
```
|
||||
<!---------------------------- tabs:end ------------------------------>
|
||||
|
||||
|
||||
> [!WARNING| label:小提示 ]
|
||||
> 如果你使用的是 SpringBoot3.x 版本，则需要将前缀 `spring.redis` 改为 `spring.data.redis`。
|
||||
|
||||
|
||||
|
||||
**3. 集成 Redis 后，是我额外手动保存数据，还是框架自动保存？** <br>
|
||||
**2. 集成 Redis 后，是我额外手动保存数据，还是框架自动保存？** <br>
|
||||
框架自动保存。集成 `Redis` 只需要引入对应的 `pom依赖` 即可，框架所有上层 API 保持不变。
|
||||
|
||||
**4. 集成包版本问题** <br>
|
||||
**3. 集成包版本问题** <br>
|
||||
Sa-Token-Redis 集成包的版本尽量与 Sa-Token-Starter 集成包的版本一致，否则可能出现兼容性问题。
|
||||
|
||||
|
||||
<!-- <br><br>
|
||||
更多框架的集成方案正在更新中... -->
|
||||
|
||||
|
||||
### 扩展：集成 MongoDB
|
||||
### 4、扩展：集成 MongoDB
|
||||
|
||||
- [集成 MongoDB 参考一](/up/integ-spring-mongod-1)
|
||||
- [集成 MongoDB 参考二](/up/integ-spring-mongod-2)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user