Spring Cache自定義緩存key和過(guò)期時(shí)間的實(shí)現(xiàn)代碼
一、自定義全局緩存key和雙冒號(hào)替換
使用 Redis的客戶(hù)端 Spring Cache時(shí),會(huì)發(fā)現(xiàn)生成 key中會(huì)多出一個(gè)冒號(hào),而且有一個(gè)空節(jié)點(diǎn)的存在。
查看源碼可知,這是因?yàn)?Spring Cache默認(rèn)生成key的策略就是通過(guò)兩個(gè)冒號(hào)來(lái)拼接。

同時(shí) Spring Cache緩存到 Redis的 key為:Cache注解的value|cacheNames的值與其 key的值的拼接。

我們可以自定義 CacheKeyPrefix來(lái)替換雙冒號(hào),也可以自定義全局緩存 key的前綴。
/**
* 項(xiàng)目名
*/
private final static String SPRING_APPLICATION_NAME = "ws";
/**
* Cache 默認(rèn)的 key前綴為空,key的格式為(@Cacheable注解上的信息): value|cacheNames::key。
* 自定義需求:
* 1、key前綴分隔符:: 不習(xí)慣,換成:前綴分隔符。
* 2、在 Cache相關(guān)注解 key的生成規(guī)則上,添加全局緩存 key的前綴。
*/
private static final CacheKeyPrefix CUSTOM_CACHE_KEY_PREFIX = cacheName -> SPRING_APPLICATION_NAME + ":" + cacheName0 + ":";
二、自定義過(guò)期時(shí)間
CacheManager 是 Spring 各種緩存的抽象接口。抽象的意義在于屏蔽不同實(shí)現(xiàn)細(xì)節(jié)的差異和提供擴(kuò)展性。
對(duì)于 Spring Cache的緩存注解,原生沒(méi)有額外提供一個(gè)指定 ttl 的配置,它是不支持在注解上添加過(guò)期時(shí)間的。
實(shí)際的業(yè)務(wù)場(chǎng)景中,如果希望通過(guò)緩存注解指定過(guò)期時(shí)間TTL,我們就需要自定義 RedisCacheManager來(lái)完成。
自定義TTL約定:
1、支持使用 Cache注解的value|cacheNames來(lái)自定義過(guò)期時(shí)間。#ttlOfSecond不作為key的一部分。
示例:value|cacheNames = “keyName#ttlOfSecond”。 keyName為業(yè)務(wù)緩存key。#為自定義TTL連接符。ttlOfSecond為過(guò)期時(shí)間,單位秒。
2、Spring Cache緩存到 Redis的 key需要過(guò)濾掉 #ttlOfSecond這部分。
實(shí)現(xiàn)邏輯步驟:
- 1、自定義緩存管理器并繼承RedisCacheManager,同時(shí)重寫(xiě)createRedisCache方法
- 2、將默認(rèn)的緩存管理器改成我們自定義的緩存管理器
1、自定義緩存管理器
/**
* 自定義 RedisCacheManager配置。
*/
@Slf4j
public class CustomRedisCacheManager extends RedisCacheManager {
/**
* 項(xiàng)目名
*/
private final static String SPRING_APPLICATION_NAME = "ws";
/**
* 自定義緩存參數(shù)的TTL分隔符
* 示例:value|cacheNames = “keyName#ttlOfSecond”。
*/
private static final String CUSTOM_TTL_SEPARATOR = "#";
public CustomRedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration defaultCacheConfiguration) {
super(cacheWriter, defaultCacheConfiguration);
}
/**
* @param name must not be {@literal null}. 業(yè)務(wù) Cache注解的value|cacheNames
* @param cacheConfig can be {@literal null}.
* @return
*/
@Override
protected RedisCache createRedisCache(String name, RedisCacheConfiguration cacheConfig) {
Duration ttl = getTtlByCustomName(name);
if (ttl == null) {
// 如果自定義 TTL為空,則設(shè)置全局 TTL為7天。
ttl = Duration.ofDays(7);
}
/**
* Cache緩存配置
*/
cacheConfig = cacheConfig
.computePrefixWith(CUSTOM_CACHE_KEY_PREFIX) // 設(shè)置緩存key
.entryTtl(ttl) // 設(shè)置緩存的過(guò)期時(shí)間,查詢(xún)不會(huì)更新過(guò)期時(shí)間
;
return super.createRedisCache(name, cacheConfig);
}
/**
* Cache 默認(rèn)的 RedisKey的格式為(@Cacheable注解上的信息): value|cacheNames::key。
* 自定義需求:
* 1、key前綴分隔符:: 不習(xí)慣,換成:前綴分隔符。
* 2、在 Cache相關(guān)注解 key的生成規(guī)則上,添加全局緩存 key的前綴。
*/
private static final CacheKeyPrefix CUSTOM_CACHE_KEY_PREFIX = cacheName -> {
// 過(guò)濾掉自定義的 TTL分隔符
String cacheName0 = cacheName.split(CUSTOM_TTL_SEPARATOR)[0];
return SPRING_APPLICATION_NAME + ":" + cacheName0 + ":";
};
/**
* 根據(jù) TTL分隔符拆分字符串,并進(jìn)行過(guò)期時(shí)間 TTL的解析
*
* @param name 業(yè)務(wù) Cache注解的value|cacheNames
* @return
*/
private Duration getTtlByCustomName(String name) {
if (StringUtils.isBlank(name)) {
return null;
}
/**
* 根據(jù) TTL分隔符拆分字符串,并進(jìn)行過(guò)期時(shí)間 TTL的解析
* 數(shù)組元素0 = 緩存的名稱(chēng)
* 數(shù)組元素1 = 緩存過(guò)期時(shí)間TTL
*/
String[] cacheParams = name.split(CUSTOM_TTL_SEPARATOR);
if (cacheParams.length > 1) {
// 如果 TTL解析異?;蛘咝∮诘扔?,則返回null;
Long ttl = null;
try {
ttl = Long.parseLong(cacheParams[1]);
} catch (NumberFormatException e) {
log.debug(" CacheManager 解析自定義 TTL異常,e.getMessage = {}", e.getMessage());
}
if (ttl != null && ttl > 0) {
return Duration.ofSeconds(ttl);
}
}
return null;
}
}
2、注入自定義緩存管理器
在自定義的 CacheConfiguration類(lèi)中,注入我們自定義的緩存管理器。
@EnableCaching
@Configuration
public class CacheConfiguration {
@Bean
public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
// 初始化一個(gè)RedisCacheWriter
RedisCacheWriter redisCacheWriter = RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory);
// 初始化一個(gè)RedisCacheConfiguration
RedisCacheConfiguration defaultCacheConfig = RedisCacheConfiguration.defaultCacheConfig();
// 返回一個(gè)自定義的CacheManager
return new CustomRedisCacheManager(redisCacheWriter, defaultCacheConfig);
}
}
3、業(yè)務(wù)使用
@Cacheable(value = "userCache_#120", key = "#id", unless = "#result==null")
//@Cacheable(value = "userCache_", key = "#id", unless = "#result==null")
//@Cacheable(value = "userCache_#0asa", key = "#id", unless = "#result==null")
@Override
public UserDTO getById(Long id) {
if (id == null || id <= 0L) {
return null;
}
UserDO userDO = userMapper.selectById(id);
return do2DTO(userDO);
}

