diff --git a/sa-token-doc/_sidebar.md b/sa-token-doc/_sidebar.md index 59100a81..3776cdfd 100644 --- a/sa-token-doc/_sidebar.md +++ b/sa-token-doc/_sidebar.md @@ -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) diff --git a/sa-token-doc/plugin/dao-extend.md b/sa-token-doc/plugin/dao-extend.md index 39650a9f..553d2f2c 100644 --- a/sa-token-doc/plugin/dao-extend.md +++ b/sa-token-doc/plugin/dao-extend.md @@ -1,4 +1,4 @@ -# 持久层扩展 +# 缓存层扩展 --- 对于权限框架来讲,最容易碰到的扩展点便是数据存储方式,为了方便对接不同的缓存中间件,Sa-Token将所有数据持久化操作抽象到SaTokenDao接口, diff --git a/sa-token-doc/up/integ-redis.md b/sa-token-doc/up/integ-redis.md index a0d169f0..7e7997e8 100644 --- a/sa-token-doc/up/integ-redis.md +++ b/sa-token-doc/up/integ-redis.md @@ -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 整合方案: ``` xml - + cn.dev33 - sa-token-redis + sa-token-redis-template ${sa.top.version} -``` - -``` gradle -// Sa-Token 整合 Redis (使用 jdk 默认序列化方式) -implementation 'cn.dev33:sa-token-redis:${sa.top.version}' -``` - -优点:兼容性好,缺点:Session 序列化后基本不可读,对开发者来讲等同于乱码。 - - -### 方式2、Sa-Token 整合 Redis(使用 jackson 序列化方式) - - - -``` xml - - - cn.dev33 - sa-token-redis-jackson - ${sa.top.version} - -``` - -``` gradle -// Sa-Token 整合 Redis (使用 jackson 序列化方式) -implementation 'cn.dev33:sa-token-redis-jackson:${sa.top.version}' -``` - - -优点:Session 序列化后可读性强,可灵活手动修改,缺点:兼容性稍差。 - - -### 集成 Redis 请注意: - - -**1. 无论使用哪种序列化方式,你都必须为项目提供一个 Redis 实例化方案,例如:** - - - -``` xml - + org.apache.commons commons-pool2 @@ -73,13 +33,113 @@ implementation 'cn.dev33:sa-token-redis-jackson:${sa.top.version}' ``` ``` gradle -// 提供Redis连接池 +// Sa-Token 整合 RedisTemplate +implementation 'cn.dev33:sa-token-redis-template:${sa.top.version}' + +// 提供 Redis 连接池 implementation 'org.apache.commons:commons-pool2' ``` -**2. 引入了依赖,我还需要为 Redis 配置连接信息吗?**
+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 解析框架,可以引入相关依赖: + + + + + +``` xml + + + cn.dev33 + sa-token-fastjson + ${sa.top.version} + +``` +Gradle 参考:`implementation 'cn.dev33:sa-token-fastjson:${sa.top.version}'` + + +``` xml + + + cn.dev33 + sa-token-fastjson2 + ${sa.top.version} + +``` +Gradle 参考:`implementation 'cn.dev33:sa-token-fastjson2:${sa.top.version}'` + + +``` xml + + + cn.dev33 + sa-token-snack3 + ${sa.top.version} + +``` +Gradle 参考:`implementation 'cn.dev33:sa-token-snack3:${sa.top.version}'` + + + + +#### 自定义 String 序列化方案: + +或者你想更直接点,不使用 json 序列化方案,也是可以的。你可以直接自定义数据的 String 序列化方案: + + + + +``` java +// 设置序列化方案: jdk序列化 (base64编码) +@PostConstruct +public void rewriteComponent() { + SaManager.setSaSerializerTemplate(new SaSerializerTemplateForJdkUseBase64()); +} +``` + + +``` java +// 设置序列化方案: jdk序列化 (16进制编码) +@PostConstruct +public void rewriteComponent() { + SaManager.setSaSerializerTemplate(new SaSerializerTemplateForJdkUseHex()); +} +``` + + +``` java +// 设置序列化方案: jdk序列化 (ISO-8859-1编码) +@PostConstruct +public void rewriteComponent() { + SaManager.setSaSerializerTemplate(new SaSerializerTemplateForJdkUseISO_8859_1()); +} +``` + + + + +### 3、集成 Redis 请注意: + +**1. 引入了依赖,我还需要为 Redis 配置连接信息吗?**
需要!只有项目初始化了正确的 Redis 实例,`Sa-Token`才可以使用 Redis 进行数据持久化,参考以下`yml配置`: @@ -132,24 +192,19 @@ spring.redis.lettuce.pool.min-idle=0 ``` - > [!WARNING| label:小提示 ] > 如果你使用的是 SpringBoot3.x 版本,则需要将前缀 `spring.redis` 改为 `spring.data.redis`。 - -**3. 集成 Redis 后,是我额外手动保存数据,还是框架自动保存?**
+**2. 集成 Redis 后,是我额外手动保存数据,还是框架自动保存?**
框架自动保存。集成 `Redis` 只需要引入对应的 `pom依赖` 即可,框架所有上层 API 保持不变。 -**4. 集成包版本问题**
+**3. 集成包版本问题**
Sa-Token-Redis 集成包的版本尽量与 Sa-Token-Starter 集成包的版本一致,否则可能出现兼容性问题。 - - -### 扩展:集成 MongoDB +### 4、扩展:集成 MongoDB - [集成 MongoDB 参考一](/up/integ-spring-mongod-1) - [集成 MongoDB 参考二](/up/integ-spring-mongod-2)