spring緩存自定義resolver的方法

更新時間：2022年03月14日 14:30:52 作者：QiHY

這篇文章主要為大家詳細(xì)介紹了spring緩存自定義resolver的方法，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下，希望能夠給你帶來幫助

一、概述

cache-aside模式是常用的緩存使用模式。

使用流程如下圖：

在這里插入圖片描述

當(dāng)更新數(shù)據(jù)庫中的數(shù)據(jù)后，對緩存做失效處理，后續(xù)就能讀取到數(shù)據(jù)庫中最新的數(shù)據(jù)，使得緩存數(shù)據(jù)與數(shù)據(jù)庫數(shù)據(jù)保持一致。

在spring中通過cache注解進(jìn)行緩存的處理，一般會把緩存處理封裝到dao層，這樣業(yè)務(wù)層就不需要感知緩存操作的細(xì)節(jié)，可以專注于業(yè)務(wù)邏輯的處理。

二、緩存的讀取和失效

dao層的操作通常使用springdatajpa，數(shù)據(jù)庫方法都是一個interface，通過在interface上增加對應(yīng)的cache注解實現(xiàn)緩存處理。

讀取數(shù)據(jù)：

@Cacheable(value = "testCache", key = "#p0", unless = "#result == null")
Optional<DemoEntity> findById(Long id);

通過Cacheable注解，從數(shù)據(jù)庫中讀取到數(shù)據(jù)后，會同步寫到緩存中。

保存數(shù)據(jù)：

@CacheEvict(value = "testCache", key = "#p0.id")
DemoEntity save(DemoEntity entity);

通過CacheEvict注解，在將數(shù)據(jù)寫入到數(shù)據(jù)庫后，對緩存進(jìn)行失效。

如果我們想在緩存失效后，進(jìn)行其它的操作，例如將失效緩存的key寫入kafka，用于其它系統(tǒng)同步刪除緩存，這時該怎樣處理？

三、自定義緩存resolver

spring提供了自定義緩存resolver的方式，通過自定義resolver，可以在緩存處理中增加附加操作。

@Configuration
public class RedisCacheConfig extends CachingConfigurerSupport {
    @Bean
    public RedisCacheManager redisCacheManager(RedisConnectionFactory redisConnectionFactory) {
        RedisCacheConfiguration cacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
                .computePrefixWith(cacheName -> cacheName.concat(":"));
        return RedisCacheManager.builder(redisConnectionFactory)
                .cacheDefaults(cacheConfiguration)
                .build();
    }
    @Bean
    public CacheResolver customCacheResolver(RedisConnectionFactory redisConnectionFactory) {
        return new CustomCacheResolver(redisCacheManager(redisConnectionFactory));
    }
}

以上代碼是redis緩存的配置，其中 RedisCacheManager部分是常規(guī)的cacheManager的配置，而 customCacheResolver部分是自定義resolver的配置，通過定義customCacheResolver這個bean，可以在cache注解中引用到這個自定義的resolver。

定義好customCacheResolver的bean后，我們就可以在cache注解中引用，上面提到的數(shù)據(jù)保存方法改造后的代碼：

@CacheEvict(value = "testCache", cacheResolver = "customCacheResolver", key = "#p0.id")
DemoEntity save(DemoEntity entity);

相比于之前的實現(xiàn)，對CacheEvict增加指定cacheResolver。

四、自定義resolver的實現(xiàn)

上面我們介紹了如果配置和引用cacheResolver，下面介紹自定義cacheResolver的實現(xiàn)。

public class CustomCacheResolver extends SimpleCacheResolver {
    public CustomCacheResolver(CacheManager cacheManager) {
        super(cacheManager);
    }
    @Override
    @NonNull
    public Collection<? extends Cache> resolveCaches(CacheOperationInvocationContext<?> context) {
        ParameterNameDiscoverer paramNameDiscoverer = new DefaultParameterNameDiscoverer();
        EvaluationContext evaluationContext = new MethodBasedEvaluationContext(context.getOperation(), context.getMethod(), context.getArgs(), paramNameDiscoverer);
        Expression exp = (new SpelExpressionParser()).parseExpression(((CacheEvictOperation) context.getOperation()).getKey());
        Collection<? extends Cache> caches = super.resolveCaches(context);
        context.getOperation().getCacheNames().forEach(cacheName -> {
            String key = cacheName + ':' + exp.getValue(evaluationContext, String.class);
            log.info("cache key={}", key);
        });
        return caches;
    }
}

上面的代碼定義了CustomCacheResolver這個自定義resolver類，繼承SimpleCacheResolver。SimpleCacheResolver類是spring在cache注解中默認(rèn)使用的resolver。

我們通過擴展SimpleCacheResolver這個類，來增加附加操作。其中resolveCaches就是解析緩存操作的部分。

在這部分代碼中，我們需要的是獲取到 @CacheEvict(value = "testCache", cacheResolver = "customCacheResolver", key = "#p0.id")注解中失效的緩存的key的值。

通過 context.getOperation()).getKey()從參數(shù)context中可以讀取到key的定義，即 #p0.id，這個定義是一個spel表達(dá)式，與普通的spel表達(dá)式不同， p0這個變量是jpa方法中的一個特有變量，表示方法中的第一個參數(shù)，同樣p1表示方法中的第二個參數(shù)。通過普通的spel處理無法解析這個spel表達(dá)式。
spring提供了 MethodBasedEvaluationContext類用于解析這種特殊的spel表達(dá)式。

通過一下四行代碼，我們就能夠獲取到具體的key的值：

ParameterNameDiscoverer paramNameDiscoverer = new DefaultParameterNameDiscoverer();
EvaluationContext evaluationContext = new MethodBasedEvaluationContext(context.getOperation(), context.getMethod(), context.getArgs(), paramNameDiscoverer);
Expression exp = (new SpelExpressionParser()).parseExpression(((CacheEvictOperation) context.getOperation()).getKey());
String key = cacheName + ':' + exp.getValue(evaluationContext, String.class);

獲取到了key的值，我們就可以對這個key做很多操作，可以把這個key寫入kafka，通知其它系統(tǒng)同步清理key。