Spring Boot + Redis 缓存方案深度解读

本文来自作者 烟花易冷 在 GitChat 上分享 「Spring Boot + Redis 缓存方案深度解读」，「阅读原文」查看交流实录。

「文末高能」

编辑 | 哈比

本文主要涉及到的几个类

RedisCache 是 Cache 接口的实现类，在 Cache 接口中定义了缓存的基本增删改查操作。

• CacheAspectSupport 是 spring 缓存操作的 aop 切面，缓存产生作用的入口主要在这里；

• RedisCacheManager 是 redis cache 的主要配置类。

一个重要的设计原则

面向接口编程，所有的设计都是基于接口的，这样的代码更加优雅、具有很强的扩展性。

注意事项：使用缓存注解时根本原理是 AOP 切面，要让切面起作用，方法的调用必须发生在从外部调用内部，如果是同一个类两个方法的调用切面是不会起作用的，此时缓存也不会起作用。

以一个问题进行开篇

问题：使用 spring data redis 的缓存方案时 , 是如何关联删除掉 books 下面的所有缓存的？

结论：spring data redis 事先在 redis 中维护一个 sorted set 用来存储所有已知的 keys, 当删除指定 allEntries=true 参数的时候，直接从 sorted set 中所有维护的 key，然后删除 sorted set 本身。

备注：分析过程中使用的代码为 spring cache 官方 demo，经过少许改造，可以从 github 地址获取：
https://github.com/pluone/gs-caching/tree/master/complete

// 当我们使用 @CacheEvict 注解来清除缓存时 , 当参数 allEntries=true 的时候会关联清除 books 缓存下所有的 key, 那么 redis 是如何知道 books 下面有哪些需要删除的缓存的呢？
@CacheEvict(cacheNames = "books", allEntries = true)
public void clearCache() {
   //do nothing
}

分析过程如下：我们可以先推测 spring 维护了一个类似 list 的东西，存储了所有已知的 key，那么在第一次设置缓存时一定会将已知 key 存入这样的一个 list。如下：

//redis 的 @Cacheable 和 @CachePut 注解最终都将转化为这个操作
//具体在 redis 中的操作又分为三步
//第一步：调用 set 命令设置缓存
//第二步：设置缓存的过期时间
//第三步：maintainKnownKeys 维护已知 key, 这一步其实是将所有已知的 key 存进一个 sorted set 中，具体分析见下一个代码片段
static class RedisCachePutCallback extends AbstractRedisCacheCallback<Void> {
   public RedisCachePutCallback(BinaryRedisCacheElement element, RedisCacheMetadata metadata) {
   
           super(element, metadata);    }
   /*        * (non-Javadoc)        * @see
org.springframework.data.redis.cache.RedisCache.AbstractRedisPutCallback#doInRedis(org.springframework.data.redis.cache.RedisCache.RedisCacheElement, org.springframework.data.redis.connection.RedisConnection)        */    @Override    public Void doInRedis(BinaryRedisCacheElement element, RedisConnection connection) throws DataAccessException {
   
       if (!isClusterConnection(connection)) {            connection.multi();        }
       
       if (element.get().length == 0) {            connection.del(element.getKeyBytes());        } else {            connection.set(element.getKeyBytes(), element.get());            processKeyExpiration(element, connection);            maintainKnownKeys(element, connection);        }
       
       if (!isClusterConnection(connection)) {            connection.exec();        }
       return null;    } }

// 这一步是将已知 key 加入 sorted set 的具体操作
protected void maintainKnownKeys(RedisCacheElement element, RedisConnection connection) {

   if (!element.hasKeyPrefix()) {        connection.zAdd(cacheMetadata.getSetOfKnownKeysKey(), 0,
element.getKeyBytes());

       if (!element.isEternal()) {            connection.expire(cacheMetadata.getSetOfKnownKeysKey(),
element.getTimeToLive());        }    } }

//spring 的缓存注解最终都是通过 CacheAspectSupport 类中的这个方法来执行的，可以看到倒数第二行代码是处理缓存删除逻辑的
private Object execute(final CacheOperationInvoker invoker, Method method, CacheOperationContexts contexts) {
   // Special handling of synchronized invocation
   // 这里的判断是当设置 Cacheable(sync=true) 时执行的操作，确保了程序并发更新缓存的安全性    if (contexts.isSynchronized()) {        CacheOperationContext context = contexts.get(CacheableOperation.class).iterator().next();
       if (isConditionPassing(context, CacheOperationExpressionEvaluator.NO_RESULT)) {            Object key = generateKey(context, CacheOperationExpressionEvaluator.NO_RESULT);            Cache cache = context.getCaches().iterator().next();
           try {
               return wrapCacheValue(method, cache.get(key, new Callable