Redis 缓存

dtpc-spring-boot-starter-redis 技术组件，使用 Redis 实现缓存的功能，它有 2 种使用方式：

- 编程式缓存：基于 Spring Data Redis 框架的 RedisTemplate 操作模板
- 声明式缓存：基于 Spring Cache 框架的 @Cacheable 等等注解

## 1. 编程式缓存
> <dependency>
 <groupId>org.redisson</groupId>
 <artifactId>redisson-spring-boot-starter</artifactId>
</dependency>

![](/media/202408/2024-08-27_135612_158197.png)

由于 Redisson 提供了分布式锁、队列、限流等特性，所以使用它作为 Spring Data Redis 的客户端。

### 1.1 Spring Data Redis 配置
① 在 application-local.yaml配置文件中，通过 spring.redis 配置项，设置 Redis 的配置。如下图所示：

![](/media/202408/2024-08-27_135351_566228.png)
② 在 YudaoRedisAutoConfiguration配置类，设置使用 JSON 序列化 value 值。如下图所示：

![](/media/202408/2024-08-27_135409_616431.png)

### 1.2 实战案例
以访问令牌 Access Token 的缓存来举例子，讲解项目中是如何使用 Spring Data Redis 框架的。

![](/media/202408/2024-08-27_135521_574198.png)

1.2.1 引入依赖
在dtpc-module-system-biz 模块中，引入 dtpc-spring-boot-starter-redis 技术组件。如下所示：
> <dependency>
 <groupId>cn.iocoder.cloud</groupId>
 <artifactId>yudao-spring-boot-starter-redis</artifactId>
</dependency>

![](/media/202408/2024-08-27_135602_618234.png)

### 1.2.2 OAuth2AccessTokenDO
新建 OAuth2AccessTokenDO (opens new window)类，访问令牌 Access Token 类。代码如下：

![](/media/202408/2024-08-27_135632_029202.png)

> 友情提示：
① 如果值是【简单】的 String 或者 Integer 等类型，无需创建数据实体。
② 如果值是【复杂对象】时，建议在 dal/dataobject 包下，创建对应的数据实体。

### 1.2.3 RedisKeyConstants
为什么要定义 Redis Key 常量？
每个 dtpc-module-xxx 模块，都有一个 RedisKeyConstants 类，定义该模块的 Redis Key 的信息。目的是，避免 Redis Key 散落在 Service 业务代码中，像对待数据库的表一样，对待每个 Redis Key。通过这样的方式，如果我们想要了解一个模块的 Redis 的使用情况，只需要查看 RedisKeyConstants 类即可。

在dtpc-module-system 模块的 RedisKeyConstants 类中，新建 OAuth2AccessTokenDO 对应的 Redis Key 定义 OAUTH2_ACCESS_TOKEN。如下图所示：

![](/media/202408/2024-08-27_135801_772796.png)

### 1.2.4 OAuth2AccessTokenRedisDAO
新建 OAuth2AccessTokenRedisDAO (opens new window)类，是 OAuth2AccessTokenDO 的 RedisDAO 实现。代码如下：

![](/media/202408/2024-08-27_135820_244356.png)

### 1.2.5 OAuth2TokenServiceImpl
在 OAuth2TokenServiceImpl (opens new window)中，只要注入 OAuth2AccessTokenRedisDAO Bean，非常简洁干净的进行 OAuth2AccessTokenDO 的缓存操作，无需关心具体的实现。代码如下：

![](/media/202408/2024-08-27_135840_116515.png)

## 2. 声明式缓存
> <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-cache</artifactId>
</dependency>

![](/media/202408/2024-08-27_135922_115637.png)

相比来说 Spring Data Redis 编程式缓存，Spring Cache 声明式缓存的使用更加便利，一个 @Cacheable 注解即可实现缓存的功能。示例如下：
> @Cacheable(value = "users", key = "#id")
UserDO getUserById(Integer id);

2.1 Spring Cache 配置
① 在 application.yaml (opens new window)配置文件中，通过 spring.redis 配置项，设置 Redis 的配置。如下图所示：

![](/media/202408/2024-08-27_135951_362735.png)

② 在 dtpcCacheAutoConfiguration 配置类，设置使用 JSON 序列化 value 值。如下图所示：

![](/media/202408/2024-08-27_140013_097342.png)

### 2.2 常见注解
#2.2.1 @Cacheable 注解
@Cacheable (opens new window)注解：添加在方法上，缓存方法的执行结果。执行过程如下：
1）首先，判断方法执行结果的缓存。如果有，则直接返回该缓存结果。
2）然后，执行方法，获得方法结果。
3）之后，根据是否满足缓存的条件。如果满足，则缓存方法结果到缓存。
4）最后，返回方法结果。

#2.2.2 @CachePut 注解
@CachePut (opens new window)注解，添加在方法上，缓存方法的执行结果。不同于 @Cacheable 注解，它的执行过程如下：
1）首先，执行方法，获得方法结果。也就是说，无论是否有缓存，都会执行方法。
2）然后，根据是否满足缓存的条件。如果满足，则缓存方法结果到缓存。
3）最后，返回方法结果。

#2.2.3 @CacheEvict 注解
@CacheEvict (opens new window)注解，添加在方法上，删除缓存。

#2.3 实战案例
在 RoleServiceImpl (opens new window)中，使用 Spring Cache 实现了 Role 角色缓存，采用【被动读】的方案。原因是：

![](/media/202408/2024-08-27_140045_438212.png)
- 【被动读】相对能够保证 Redis 与 MySQL 的一致性
- 绝大数数据不需要放到 Redis 缓存中，采用【主动写】会将非必要的数据进行缓存
① 执行 #getRoleFromCache(...) 方法，从 MySQL 读取数据后，向 Redis 写入缓存。如下图所示：

![](/media/202408/2024-08-27_140114_643294.png)

② 执行 #updateRole(...) 或 #deleteRole(...) 方法，在更新或者删除 MySQL 数据后，从 Redis 删除缓存。如下图所示：

![](/media/202408/2024-08-27_140127_942122.png)

> 补充说明：
如果你在多个项目里，使用了 Redis 想通 db 的话，可以通过 spring.cache.redis.key-prefix 解决，可见 https://gitee.com/zhijiantianya/ruoyi-vue-pro/pulls/998/(opens new window)

### 2.4 过期时间
Spring Cache 默认使用 spring.cache.redis.time-to-live 配置项，设置缓存的过期时间，项目默认为 1 小时。
如果你想自定义过期时间，可以在 @Cacheable 注解中的 cacheNames 属性中，添加 #{过期时间} 后缀，单位是秒。如下图所示：

![](/media/202408/2024-08-27_140219_464150.png)

## 3. Redis 监控
dtpc-module-infra 的 redis 模块，提供了 Redis 监控的功能。
点击 [基础设施 -> 监控中心 -> Redis 监控] 菜单，可以查看到 Redis 的基础信息、命令统计、内存信息。如下图所示：

![](/media/202408/2024-08-27_140247_390524.png)