如何在Spring Boot中自定义Redis Key的生成策略_实现KeyGenerator接口

胖辰姑娘_7443

胖辰姑娘_7443

2026-07-07

386人浏览

原创

默认simplekeygenerator会导致redis key冲突,因其对单参数方法直接使用参数tostring(),如getuserbyid(123)和getorderbyid(123)均生成key“123”,造成缓存互相覆盖。

如何在spring boot中自定义redis key的生成策略_实现keygenerator接口

为什么默认的 SimpleKeyGenerator 会导致 Redis Key 冲突

Spring Boot 的 @Cacheable 默认用 SimpleKeyGenerator,它对无参方法返回 SimpleKey.EMPTY(即一个空对象),对单参数方法直接用参数值的 toString()。问题来了:当多个不同方法都只传一个 Long id,比如 getUserById(123) 和 getOrderById(123),生成的缓存 Key 都是 "123" —— 这会互相覆盖,查用户返回了订单数据。

实现 KeyGenerator 接口时必须重写 generate() 方法

自定义 Key 生成器的核心就是让每个缓存入口有唯一、可读、可追溯的 Key。你需要继承或直接实现 KeyGenerator,并重写 generate(Object target, Method method, Object... params):

  • target 是当前被代理的目标对象(如 UserServiceImpl 实例)
  • method 是被注解的方法(可用 method.getDeclaringClass().getSimpleName() + "#" + method.getName() 构建前缀)
  • params 是实际入参,别直接拼 toString(),要处理 null、数组、集合等边界情况

示例片段:

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载
public class CustomKeyGenerator implements KeyGenerator {
    @Override
    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.toString())
            .collect(Collectors.joining("_"));
        return String.format("%s:%s:%s", className, methodName, paramStr);
    }
}

注册自定义 KeyGenerator 后仍不生效?检查这三点

常见失效原因不是代码写错,而是没正确“挂载”到 Spring 上下文:

  • 必须声明为 @Bean,且 Bean 名为 cacheKeyGenerator(Spring Boot 2.4+ 要求)或通过 @Primary 显式标记,否则 Spring 仍用默认实例
  • 如果项目用了 @EnableCaching,确保它所在配置类能被 ComponentScan 扫描到;若在启动类上,需确认该类包路径覆盖了 KeyGenerator 定义位置
  • Redis 缓存管理器(RedisCacheManager)未显式指定 KeyGenerator 时,才走全局默认;但如果你手动构建了 RedisCacheConfiguration,记得调用 .keyPrefix(...) 或 .computePrefixWith(...) —— 此时 KeyGenerator 不再参与 Key 生成

KeyGenerator 与 RedisCacheConfiguration.keyPrefix 的关系

两者不是互斥,而是协作层级不同:KeyGenerator 负责生成“业务逻辑层 Key”,比如 "UserService:getUserById:123";而 keyPrefix 是 Redis 层的统一前缀,比如 "prod:cache:",最终存入 Redis 的 Key 是两者拼接结果(默认用冒号连接)。所以更安全的做法是:KeyGenerator 专注区分方法和参数,keyPrefix 专注环境/模块隔离。

容易忽略的是:如果你在 RedisCacheConfiguration 中设置了 computePrefixWith(cacheName -> "v2:" + cacheName),那 KeyGenerator 产出的字符串会被整体当作 cacheName 处理——此时它生成的内容就变成了二级前缀,而不是最终 Key 主体。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

redis spring boot

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2025.08.06

2531

22

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

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

2026.01.26

457

25

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

2023.10.19

3148

3

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

2025.10.17

4829

12

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2025.12.29

3769

9

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

2026.01.19

446

15

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

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

2023.11.02

4489

19

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

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

2023.11.14

4035

11

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

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

2024.04.02

7452

6

热门下载

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

精品课程

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

共0课时 | 0人学习