快捷導(dǎo)航

Spring Cache自定義緩存key和過期時間的實現(xiàn)代碼

更新時間：2024年05月30日 11:06:20 作者：Charge8

使用 Redis的客戶端 Spring Cache時,會發(fā)現(xiàn)生成 key中會多出一個冒號,而且有一個空節(jié)點的存在,查看源碼可知,這是因為 Spring Cache默認生成key的策略就是通過兩個冒號來拼接,本文給大家介紹了Spring Cache自定義緩存key和過期時間的實現(xiàn),需要的朋友可以參考下

一、自定義全局緩存key和雙冒號替換

使用 Redis的客戶端 Spring Cache時，會發(fā)現(xiàn)生成 key中會多出一個冒號，而且有一個空節(jié)點的存在。

查看源碼可知，這是因為 Spring Cache默認生成key的策略就是通過兩個冒號來拼接。

在這里插入圖片描述

同時 Spring Cache緩存到 Redis的 key為：Cache注解的value|cacheNames的值與其 key的值的拼接。

在這里插入圖片描述

我們可以自定義 CacheKeyPrefix來替換雙冒號，也可以自定義全局緩存 key的前綴。

    /**
     * 項目名
     */
    private final static String SPRING_APPLICATION_NAME = "ws";

    /**
     * Cache 默認的 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 + ":";

二、自定義過期時間

CacheManager 是 Spring 各種緩存的抽象接口。抽象的意義在于屏蔽不同實現(xiàn)細節(jié)的差異和提供擴展性。

對于 Spring Cache的緩存注解，原生沒有額外提供一個指定 ttl 的配置，它是不支持在注解上添加過期時間的。

實際的業(yè)務(wù)場景中，如果希望通過緩存注解指定過期時間TTL，我們就需要自定義 RedisCacheManager來完成。

自定義TTL約定：

1、支持使用 Cache注解的value|cacheNames來自定義過期時間。#ttlOfSecond不作為key的一部分。

示例：value|cacheNames = “keyName#ttlOfSecond”。 keyName為業(yè)務(wù)緩存key。#為自定義TTL連接符。ttlOfSecond為過期時間，單位秒。

2、Spring Cache緩存到 Redis的 key需要過濾掉 #ttlOfSecond這部分。

實現(xiàn)邏輯步驟：

1、自定義緩存管理器并繼承RedisCacheManager，同時重寫createRedisCache方法
2、將默認的緩存管理器改成我們自定義的緩存管理器

1、自定義緩存管理器

/**
 * 自定義 RedisCacheManager配置。
 */
@Slf4j
public class CustomRedisCacheManager extends RedisCacheManager {

    /**
     * 項目名
     */
    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è)置緩存的過期時間，查詢不會更新過期時間
        ;
        return super.createRedisCache(name, cacheConfig);
    }

    /**
     * Cache 默認的 RedisKey的格式為（@Cacheable注解上的信息）： value|cacheNames::key。
     * 自定義需求：
     * 1、key前綴分隔符:: 不習(xí)慣，換成:前綴分隔符。
     * 2、在 Cache相關(guān)注解 key的生成規(guī)則上，添加全局緩存 key的前綴。
     */
    private static final CacheKeyPrefix CUSTOM_CACHE_KEY_PREFIX = cacheName -> {
        // 過濾掉自定義的 TTL分隔符
        String cacheName0 = cacheName.split(CUSTOM_TTL_SEPARATOR)[0];
        return SPRING_APPLICATION_NAME + ":" + cacheName0 + ":";
    };
    

    /**
     * 根據(jù) TTL分隔符拆分字符串，并進行過期時間 TTL的解析
     *
     * @param name 業(yè)務(wù) Cache注解的value|cacheNames
     * @return
     */
    private Duration getTtlByCustomName(String name) {
        if (StringUtils.isBlank(name)) {
            return null;
        }
        /**
         * 根據(jù) TTL分隔符拆分字符串，并進行過期時間 TTL的解析
         * 數(shù)組元素0 = 緩存的名稱
         * 數(shù)組元素1 = 緩存過期時間TTL
         */
        String[] cacheParams = name.split(CUSTOM_TTL_SEPARATOR);
        if (cacheParams.length > 1) {
            // 如果 TTL解析異常或者小于等于0，則返回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類中，注入我們自定義的緩存管理器。

@EnableCaching
@Configuration
public class CacheConfiguration {

     @Bean
    public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
         // 初始化一個RedisCacheWriter
         RedisCacheWriter redisCacheWriter = RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory);
         // 初始化一個RedisCacheConfiguration
         RedisCacheConfiguration defaultCacheConfig = RedisCacheConfiguration.defaultCacheConfig();
         // 返回一個自定義的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);
    }

在這里插入圖片描述