@Cacheable的实现原理

痛定思痛。 2023-02-12 16:18 201阅读 0赞

如果你用过Spring Cache，你一定对这种配置和代码不陌生：

<cache:annotation-driven cache-manager="cacheManager" proxy-target-class="true" order="1" />

@Cacheable(value = "3600", key = "i'm a cache key")
 public List<Object> getData(){}

上面两段代码，**xml是启用Cache Annotation注解并注册一个cacheManager，第二段代码在getData的时候会先去缓存里取，如果缓存没有再执行getData的真实逻辑。**

那么今天的“走进科学”讲的就是Spring是怎么做到仅仅一段xml配置和一个注解就实现方法级别的自动缓存。

我们**知道Spring最牛逼的地方就在于IOC容器对于bean的管理，可以说是Spring牛逼的基石**，那么画风一换，到了我们今天讨论的起点就是Spring在启动时对xml里面的各种标签进行解析，比如对应<cache:annotation-driven>标签，负责解析的就是AnnotationDrivenCacheBeanDefinitionParser.parse方法，代码看起来很简单，根据mode属性注册Advisor Component：

** 展开原码**

我们今天先看默认mode=proxy的情况，进入方法，发现方法里面注册了三个Bean到Context里面，分别是CacheOperationSource、CacheInterceptor和BeanFactoryCacheOperationSourceAdvisor。

熟悉AOP原理的看到Interceptor和Advisor一般都会明白大半了，并且他们共同都有一个属性cacheOperationSources，实现类是org.springframework.cache.annotation.AnnotationCacheOperationSource。

下面我们先来喵两眼这两个类，先看BeanFactoryCacheOperationSourceAdvisor，里面有一个叫CacheOperationSourcePointcut的pointcut，用来匹配方法是否需要走拦截器。通过调用之前注入进去的cacheOperationSources.getCacheOperations获取CacheOperation，代码如下：

** 展开原码**

这样只有被CacheOperationSourcePointcut匹配的方法才会被拦截，并且通过attributeCache做了缓存。再来看CacheInterceptor类，先看一眼继承结构：

这个类很简单，只是重写了MethodInterceptor的invoke方法：

** 展开原码**

下一步是调用CacheAspectSupport

<table> 
 <tbody> 
 <tr> 
 <td> <code>protected</code>&nbsp;<code>Object execute(CacheOperationInvoker invoker, Object target, Method method, Object[] args) { </code> <code>&nbsp;&nbsp;&nbsp;</code><code>// check whether aspect is enabled</code> <code>&nbsp;&nbsp;&nbsp;</code><code>// to cope with cases where the AJ is pulled in automatically</code> <code>&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>(</code><code>this</code><code>.initialized) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Class&lt;?&gt; targetClass = getTargetClass(target);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Collection&lt;CacheOperation&gt; operations = getCacheOperationSource().getCacheOperations(method, targetClass);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>(!CollectionUtils.isEmpty(operations)) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>execute(invoker,&nbsp;</code><code>new</code>&nbsp;<code>CacheOperationContexts(operations, method, args, target, targetClass));</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>invoker.invoke();</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

其中根据 getCacheOperations获得cacheOperations后调用的execute是关键，其中getCacheOperationSource即是之前说到的bean里面的cacheOperationSources，也org.springframework.cache.annotation.AnnotationCacheOperationSource，它负责三个标签的调用：@Cacheable、@CachePut和@CacheEvict。

下面喽一眼execute方法的代码：

<table> 
 <tbody> 
 <tr> 
 <td> <code>private</code>&nbsp;<code>Object execute(CacheOperationInvoker invoker, CacheOperationContexts contexts) { </code> <code>&nbsp;&nbsp;&nbsp;</code><code>// Process any early evictions</code> <code>&nbsp;&nbsp;&nbsp;</code><code>processCacheEvicts(contexts.get(CacheEvictOperation.</code><code>class</code><code>),&nbsp;</code><code>true</code><code>, ExpressionEvaluator.NO_RESULT);</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;</code><code>// Check if we have a cached item matching the conditions</code> <code>&nbsp;&nbsp;&nbsp;</code><code>Cache.ValueWrapper cacheHit = findCachedItem(contexts.get(CacheableOperation.</code><code>class</code><code>));</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;</code><code>// Collect puts from any @Cacheable miss, if no cached item is found</code> <code>&nbsp;&nbsp;&nbsp;</code><code>List&lt;CachePutRequest&gt; cachePutRequests =&nbsp;</code><code>new</code>&nbsp;<code>LinkedList&lt;CachePutRequest&gt;();</code> <code>&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>(cacheHit ==&nbsp;</code><code>null</code><code>) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>collectPutRequests(contexts.get(CacheableOperation.</code><code>class</code><code>), ExpressionEvaluator.NO_RESULT, cachePutRequests);</code> <code>&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;</code><code>Cache.ValueWrapper result =&nbsp;</code><code>null</code><code>;</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;</code><code>// If there are no put requests, just use the cache hit</code> <code>&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>(cachePutRequests.isEmpty() &amp;&amp; !hasCachePut(contexts)) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>result = cacheHit;</code> <code>&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;</code><code>// Invoke the method if don't have a cache hit</code> <code>&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>(result ==&nbsp;</code><code>null</code><code>) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>result =&nbsp;</code><code>new</code>&nbsp;<code>SimpleValueWrapper(invokeOperation(invoker));</code> <code>&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;</code><code>// Collect any explicit @CachePuts</code> <code>&nbsp;&nbsp;&nbsp;</code><code>collectPutRequests(contexts.get(CachePutOperation.</code><code>class</code><code>), result.get(), cachePutRequests);</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;</code><code>// Process any collected put requests, either from @CachePut or a @Cacheable miss</code> <code>&nbsp;&nbsp;&nbsp;</code><code>for</code>&nbsp;<code>(CachePutRequest cachePutRequest : cachePutRequests) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>cachePutRequest.apply(result.get());</code> <code>&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;</code><code>// Process any late evictions</code> <code>&nbsp;&nbsp;&nbsp;</code><code>processCacheEvicts(contexts.get(CacheEvictOperation.</code><code>class</code><code>),&nbsp;</code><code>false</code><code>, result.get());</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>result.get();</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

这段代码看起来还是比较“简单”的，**也是Spring Cache逻辑的核心实现了吧，**根据注解执行了方法前和方法后需要的缓存操作，注意对于失效的操作分为early evictions和late evictions，对应标签@CacheEvict中的beforeInvocation属性。自此，Spring cache的逻辑算是执行完毕。

还有两点需要注意的就是

1.  上面的实现是通过proxy的形式实现，那么对象的方法是内部调用（即 this 引用）而不是外部引用，则会导致 proxy失效，也就是注解失效。
2.  非public方法同上
3.  @CacheEvict标签不会对抛出异常的方法的缓存进行清空，通过将beforeInvocation设置为true，即在方法执行前