Spring-CacheKey 设置注意事项

原创于 2025-03-28 15:35:00 发布 · 788 阅读

26 ·

CC 4.0 BY-SA版权

文章标签：

#spring #java #后端

零基础学Java 专栏收录该内容

700 篇文章

订阅专栏

全文目录：

开篇语

哈喽，各位小伙伴们，你们好呀，我是喵手。运营社区：C站/掘金/腾讯云/阿里云/华为云/51CTO；欢迎大家常来逛逛

今天我要给大家分享一些自己日常学习到的一些知识点，并以文字的形式跟大家一起交流，互相学习，一个人虽可以走的更快，但一群人可以走的更远。

我是一名后端开发爱好者，工作日常接触到最多的就是Java语言啦，所以我都尽量抽业余时间把自己所学到所会的，通过文章的形式进行输出，希望以这种方式帮助到更多的初学者或者想入门的小伙伴们，同时也能对自己的技术进行沉淀，加以复盘，查缺补漏。

小伙伴们在批阅的过程中，如果觉得文章不错，欢迎点赞、收藏、关注哦。三连即是对作者我写作道路上最好的鼓励与支持！

前言

在现代企业级开发中，缓存是优化系统性能、提升响应速度的关键技术之一。Spring 框架通过 Spring Cache 提供了简单而强大的缓存支持，开发者可以轻松实现方法级缓存、减少数据库或外部服务的调用。然而，缓存的命中率是评估缓存系统效率的重要指标，而 Cache Key 的设计直接决定了缓存的命中率。

在上期中，我们讨论了 Spring Cache 的核心原理与基本使用，包括注解方式的缓存设置、缓存的存储位置以及生命周期管理等内容。本期将深入解析 Spring Cache Key 的设置注意事项，从原理、实践到优化，帮助开发者提升缓存的精度和性能。

摘要

本文围绕 Spring Cache Key 的设置展开，介绍了 Spring Cache 的默认 Key 生成策略及其局限性，并详细讲解如何通过自定义 Key 来优化缓存策略。结合实际案例分析，我们重点讨论了以下几个方面：

Spring Cache 默认 Key 生成的原理。
Cache Key 设计的最佳实践。
自定义 Cache Key 的实现方法。
设置 Cache Key 时常见的坑及优化建议。

概述

Spring Cache 提供了一套强大的注解机制（如 @Cacheable、@CacheEvict、@CachePut 等），简化了缓存逻辑的实现。然而，当方法被缓存时，Spring 需要一个 Cache Key 来标识唯一的缓存条目。默认情况下，Spring 根据方法参数来生成 Key，但这一默认策略并不总能满足复杂场景的需求。

一个设计良好的 Cache Key 可以极大地提高缓存命中率，而不合理的 Key 设置可能导致：

缓存击穿：Key 生成策略导致每次请求都未命中缓存。
缓存污染：多个方法生成相同的 Key，覆盖了不相关的数据。
缓存过大：不必要的数据被缓存，浪费存储空间。

因此，设计合理的 Cache Key 是实现高效缓存的基础。

Spring Cache 默认 Key 生成策略

当你使用 Spring Cache 的注解时，例如：

@Cacheable(value = "users")
public User getUserById(Long userId) {
    return userRepository.findById(userId);
}

Spring 默认使用方法的 所有参数 作为缓存的 Key。这一策略通过以下方式生成 Key：

如果方法参数只有一个，直接使用该参数值作为 Key。
如果有多个参数，使用 SimpleKey 类封装所有参数值作为 Key。
如果没有参数，使用 SimpleKey.EMPTY 作为 Key。

默认生成的 Key 示例：

方法签名	调用参数	生成的 Key
`getUserById(Long userId)`	`1L`	`1L`
`getUser(Long id, String name)`	`1L, "John"`	`SimpleKey[1L, John]`
`getAllUsers()`	无参数	`SimpleKey.EMPTY`

默认 Key 的局限性：

不可控性：默认生成的 Key 无法满足特定业务需求。例如，当参数类型较复杂（如对象）时，默认的 Key 可能难以识别。
缺乏灵活性：在多参数场景下，可能并不需要所有参数都参与生成 Key。
易冲突性：不同方法可能会生成相同的 Key，从而导致数据覆盖。

Cache Key 设计的最佳实践

在设置 Cache Key 时，可以参考以下最佳实践：

明确唯一性：每个缓存条目都应该有一个唯一的 Key，避免 Key 冲突导致的数据污染。
可控粒度：Key 的生成应与业务需求匹配，避免生成过多的无用缓存。
避免过度复杂：Key 应尽可能简单，同时保证语义清晰。
使用有意义的字段：在多参数方法中，应选择业务上重要的字段作为 Key，而非所有字段。
考虑缓存失效策略：设计 Key 时，应与缓存的生命周期和业务的缓存更新机制相匹配。

自定义 Cache Key 的实现

Spring 提供了多种方式来自定义缓存 Key：

1. 使用 `key` 属性

通过 @Cacheable 的 key 属性，可以指定自定义的 Key 表达式：

@Cacheable(value = "users", key = "#userId")
public User getUserById(Long userId) {
    return userRepository.findById(userId);
}

Key 表达式示例：

#参数名：使用方法参数生成 Key，例如 #userId。
#root.methodName：使用方法名生成 Key。
#result：使用方法返回值生成 Key（仅限 @CachePut）。

多参数场景：

@Cacheable(value = "users", key = "#userId + '_' + #name")
public User getUser(Long userId, String name) {
    return userRepository.findByIdAndName(userId, name);
}

生成的 Key 示例：1_John。

2. 自定义 `KeyGenerator`

在复杂场景下，可以通过自定义 KeyGenerator 来灵活生成 Key。

步骤：

实现 KeyGenerator 接口：

@Component("customKeyGenerator")
public class CustomKeyGenerator implements KeyGenerator {
    @Override
    public Object generate(Object target, Method method, Object... params) {
        // 自定义 Key 的生成逻辑
        return method.getName() + "_" + Arrays.toString(params);
    }
}

在缓存注解中指定 KeyGenerator：

@Cacheable(value = "users", keyGenerator = "customKeyGenerator")
public User getUser(Long userId) {
    return userRepository.findById(userId);
}

3. 使用 `SpEL` 表达式的高级用法

Spring 表达式语言（SpEL）可以实现更灵活的 Key 生成：

@Cacheable(value = "users", key = "#user.id + '_' + #user.name")
public User getUser(User user) {
    return userRepository.findById(user.getId());
}

当传入的对象是复杂类型时，可以通过 SpEL 动态获取对象的属性值。

设置 Cache Key 时常见的坑

Key 冲突
- 问题：多个方法生成了相同的 Key，导致缓存覆盖。
- 解决方案：为每个方法指定不同的缓存名称或设计唯一的 Key。
复杂对象作为 Key
- 问题：当方法参数是复杂对象时，默认的 Key 可能是对象的内存地址，无法正确匹配。
- 解决方案：通过 key 属性或自定义 KeyGenerator 显式指定字段。
Key 设计与业务逻辑不匹配
- 问题：Key 的粒度与业务不符，导致缓存命中率低或缓存无效。
- 解决方案：分析业务需求，选择合适的字段生成 Key。
Key 长度过长
- 问题：Key 过长会导致缓存系统的存储开销增加，查询效率下降。
- 解决方案：使用哈希算法生成短 Key，但需保证唯一性。

实战案例

场景 1：根据用户 ID 查询用户信息

需求：根据用户 ID 获取用户信息，不同用户的缓存 Key 应唯一。

解决方案：

@Cacheable(value = "users", key = "#userId")
public User getUserById(Long userId) {
    return userRepository.findById(userId);
}

场景 2：根据多条件查询商品

需求：用户可能会根据商品 ID 和地区查询商品，缓存 Key 应区分地区。

解决方案：

@Cacheable(value = "products", key = "#productId + '_' + #region")
public Product getProduct(Long productId, String region) {
    return productRepository.findByIdAndRegion(productId, region);
}

场景 3：使用复杂对象作为参数

需求：传入商品对象，根据商品 ID 和名称生成 Key。

解决方案：

@Cacheable(value = "products", key = "#product.id + '_' + #product.name")
public Product getProduct(Product product) {
    return productRepository.findById(product.getId());
}