【精品】Spring Cache 原理 详解

概述

Spring定义了org.springframework.cache.Cache和org.springframework.cache.CacheManager接口来统一不同的缓存技术；并支持使用JCache（JSR-107）注解简化我们开发，它有以下特点：

• Cache接口为缓存的组件规范定义，包含缓存的各种操作集合；
• Cache接口下Spring提供了各种xxxCache的实现；如RedisCache，EhCacheCache ,ConcurrentMapCache等；

每次调用需要缓存功能的方法时，Spring会检查检查指定参数的指定的目标方法是否已经被调用过；如果有就直接从缓存中获取方法调用后的结果，如果没有就调用方法并缓存结果后返回给用户，下次调用直接从缓存中获取。

使用Spring缓存抽象时我们需要关注以下两点：

• 确定方法需要被缓存以及他们的缓存策略
• 从缓存中读取之前缓存存储的数据

SpringCache本身是一个缓存体系的抽象实现，但它本身并没有具体的缓存能力，要使用SpringCache还需要配合具体的缓存实现来完成。
虽然如此，但是SpringCache是所有Spring支持的缓存结构的基础，而且所有的缓存的使用最后都要归结于SpringCache。

相关概念及注解

名称	解释
@CacheConfig	统一配置本类的缓存注解的属性，定义公共设置，位于class之上
Cache	缓存接口，定义缓存操作。实现有：RedisCache、EhCacheCache、ConcurrentMapCache等
CacheManager	缓存管理器，管理各种缓存（cache）组件
@Caching	组合定义多种缓存功能
@Cacheable	定义缓存，用于触发缓存，能够根据方法的请求参数对其进行缓存
@CachePut	定义更新缓存，触发缓存更新。 与@Cacheable区别在于是否每次都调用方法，常用于更新
@CacheEvict	定义清除缓存，触发缓存清除
@EnableCaching	开启基于注解的缓存功能
keyGenerator	缓存数据时key生成策略
serialize	缓存数据时value序列化策略

@Cacheable/@CachePut/@CacheEvict 主要的参数：

参数	作用
value	缓存的名称，在 spring 配置文件中定义，必须指定至少一个。 例如：@Cacheable(value=”mycache”) 或者@Cacheable(value={”cache1”,”cache2”}
cacheNames	数组，通过数组的方式可以指定多个缓存
key	缓存的 key， 用来指定对应的缓存，可以为空，如果指定要按照 SpEL 表达式编写。默认使用方法所有的参数值作为key的值。也可以使用SpEL表达式的值来指定
condition	缓存的条件，，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才进行缓存/清除缓存。 例如：@Cacheable(value=”mycache”,condition=”#username.length()>6”)
keyGenerator	用来自定义key的生成策略
cacheManager	指定缓存管理器
unless(除非)	当这个条件为true的时候，方法的返回值就不会被缓存
sync	是否异步，当其值为true的时候，unless属性不能使用

下面两个是@CacheEvict专用的：

参数	作用
allEntries	是否清空所有缓存内容，缺省为 false，如果指定为 true，则方法调用后将立即清空所有缓存。 例如：@CachEvict(value=”mycache”,allEntries=true)
beforeInvocation	是否在方法执行前就清空，缺省为 false，如果指定为 true，则在方法还没有执行的时候就清空缓存。默认如果方法执行抛出异常，则不会清空缓存。 例如：@CachEvict(value=”mycache”，beforeInvocation=true)

key所支持的SpEL表达式：

名称	位置	描述	示例
methodName	root对象	当前被调用的方法名	#root.methodname
method	root对象	当前被调用的方法	#root.method.name
target	root对象	当前被调用的目标对象实例	#root.target
targetClass	root对象	当前被调用的目标对象的类	#root.targetClass
args	root对象	当前被调用的方法的参数列表	#root.args[0]
caches	root对象	当前方法调用使用的缓存列表	#root.caches[0].name
Argument Name	执行上下文	当前被调用的方法的参数，如findArtisan(Artisan artisan),可以通过#artsian.id获得参数	#artsian.id
result	执行上下文	方法执行后的返回值（仅当方法执行后的判断有效，如 unless cacheEvict的beforeInvocation=false）	#result

SpEL支持的运算符

类型	运算符
关系	，=，==，!=，lt，gt，le，ge，eq，ne
算术	+，- ，* ，/，%，^
逻辑	&&，
条件	?: (ternary)，?: (elvis)
正则表达式	matches
其他类型	?.，?[…]，![…]，1，$[…]

注意：

• 当使用root对象的属性作为key时可以将#root省略，因为Spring默认使用的就是root对象的属性。 比如：
  @Cacheable(key = “targetClass + methodName +#p0”)
• 使用方法参数时可以直接使用“#参数名”或者“#p参数index”。 如：
  @Cacheable(value=“users”, key="#id")
  @Cacheable(value=“users”, key="#p0")

示例：keyGenerator-key的生成器

绝大多数情况下建议使用keyGenerator，编译过程中可能会解析不到参数名，导致缓存时key拼接错误。

@Component
public class RedisDeptConfig {
    /**
     * 缓存键自动生成器
     *
     * @return
     */
    @Bean(name = "deptKeyGen")
    public KeyGenerator keyGenerator() { //设置自定义key{ClassName + methodName + params}
        return (target, method, params) -> {
            String funName = method.getName();
            StringBuilder sb = new StringBuilder();
            sb.append(target.getClass().getName());
            sb.append(".");
            sb.append(funName);
            sb.append("(");
            for (int i = 0; i