Redis 缓存使用指南

前置检查清单

使用缓存功能前，请确认：

• [ ] 项目已引入 cache-spring-boot-starter 依赖
• [ ] 已在 application.yml 中启用 Redis 配置
• [ ] 已确定缓存数据的 Key 前缀策略

依赖配置

<dependency>
    <groupId>cn.com.digitalhainan</groupId>
    <artifactId>cache-spring-boot-starter</artifactId>
    <version>${digitalhainan.version}</version>
</dependency>

核心类架构

RedisTemplateStringKeyWrapper (基类 - Key前缀处理)
    ↑
RedisTemplateFastOperationsWrapper (快速操作)
    ↑
    ├── RedisTemplateEmptyWrapper     (空前缀)
    ├── RedisTemplatePrivateWrapper   (应用级前缀)
    └── RedisTemplatePublicWrapper    (公共数据前缀)

场景选择速查

场景	推荐类	参考文档
通用业务缓存（默认推荐）	RedisTemplatePrivateWrapper	wrapper-classes.md
公共数据/字典类缓存	RedisTemplatePublicWrapper	wrapper-classes.md
不需要前缀的场景	RedisTemplateEmptyWrapper	wrapper-classes.md
Value/Hash/List/Set 操作	-	common-operations.md
分布式锁	-	distributed-lock.md

Step-by-step 使用流程

Step 1：选择包装类

根据数据范围选择对应的 RedisTemplate 包装类：

• 应用私有数据 → RedisTemplatePrivateWrapper
• 多应用共享数据 → RedisTemplatePublicWrapper
• 无前缀需求 → RedisTemplateEmptyWrapper

Step 2：注入并操作

@Autowired
private RedisTemplatePrivateWrapper redisWrapper;

// 快速存取
redisWrapper.valuePut("user:123", userDTO);
UserDTO user = redisWrapper.valueGet("user:123");

Step 3：YAML 配置

digitalhainan:
  component:
    redis:
      enable: true
      multi-node:
        master:
          host: localhost
          port: 6379
          password:
          database: 0
          lettuce:
            pool:
              max-active: 8
              max-idle: 8
              min-idle: 0

参考文档索引

文档	内容	链接
Wrapper 类指南	Private/Public/Empty/Fast/StringKey 各包装类的使用场景与示例	wrapper-classes.md
常用操作示例	Value、Hash、List、Set 的操作示例	common-operations.md
分布式锁指南	@DLock 注解与编程式锁的使用	distributed-lock.md