SpringCache @Cacheable keyGenerator

秋夜无霜

已于 2022-10-20 17:38:49 修改

阅读量1.5k

点赞数

CC 4.0 BY-SA版权

分类专栏： Spring 文章标签： java spring 开发语言

于 2022-10-20 17:38:33 首次发布

本文链接：https://blog.youkuaiyun.com/shichen2010/article/details/127431605

Spring 专栏收录该内容

19 篇文章

订阅专栏

本文介绍了如何在Spring Cache中自定义@Cacheable的key，通过AdListCacheKeyGenerator组件，根据ListMixLiveRoomRequestBO的cityId生成唯一缓存键。关键步骤包括实现KeyGenerator接口和在@Cacheable注解中指定keyGenerator。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

有时候我们想自定义@Cacheable 的key，由于自定义的key通过方法的参数无法给出，这时候就需要使用keyGenerator了。

通过查看 @Cacheable 的源码可以看出我们自定义一个 KeyGenerator 需要实现一个接口KeyGenerator

	/**
	 * The bean name of the custom {@link org.springframework.cache.interceptor.KeyGenerator}
	 * to use.
	 * <p>Mutually exclusive with the {@link #key} attribute.
	 * @see CacheConfig#keyGenerator
	 */
	String keyGenerator() default "";

首先定义一个 AdListCacheKeyGenerator来实现 KeyGenerator

/**
 * @author 石冬冬(Chris Suk)
 * @since 2022/10/20 4:36 PM
 */
@Component
@Slf4j
public class AdListCacheKeyGenerator implements KeyGenerator{

    @Value("${zhaopin.live-environment:}")
    String env;

    @Override
    public Object generate(Object target, Method method, Object... params) {
        ListMixLiveRoomRequestBO requestBO = (ListMixLiveRoomRequestBO) params[0];
        String cacheKey = new StringBuilder(env).append("_").append(requestBO.getCityId()).toString();
        log.info("[cacheKeyGenerate],cacheKey={}", cacheKey);
        return cacheKey;
    }
}

然后@Cacheable指定该 keyGenerator

@Cacheable(keyGenerator = "adListCacheKeyGenerator")
    public List<AdBO> listValidAd(ListMixLiveRoomRequestBO requestBO) {
        List<AdBO> ads = thirdAdLiveRoomBusiness.listValidAd(requestBO);
        setTestFlag(ads);
        return ads.stream().collect(Collectors.collectingAndThen(Collectors.toCollection(() -> new TreeSet<>(Comparator.comparing(ad -> ad.getId()))), ArrayList::new));
    }
    ```