赋能业务，探秘SpringBoot @Cacheable自定义key策略与缓存失效时间指定

2023-03-07 08:36:56

SpringBoot @Cacheable 注解：提升应用性能的缓存利器

在SpringBoot的强大生态系统中，@Cacheable 注解作为缓存机制的灵魂，扮演着至关重要的角色。它通过对方法返回值进行缓存，有效避免了重复执行低效的数据库查询操作，从而大幅提升了应用性能。本文将深入探讨@Cacheable 注解的各个方面，帮助你充分利用其优势。

默认配置

当你在方法上使用@Cacheable 注解时，SpringBoot会自动生成一个默认的缓存键。键的生成规则为：方法名+参数列表 。例如，对于以下方法：

@Cacheable("defaultCache")
public String getUserNameById(Long id) {
    return "张三";
}

SpringBoot将自动生成缓存键getUserNameById#id 。

自定义键策略

如果你需要更灵活的键生成策略，可以继承KeyGenerator ，声明为一个bean，并在注解中使用keyGenerator 指定：

@Cacheable(value = "customizedCache", keyGenerator = "myKeyGenerator")
public String getUserNameById(Long id) {
    return "张三";
}

同时实现自定义键生成器：

public class MyKeyGenerator implements KeyGenerator {
    @Override
    public Object generate(Object target, Method method, Object... params) {
        // 自定义键生成逻辑
        return "customized#" + params[0];
    }
}

这样，getUserNameById方法的缓存键将变为customized#id 。

缓存失效时间指定

除了自定义键策略外，@Cacheable 注解还支持指定缓存失效时间。通过设置expireAfterWrite 或expireAfterAccess 属性，分别控制缓存数据在写入后或访问后多长时间失效。例如：

@Cacheable(value = "customizedCache", keyGenerator = "myKeyGenerator", expireAfterWrite = 600)
public String getUserNameById(Long id) {
    return "张三";
}

表示getUserNameById方法的缓存数据在写入后600秒（10分钟）失效。

缓存失效策略

除了通过属性指定缓存失效时间外，SpringBoot还提供了多种缓存失效策略：

CACHE_MANAGER_TTL ：使用缓存管理器指定的TTL（生存时间）控制缓存数据失效。
CACHE_DEFAULT_TTL ：使用默认的TTL控制缓存数据失效。
CACHE_NEVER_EXPIRE ：缓存数据永不失效。

可以通过在注解中指定cacheManager 和cacheName 属性来选择不同的缓存失效策略。例如：

@Cacheable(value = "customizedCache", keyGenerator = "myKeyGenerator", cacheManager = "cacheManager", cacheName = "cacheName", cacheManagerTTL = 600)
public String getUserNameById(Long id) {
    return "张三";
}

表示getUserNameById方法的缓存数据在写入后600秒（10分钟）失效，并使用cacheManager管理缓存。

常见问题解答