讲师中心 微信公众号
AI工具推荐 视频效率加速

怎样在Spring Boot中自定义Redis缓存的KeyGenerator

星墨同学_7038

星墨同学_7038

发布时间:2026-09-09 09:58:21

|

281人浏览过

|

来源于php中文网

原创

默认SimpleKeyGenerator导致Redis Key冲突,因其忽略类名方法名,仅基于参数值生成key:单参调用toString()、无参返回不可序列化EMPTY、多参拼接难读字符串,造成跨业务缓存覆盖。

怎样在spring boot中自定义redis缓存的keygenerator

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

因为 SimpleKeyGenerator 完全忽略类名和方法名,只看参数值:单参数方法直接调用 toString()getUserById(123)getOrderById(123) 都生成 "123";无参方法返回不可序列化的 SimpleKey.EMPTY;多参则拼成类似 SimpleKey[1,"abc",true] 这种难读、难调试、无法区分业务上下文的字符串。Redis 里 key 一撞,缓存就互相覆盖——查用户返回订单,不是 bug,是设计如此,但线上不能忍。

实现 KeyGenerator 接口时 generate() 必须处理的边界情况

重写 generate(Object target, Method method, Object params) 不能只拼 params.toString(),否则 null、数组、集合、嵌套对象都会出问题:

  • paramsObject[],需遍历处理,不能直接 Arrays.toString(params)
  • null 值必须显式转为 "null",否则 toString() 报 NPE
  • 数组或 Collection 类型建议用 ObjectMapper 序列化为 JSON 字符串,避免 [1,2]Arrays.asList(1,2) 生成相同 key
  • 推荐用下划线 _ 分隔段,不用冒号 : 或点 .,防止和 Redis 命名空间习惯(如 user:1001)冲突
  • 类名优先用 target.getClass().getSimpleName(),比 getName() 简洁,避免包名过长污染 key

注册自定义 KeyGenerator 后不生效的三个硬性检查点

代码写对了,缓存还是走默认逻辑?大概率卡在这三处:

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

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

下载
  • Bean 名必须是 cacheKeyGenerator —— Spring Boot 2.4+ 强制要求,起名 myKeyGeneratorwiselyKeyGenerator 都无效
  • 如果加了 @Primary,必须确保该 Bean 是唯一被标记为 primary 的 KeyGenerator,否则 Spring 会因歧义 fallback 到默认
  • 如果你手动构建了 RedisCacheConfiguration,比如调用了 .keyPrefix("xxx").computePrefixWith(...),那 KeyGenerator 就彻底被绕过了,此时 key 生成完全由 prefix + 参数决定,和你的 generate 方法无关

一个健壮、可直接用的 KeyGenerator 示例

这个版本兼顾可读性、唯一性和 null/集合安全:

public class CustomKeyGenerator implements KeyGenerator {
    private final ObjectMapper objectMapper = new ObjectMapper();

    @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 -> {
                    if (p == null) return "null";
                    if (p instanceof Collection || p.getClass().isArray()) {
                        try {
                            return objectMapper.writeValueAsString(p);
                        } catch (Exception e) {
                            return p.toString(); // fallback
                        }
                    }
                    return p.toString();
                })
                .collect(Collectors.joining("_"));
        return String.format("%s_%s_%s", className, methodName, paramStr);
    }
}

注意:这个类要声明为 @Bean,且名字必须是 cacheKeyGenerator;如果项目已启用 Jackson,无需额外依赖;若没引入,ObjectMapper 可换成 Gson 或简单降级为 p.getClass().getSimpleName() + "@" + p.hashCode()

最易被忽略的是:一旦你调用了 RedisCacheConfiguration.keyPrefix(),整个 KeyGenerator 就失效了——这点在多级缓存或需要统一前缀的场景里,特别容易踩坑。

热门AI工具

更多
UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

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

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

2131

2025.08.06

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

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

397

2026.01.26

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

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

4029

2023.11.02

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

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

3535

2023.11.14

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

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

6272

2024.04.02

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

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

583

2024.04.07

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

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

696

2024.04.07

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

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

5682

2024.04.07

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

0

2026.09.23

热门下载

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

精品课程

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

共0课时 | 0人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn