Spring Boot集成Redis时如何自定义缓存Key的生成策略?

云墨小哥_5443

云墨小哥_5443

2026-07-21

742人浏览

原创

simplekeygenerator会导致缓存互相覆盖,因其仅基于参数值生成key(如getuserbyid(123)和getorderbyid(123)均生成"123"),忽略类名与方法名,造成redis中key冲突;无参返回不可读的simplekey.empty,多参生成难调试的simplekey[id1,id2],缺乏业务上下文区分。

spring boot集成redis时如何自定义缓存key的生成策略?

为什么SimpleKeyGenerator会导致缓存互相覆盖

默认的 SimpleKeyGenerator 对单参数方法直接调用 toString(),比如 getUserById(123) 和 getOrderById(123) 都生成 key "123"。Redis 里 key 冲突,结果就是查用户返回了订单数据——这不是 bug,是设计如此,但生产环境不能接受。

它对无参方法返回 SimpleKey.EMPTY(一个空对象),对多参方法拼成 SimpleKey[id1,id2],但这个字符串不可读、难调试、无法区分业务上下文。

实现 KeyGenerator 接口时 generate() 的关键处理点

重写 generate(Object target, Method method, Object... params) 时,别只拼 params.toString(),得兼顾可读性、唯一性和健壮性:

  • target.getClass().getSimpleName() 比 target.getClass().getName() 更简洁,避免包名过长
  • method.getName() 必须带上,否则同 service 下不同方法会撞 key
  • params 是 Object[],要遍历处理:null → "null",数组/集合需递归或转 JSON 字符串,否则 [1,2] 和 Arrays.asList(1,2) 可能生成相同字符串
  • 推荐用下划线 _ 分隔,不用冒号(:)或点(.),避免和 Redis 命名空间习惯冲突

示例片段:

Redis Skill - 高性能缓存管理
Redis Skill - 高性能缓存管理

Redis 缓存和数据结构管理技能。通过自然语言操作 Redis,支持 String、Hash、List、Set、ZSet、Stream 等数据结构操作。当用户提到 Redis、缓存、消息队列、会话存储时使用此技能。

下载
public Object generate(Object target, Method method, Object... params) {
    String className = target.getClass().getSimpleName();
    String methodName = method.getName();
    String paramStr = Arrays.stream(params)
        .map(p -> p == null ? "null" : p instanceof Collection
            ? new ObjectMapper().writeValueAsString(p)
            : p.toString())
        .collect(Collectors.joining("_"));
    return String.format("%s:%s:%s", className, methodName, paramStr);
}

注册后不生效?检查这三点

自定义 KeyGenerator 写对了,但缓存还是走默认逻辑,大概率卡在这几个地方:

  • Bean 名必须是 cacheKeyGenerator(Spring Boot 2.4+ 强制要求),不是随便起名;或者加 @Primary 显式标记
  • @EnableCaching 所在配置类,必须能被 @ComponentScan 扫到——如果 KeyGenerator 定义在 com.example.util,而启动类只扫 com.example.app,那就找不到
  • 如果你手动构建了 RedisCacheConfiguration,比如调用了 .keyPrefix("xxx") 或 .computePrefixWith(...),那 KeyGenerator 就完全不参与 key 生成,此时 key 由 prefix + 方法参数决定,跟你的 generate() 方法无关

@Cacheable 中用 SpEL 自定义 key 和 KeyGenerator 的关系

两者互斥:@Cacheable(key = "#id + '_' + #type") 会跳过 KeyGenerator,直接走 SpEL 解析;没写 key 属性时才用 KeyGenerator。

所以混用时容易误判:

  • 全局想统一风格?删掉所有 key=,只靠 KeyGenerator
  • 个别方法要特殊处理?保留 key SpEL,其他走默认生成器
  • 注意 SpEL 里 #p0 表示第一个参数,#root.methodName 可取方法名,但不如 KeyGenerator 灵活(比如没法取 class 简称)

真正麻烦的不是写代码,而是搞清「谁在什么时候生成 key」——KeyGenerator、SpEL、keyPrefix、序列化方式,四者叠加时,优先级和生效条件得一个个验证。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

2251

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

437

25

常用的数据库软件
常用的数据库软件

常用的数据库软件有MySQL、Oracle、SQL Server、PostgreSQL、MongoDB、Redis、Cassandra、Hadoop、Spark和Amazon DynamoDB。更多关于数据库软件的内容详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.02

4209

19

内存数据库有哪些
内存数据库有哪些

内存数据库有Redis、Memcached、Apache Ignite、VoltDB、TimesTen、H2 Database、Aerospike、Oracle TimesTen In-Memory Database、SAP HANA和ache Cassandra。更多关于内存数据库相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.14

3695

11

mongodb和redis哪个读取速度快
mongodb和redis哪个读取速度快

redis 的读取速度比 mongodb 更快。原因包括:1. redis 使用简单的键值存储,而 mongodb 存储 json 格式的数据,需要解析和反序列化。2. redis 使用哈希表快速查找数据,而 mongodb 使用 b-tree 索引。因此,redis 在需要高性能读取操作的应用程序中是一个更好的选择。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.02

6632

6

redis怎么做缓存服务器
redis怎么做缓存服务器

redis 作为缓存服务器的答案:redis 是一款开源、高性能、分布式的键值存储,可作为缓存服务器使用。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.07

623

6

redis怎么解决数据一致性
redis怎么解决数据一致性

redis 提供了两种一致性模型,以维护副本数据一致性:强一致性 (sync) 确保写操作仅在复制到所有从节点后才完成;最终一致性 (async) 则在主节点上写操作后认为已完成,牺牲一致性换取性能。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.07

736

6

mysql和redis怎么保证双写一致性
mysql和redis怎么保证双写一致性

确保 mysql 和 redis 双写一致性的技术包括:1、事务性更新:同时更新 mysql 和 redis,保证一致性;2、主从复制:mysql 主服务器更改同步到 redis 从服务器;3、基于事件的更新:mysql 记录更改并发送到 redis等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.07

6162

6

redis缓存一般存些什么数据
redis缓存一般存些什么数据

redis缓存中存储的数据类型包括:字符串、哈希、列表、集合、有序集合、位图、地理空间数据和hyperloglog。这些数据类型适用于存储各种数据,从简单信息到复杂对象和地理位置。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.07

1140

6

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpEnv手册
phpEnv手册

共0课时 | 0人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.5万人学习