SpringBoot 自定义CacheManager以支持缓存TTL

我们项目中使用redis作为缓存中间件，配合SpringBoot中自带的@Cacheable注解，利用AOP代理增强，使得缓存的使用非常的方便，不过SpringBoot中的Cache并不只针对redis一家，而是对多种缓存方案做了抽象。因此，一些redis有的特性并不能在@Cacheable中体现，例如非常重要的缓存TTL过期自毁功能，在@Cacheable注解的字段中就没有体现。

怎么办？一个方法是看看能否改造@Cacheable，例如有以下的方案：

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Cacheable
public @interface TtlCacheable {
    @AliasFor("cacheNames")
    String[] value() default {};
    @AliasFor("value")
    String key() default "";
    String keyGenerator() default "";
    String cacheManager() default "";
    String cacheResolver() default "";
    String condition() default "";
    String unless() default "";
    boolean sync() default false;
    // 添加一个 ttl 字段
    String ttl() default "";
}

想法挺好，可惜翻了一下源码一看，这个注解的解析是高度框架化的，想要做二次改造，需要修改spring-context包下的SpringCacheAnnotationParser以及改造spring-data-redis，难度可想而知。这一条路就只能先想想了。

另一种方法则容易的许多，通过翻阅写redis的代码，我们发现有个DefaultRedisCacheWriter类，里面有这么一段：

@Override
public void put(String name, byte[] key, byte[] value, @Nullable Duration ttl) {

    Assert.notNull(name, "Name must not be null!");
    Assert.notNull(key, "Key must not be null!");
    Assert.notNull(value, "Value must not be null!");

    execute(name, connection -> {
        if (shouldExpireWithin(ttl)) {
            connection.set(key, value, Expiration.from(ttl.toMillis(), TimeUnit.MILLISECONDS), SetOption.upsert());
        } else {
            connection.set(key, value);
        }
        return "OK";
    });
}

这里出现了ttl这个参数，然后进到jedis的代码中一看，果然是设置过期时间的。这就好多了，我们可以自己设置ttl时间了。

再仔细一看这个类的权限是默认级别，并不开放，而且所有目标都指向了一个构建者类：

RedisCacheManager.RedisCacheManagerBuilder

原来，在CacheManager中，会根据注解@Cacheable的配置，创建一个Map，里面有一系列的RedisCache对象，每个对象对应一个@Cacheable所标注的方法，然后CacheManager中有这个过期时间的配置。只能说这一块封装的实在是太好了，spring不允许你瞎继承乱实现，乖乖的用构建者吧，囧。

到这里目标就很明确了，自定义自己的RedisCacheManager，接下来就直接贴上配置。

@EnableCaching
@Configuration
public class RedisConfig {

    @Bean
    public RedisTemplate redisTemplate(@Autowired RedisConnectionFactory factory) {
        RedisTemplate template = new RedisTemplate<>();
        template.setConnectionFactory(factory);
        template.setKeySerializer(new StringRedisSerializer());
        template.setHashKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        template.setHashValueSerializer(new GenericJackson2JsonRedisSerializer());
        return template;
    }

    @Bean(name="ttlRedisCacheManager")
    public RedisCacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
       RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
                .entryTtl(Duration.ofSeconds(10))
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()))
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(new GenericJackson2JsonRedisSerializer()))
                .disableCachingNullValues();
        RedisCacheManager.RedisCacheManagerBuilder builder =
        RedisCacheManager.RedisCacheManagerBuilder.fromConnectionFactory(redisConnectionFactory);
        return builder.transactionAware().cacheDefaults(config).build();
}

然后再调用服务中写入如下代码：

@Service
public class CacheService {
    @Cacheable(value="XA", key="#hi", cacheManager="ttlRedisCacheManager")
    public String getStr(String hi) {
        return RandomStringUtils.randomAlphabetic(10);
    }
}

执行，并在redis中查看效果，可以发现写入了值，10秒之后，缓存自动被清除

以上方式我个人感觉不是很灵活，如果对不同的缓存有不同的过期时间要求，那么需要定义多个自定义的CacheManager。