以上就是Spring Cache自定義緩存key和過(guò)期時(shí)間的實(shí)現(xiàn)代碼的詳細(xì)內(nèi)容,更多關(guān)于Spring Cache緩存key和過(guò)期時(shí)間的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
SpringBoot中注冊(cè)過(guò)濾器的幾種實(shí)現(xiàn)方式
本文主要介紹了SpringBoot中注冊(cè)過(guò)濾器的幾種實(shí)現(xiàn)方式,主要介紹了三種方式,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2024-01-01
java設(shè)計(jì)模式學(xué)習(xí)之簡(jiǎn)單工廠模式
這篇文章主要為大家詳細(xì)介紹了java設(shè)計(jì)模式學(xué)習(xí)之簡(jiǎn)單工廠模式,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-10-10
SpringBoot日志框架之Log4j2快速入門(mén)與參數(shù)詳解
本文介紹了SpringBoot日志框架log4j2的基本使用和配置方法,包括將日志輸出到控制臺(tái)、文件、Elasticsearch和Kafka,多個(gè)輸出目的地的配置,異步日志記錄器的使用以及l(fā)og4j2.xml配置文件的詳細(xì)語(yǔ)法和參數(shù)含義,需要的朋友可以參考下2023-05-05
SpringBoot?整合Security權(quán)限控制的初步配置
這篇文章主要為大家介紹了SpringBoot?整合Security權(quán)限控制的初步配置實(shí)例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-11-11
IDEA使用Maven創(chuàng)建父與子多模塊項(xiàng)目的圖文教程
在?IntelliJ?IDEA?中使用?Maven?創(chuàng)建父與子多模塊項(xiàng)目是一個(gè)常見(jiàn)的開(kāi)發(fā)實(shí)踐,有助于更好地組織和管理代碼,所以本文小編給大家介紹了IDEA使用Maven創(chuàng)建父與子多模塊項(xiàng)目的圖文教程,需要的小伙伴跟著小編一起來(lái)看看吧2025-03-03
詳解Mybatis核心類(lèi)SqlSessionFactory的構(gòu)建
這篇文章主要為大家詳細(xì)介紹了Mybatis核心類(lèi)SqlSessionFactory的構(gòu)建過(guò)程,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2022-12-12

