本文介紹spring中自定義緩存resolver，通過自定義resolver，可以在spring的cache註解中增加附加處理。 具體的代碼參照 示例項目 https://github.com/qihaiyan/springcamp/tree/master/spring-redis-resolver
一、概述
cache-aside模式是常用的緩存使用模式。使用流程如下圖： 
當更新數據庫中的數據後，對緩存做失效處理，後續就能讀取到數據庫中最新的數據，使得緩存數據與數據庫數據保持一致。
在spring中通過cache註解進行緩存的處理，一般會把緩存處理封裝到dao層，這樣業務層就不需要感知緩存操作的細節，可以專注於業務邏輯的處理。
二、緩存的讀取和失效
dao層的操作通常使用springdatajpa，數據庫方法都是一個interface，通過在interface上增加對應的cache註解實現緩存處理。
讀取數據：
@Cacheable(value = "testCache", key = "#p0", unless = "#result == null")
Optional<DemoEntity> findById(Long id);
通過Cacheable註解，從數據庫中讀取到數據後，會同步寫到緩存中。
保存數據：
@CacheEvict(value = "testCache", key = "#p0.id")
DemoEntity save(DemoEntity entity);
通過CacheEvict註解，在將數據寫入到數據庫後，對緩存進行失效。 如果我們想在緩存失效後，進行其它的操作，例如將失效緩存的key寫入kafka，用於其它系統同步刪除緩存，這時該怎樣處理？
三、自定義緩存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 部分是常規的cacheManager的配置， 而 customCacheResolver 部分是自定義resolver的配置，通過定義customCacheResolver這個bean，可以在cache註解中引用到這個自定義的resolver。
定義好customCacheResolver的bean後，我們就可以在cache註解中引用，上面提到的數據保存方法改造後的代碼：
@CacheEvict(value = "testCache", cacheResolver = "customCacheResolver", key = "#p0.id")
DemoEntity save(DemoEntity entity);
相比於之前的實現，對CacheEvict增加指定cacheResolver。
四、自定義resolver的實現
上面我們介紹瞭如果配置和引用cacheResolver，下面介紹自定義cacheResolver的實現。
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註解中默認使用的resolver。 我們通過擴展SimpleCacheResolver這個類，來增加附加操作。 其中resolveCaches就是解析緩存操作的部分。 在這部分代碼中，我們需要的是獲取到 @CacheEvict(value = "testCache", cacheResolver = "customCacheResolver", key = "#p0.id") 註解中失效的緩存的key的值。
通過 context.getOperation()).getKey() 從參數context中可以讀取到key的定義，即 #p0.id 。
這個定義是一個spel表達式，與普通的spel表達式不同， p0這個變量是jpa方法中的一個特有變量，表示方法中的第一個參數，同樣p1表示方法中的第二個參數。通過普通的spel處理無法解析這個spel表達式。 spring提供了 MethodBasedEvaluationContext 類用於解析這種特殊的spel表達式。
通過一下四行代碼，我們就能夠獲取到具體的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，通知其它系統同步清理key。
五、總結
我們通常把緩存操作封裝到dao層以簡化程序的整體邏輯，當使用springdatajpa作爲dao層的實現時，具體的dao方法都是interface，對於在interface上添加的cache註解，沒有辦法增加額外的其它操作。 當需要對緩存操作做額外處理時，可以通過自定義resolver的方式實現，在cache註解中使用我們自定義的resolver。 這樣既沒有破環程序的整理邏輯，又擴展了對緩存的操作，是一種比較好的實現方式。