Spirng Cache

一.概述

先了解下基础知识

1).了解下基于注释（annotation）的缓存（cache）技术

它本质上不是一个具体的缓存实现方案（例如 EHCache 或者 OSCache），而是一个对缓存使用的抽象，通过在既有代码中添加少量它定义的各种 annotation，即能够达到缓存方法的返回对象的效果。

Spring 的缓存技术还具备相当的灵活性，不仅能够使用 SpEL（Spring Expression Language）来定义缓存的 key 和各种 condition，还提供开箱即用的缓存临时存储方案，也支持和主流的专业缓存例如 EHCache 集成。

其特点总结如下：

  • l 通过少量的配置 annotation 注释即可使得既有代码支持缓存
  • l 支持开箱即用 Out-Of-The-Box，即不用安装和部署额外第三方组件即可使用缓存
  • l 支持 Spring Express Language，能使用对象的任何属性或者方法来定义缓存的 key 和 condition
  • l 支持 AspectJ，并通过其实现任何方法的缓存支持
  • l 支持自定义 key 和自定义缓存管理者，具有相当的灵活性和扩展性

2)对于Spring Cache的基本原理:

spring cache 的关键原理就是 spring AOP，通过 spring AOP，其实现了在方法调用前、调用后获取方法的入参和返回值，进而实现了缓存的逻辑。我们来看一下下面这个图：


图 2. 原始方法调用图

上图显示，当客户端“Calling code”调用一个普通类 Plain Object 的 foo() 方法的时候，是直接作用在 pojo 类自身对象上的，客户端拥有的是被调用者的直接的引用。

而 Spring cache 利用了 Spring AOP 的动态代理技术，即当客户端尝试调用 pojo 的 foo（）方法的时候，给他的不是 pojo 自身的引用，而是一个动态生成的代理类

图 3. 动态代理调用图

如上图所示，这个时候，实际客户端拥有的是一个代理的引用，那么在调用 foo() 方法的时候，会首先调用 proxy 的 foo() 方法，这个时候 proxy 可以整体控制实际的 pojo.foo() 方法的入参和返回值，比如缓存结果，比如直接略过执行实际的 foo() 方法等，都是可以轻松做到的。

3）几个重要的注解

名称解释
Cache 缓存接口，定义缓存操作。实现有：RedisCache、EhCacheCache、ConcurrentMapCache等
CacheManager 缓存管理器，管理各种缓存（cache）组件
@Cacheable 主要针对方法配置，能够根据方法的请求参数对其进行缓存
@CacheEvict 清空缓存
@CachePut 保证方法被调用，又希望结果被缓存。
与@Cacheable区别在于是否每次都调用方法，常用于更新
@EnableCaching 开启基于注解的缓存
keyGenerator 缓存数据时key生成策略
serialize 缓存数据时value序列化策略
@CacheConfig 统一配置本类的缓存注解的属性

二、不使用Spring Cache时的缓存示例

在传统方式下对于缓存的处理代码是非常臃肿的。

　　例如：我们要把一个查询函数加入缓存功能，大致需要三步。

　　　　一、在函数执行前，我们需要先检查缓存中是否存在数据，如果存在则返回缓存数据

　　　　二、如果不存在，就需要在数据库的数据查询出来。

　　　　三、最后把数据存放在缓存中，当下次调用此函数时，就可以直接使用缓存数据，减轻了数据库压力。

　　那么实现上面的三步需要多少代码呢？下面是一个示例：

上图中的红色部分都是模板代码，真正与这个函数有关的代码却只占了1/5，对于所有需要实现缓存功能的函数，都需要加上臃肿的模板代码。可谓是一种极不优雅的解决方案。

　　那么如何让臃肿的代码重回清新的当初呢？

　　AOP不就是专门解决这种模板式代码的最佳方案吗，幸运的是我们不需要再自己实现切面了，SpringCache已经为我们提供好了切面，我们只需要进行简单的配置，就可以重回当初了，像下面这样：

 

三、@Cacheable、@CachePut、@CacheEvict 注释介绍

通过上面的例子，我们可以看到 spring cache 主要使用两个注释标签，即 @Cacheable、@CachePut 和 @CacheEvict，我们总结一下其作用和配置方法。

@Cacheable：

一般用于查询操作，根据key查询缓存. 

    1. 如果key不存在，查询db，并将结果更新到缓存中。
    2. 如果key存在，直接查询缓存中的数据。 

 @Cacheable可以标记在一个方法上，也可以标记在一个类上。当标记在一个方法上时表示该方法是支持缓存的，当标记在一个类上时则表示该类所有的方法都是支持缓存的。对于一个支持缓存的方法，Spring会在其被调用后将其返回值缓存起来，以保证下次利用同样的参数来执行该方法时可以直接从缓存中获取结果，而不需要再次执行该方法。Spring在缓存方法的返回值时是以键值对进行缓存的，值就是方法的返回结果，至于键的话，Spring又支持两种策略，默认策略和自定义策略，这个稍后会进行说明。需要注意的是当一个支持缓存的方法在对象内部被调用时是不会触发缓存功能的。@Cacheable可以指定三个属性，value、key和condition。

表 1. @Cacheable 作用和配置方法
@Cacheable 的作用主要针对方法配置，能够根据方法的请求参数对其结果进行缓存
@Cacheable 主要的参数
value 缓存的名称，在 spring 配置文件中定义，必须指定至少一个 例如：
@Cacheable(value=”mycache”) 或者 
@Cacheable(value={”cache1”,”cache2”}
key 缓存的 key，可以为空，如果指定要按照 SpEL 表达式编写，如果不指定，则缺省按照方法的所有参数进行组合 例如：
@Cacheable(value=”testcache”,key=”#userName”)
condition 缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才进行缓存 例如：
@Cacheable(value=”testcache”,condition=”#userName.length()>2”)

value属性指定Cache名称
       value属性是必须指定的，其表示当前方法的返回值是会被缓存在哪个Cache上的，对应Cache的名称。其可以是一个Cache也可以是多个Cache，当需要指定多个Cache时其是一个数组。

   @Cacheable("cache1")//Cache是发生在cache1上的
   public User find(Integer id) {
      returnnull;
   }
  @Cacheable({"cache1", "cache2"})//Cache是发生在cache1和cache2上的
   public User find(Integer id) {
      returnnull;
   }

使用key属性自定义key

       key属性是用来指定Spring缓存方法的返回结果时对应的key的。该属性支持SpringEL表达式。当我们没有指定该属性时，Spring将使用默认策略生成key。我们这里先来看看自定义策略，至于默认策略会在后文单独介绍。
       自定义策略是指我们可以通过Spring的EL表达式来指定我们的key。这里的EL表达式可以使用方法参数及它们对应的属性。使用方法参数时我们可以直接使用“#参数名”或者“#p参数index”。下面是几个使用参数作为key的示例。

/**
* key 是指传入时的参数
*
*/
   @Cacheable(value="users", key="#id")
   public User find(Integer id) {
      return null;
   }
  // 表示第一个参数
  @Cacheable(value="users", key="#p0")
   public User find(Integer id) {
      return null;
   }
   // 表示User中的id值
   @Cacheable(value="users", key="#user.id")
   public User find(User user) {
      return null;
   }
 // 表示第一个参数里的id属性值
   @Cacheable(value="users", key="#p0.id")
   public User find(User user) {
      return null;
   }

除了上述使用方法参数作为key之外，Spring还为我们提供了一个root对象可以用来生成key。通过该root对象我们可以获取到以下信息。

当我们要使用root对象的属性作为key时我们也可以将“#root”省略，因为Spring默认使用的就是root对象的属性。如：

    // key值为: user中的name属性的值
  @Cacheable(value={"users", "xxx"}, key="caches[1].name")
   public User find(User user) {
      returnnull;
   }

condition属性指定发生的条件
有的时候我们可能并不希望缓存一个方法所有的返回结果。通过condition属性可以实现这一功能。condition属性默认为空，表示将缓存所有的调用情形。其值是通过SpringEL表达式来指定的，当为true时表示进行缓存处理；当为false时表示不进行缓存处理，即每次调用该方法时该方法都会执行一次。如下示例表示只有当user的id为偶数时才会进行缓存。

    // 根据条件判断是否缓存
    @Cacheable(value={"users"}, key="#user.id", condition="#user.id%2==0")
   public User find(User user) {
      System.out.println("find user by user " + user);
      return user;
   }

在支持Spring Cache的环境下，对于使用@Cacheable标注的方法，Spring在每次执行前都会检查Cache中是否存在相同key的缓存元素，如果存在就不再执行该方法，而是直接从缓存中获取结果进行返回，否则才会执行并将返回结果存入指定的缓存中。@CachePut也可以声明一个方法支持缓存功能。与@Cacheable不同的是使用@CachePut标注的方法在执行前不会去检查缓存中是否存在之前执行过的结果，而是每次都会执行该方法，并将执行结果以键值对的形式存入指定的缓存中。

@CachePut

在支持Spring Cache的环境下，对于使用@Cacheable标注的方法，Spring在每次执行前都会检查Cache中是否存在相同key的缓存元素，如果存在就不再执行该方法，而是直接从缓存中获取结果进行返回，否则才会执行并将返回结果存入指定的缓存中。@CachePut也可以声明一个方法支持缓存功能。与@Cacheable不同的是使用@CachePut标注的方法在执行前不会去检查缓存中是否存在之前执行过的结果，而是每次都会执行该方法，并将执行结果以键值对的形式存入指定的缓存中。

表 2. @CachePut 作用和配置方法
@CachePut 的作用主要针对方法配置，能够根据方法的请求参数对其结果进行缓存，和 @Cacheable 不同的是，它每次都会触发真实方法的调用
@CachePut 主要的参数
value 缓存的名称，在 spring 配置文件中定义，必须指定至少一个 例如：
@Cacheable(value=”mycache”) 或者 
@Cacheable(value={”cache1”,”cache2”}
key 缓存的 key，可以为空，如果指定要按照 SpEL 表达式编写，如果不指定，则缺省按照方法的所有参数进行组合 例如：
@Cacheable(value=”testcache”,key=”#userName”)
condition 缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才进行缓存 例如：
@Cacheable(value=”testcache”,condition=”#userName.length()>2”)		 
 //@CachePut也可以标注在类上和方法上。使用@CachePut时我们可以指定的属性跟@Cacheable是一样的。
   @CachePut("users")//每次都会执行方法，并将结果存入指定的缓存中
   public User find(Integer id) {
      returnnull;
   }

@CacheEvict

@CacheEvict是用来标注在需要清除缓存元素的方法或类上的。当标记在一个类上时表示其中所有的方法的执行都会触发缓存的清除操作。@CacheEvict可以指定的属性有value、key、condition、allEntries和beforeInvocation。其中value、key和condition的语义与@Cacheable对应的属性类似。即value表示清除操作是发生在哪些Cache上的（对应Cache的名称）；key表示需要清除的是哪个key，如未指定则会使用默认策略生成的key；condition表示清除操作发生的条件。下面我们来介绍一下新出现的两个属性allEntries和beforeInvocation。

表 3. @CacheEvict 作用和配置方法
@CachEvict 的作用主要针对方法配置，能够根据一定的条件对缓存进行清空
@CacheEvict 主要的参数
value 缓存的名称，在 spring 配置文件中定义，必须指定至少一个 例如：
@CachEvict(value=”mycache”) 或者 
@CachEvict(value={”cache1”,”cache2”}
key 缓存的 key，可以为空，如果指定要按照 SpEL 表达式编写，如果不指定，则缺省按照方法的所有参数进行组合 例如：
@CachEvict(value=”testcache”,key=”#userName”)
condition 缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才清空缓存 例如：
@CachEvict(value=”testcache”,
condition=”#userName.length()>2”)
allEntries 是否清空所有缓存内容，缺省为 false，如果指定为 true，则方法调用后将立即清空所有缓存 例如：
@CachEvict(value=”testcache”,allEntries=true)
beforeInvocation 是否在方法执行前就清空，缺省为 false，如果指定为 true，则在方法还没有执行的时候就清空缓存，缺省情况下，如果方法执行抛出异常，则不会清空缓存 例如：
@CachEvict(value=”testcache”，beforeInvocation=true)

 allEntries属性
      allEntries是boolean类型，表示是否需要清除缓存中的所有元素。默认为false，表示不需要。当指定了allEntries为true时，Spring Cache将忽略指定的key。有的时候我们需要Cache一下清除所有的元素，这比一个一个清除元素更有效率。

   @CacheEvict(value="users", allEntries=true)
   public void delete(Integer id) {
      System.out.println("delete user by id: " + id);
   }

beforeInvocation属性
       清除操作默认是在对应方法成功执行之后触发的，即方法如果因为抛出异常而未能成功返回时也不会触发清除操作。使用beforeInvocation可以改变触发清除操作的时间，当我们指定该属性值为true时，Spring会在调用该方法之前清除缓存中的指定元素。

   @CacheEvict(value="users", beforeInvocation=true)
   public void delete(Integer id) {
      System.out.println("delete user by id: " + id);
   }

其实除了使用@CacheEvict清除缓存元素外，当我们使用Ehcache作为实现时，我们也可以配置Ehcache自身的驱除策略，其是通过Ehcache的配置文件来指定的。由于Ehcache不是本文描述的重点，这里就不多赘述了，想了解更多关于Ehcache的信息，请查看我关于Ehcache的专栏。

@Caching

@Caching注解可以让我们在一个方法或者类上同时指定多个Spring Cache相关的注解。其拥有三个属性：cacheable、put和evict，分别用于指定@Cacheable、@CachePut和@CacheEvict。

   @Caching(cacheable = @Cacheable("users"), evict = { @CacheEvict("cache2"),
   @CacheEvict(value = "cache3", allEntries = true) })
   public User find(Integer id) {
      returnnull;
   }

使用自定义注解

       Spring允许我们在配置可缓存的方法时使用自定义的注解，前提是自定义的注解上必须使用对应的注解进行标注。

示例1：

如我们有如下这么一个使用@Cacheable进行标注的自定义注解。

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Cacheable(value="users")
public @interface MyCacheable {
}

那么在我们需要缓存的方法上使用@MyCacheable进行标注也可以达到同样的效果。

   @MyCacheable
   public User findById(Integer id) {
      System.out.println("find user by id: " + id);
      User user = new User();
      user.setId(id);
      user.setName("Name" + id);
      return user;
   }

 说明

示例2：

如我们有如下这么一个使用@Caching进行标注的自定义注解。

@Caching(
        put = {
                @CachePut(value = "user", key = "\"user_\" + #user.id"),
                @CachePut(value = "user", key = "#user.name"),
                @CachePut(value = "user", key = "#user.account")
        }
)
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface SaveUserInfo {

}

使用如下

@SaveUserInfo
public User saveUserByInfo(User user){
   userMapper.insert(user);
   return user;
}

测试

@Test
public void saveUserByInfoTest(){
   User user = new User();
   user.setName("haha");
   user.setAccount("hhhcc");
   useCacheRedisService.saveUserByInfo(user);
}

redis结果

127.0.0.1:6379> keys *
1) "user_4"
2) "dsjkf"
3) "dkjd"
4) "user~keys"
5) "haha"
6) "hhhcc"
7) "user_3"

Cache* 注解中未提到的元素
  1. keyGenerator: 实现 org.springframework.cache.interceptor.KeyGenerator 接口的类bean,用于统一自定义生成key
  2. cacheManager: 用于选择使用哪个cacheManager
  3. cacheResolver: 实现 org.springframework.cache.interceptor.CacheResolver 接口的类bean，用于自定义如何处理缓存
CacheEvict:
  1. beforeInvocation: bool值，标志是否在调用前就清除缓存。防止方法因为异常意外退出。
Cacheable:
  1. sync: 是否同步  从相同key加载值 的方法,原文为： 
    Synchronize the invocation of the underlying method if several threads are
    * attempting to load a value for the same key
    实际上我并不清楚此功能如何同步的，可能是缓存消失后多线程访问同一个key的方法，只有一个线程实际调用，其他线程等待缓存结果，具体还需要看CacheManager的实现。在此不妄加解释。

Spring提供的核心Cache接口： 

package org.springframework.cache;  
  
public interface Cache {  
    String getName();  //缓存的名字  
    Object getNativeCache(); //得到底层使用的缓存，如Ehcache  
    ValueWrapper get(Object key); //根据key得到一个ValueWrapper，然后调用其get方法获取值  
    <T> T get(Object key, Class<T> type);//根据key，和value的类型直接获取value  
    void put(Object key, Object value);//往缓存放数据  
    void evict(Object key);//从缓存中移除key对应的缓存  
    void clear(); //清空缓存  
  
    interface ValueWrapper { //缓存值的Wrapper  
        Object get(); //得到真实的value  
        }  
}

提供了缓存操作的读取/写入/移除方法； 

默认提供了如下实现：

  • ConcurrentMapCache：使用java.util.concurrent.ConcurrentHashMap实现的Cache；
  • GuavaCache：对Guava com.google.common.cache.Cache进行的Wrapper，需要Google Guava 12.0或更高版本，@since spring 4；
  • EhCacheCache：使用Ehcache实现
  • JCacheCache：对javax.cache.Cache进行的wrapper，@since spring 3.2；spring4将此类更新到JCache 0.11版本； 

另外，因为我们在应用中并不是使用一个Cache，而是多个，因此Spring还提供了CacheManager抽象，用于缓存的管理：  

package org.springframework.cache;  
import java.util.Collection;  
public interface CacheManager {  
    Cache getCache(String name); //根据Cache名字获取Cache   
    Collection<String> getCacheNames(); //得到所有Cache的名字  
}

默认提供的实现： 

  • ConcurrentMapCacheManager/ConcurrentMapCacheFactoryBean：管理ConcurrentMapCache；
  • GuavaCacheManager；
  • EhCacheCacheManager/EhCacheManagerFactoryBean；
  • JCacheCacheManager/JCacheManagerFactoryBean；

 另外还提供了CompositeCacheManager用于组合CacheManager，即可以从多个CacheManager中轮询得到相应的Cache，如

复制代码
<bean id="cacheManager" class="org.springframework.cache.support.CompositeCacheManager">  
    <property name="cacheManagers">  
        <list>  
            <ref bean="ehcacheManager"/>  
            <ref bean="jcacheManager"/>  
        </list>  
    </property>  
    <property name="fallbackToNoOpCache" value="true"/>  
</bean>   
复制代码

当我们调用cacheManager.getCache(cacheName) 时，会先从第一个cacheManager中查找有没有cacheName的cache，如果没有接着查找第二个，如果最后找不到，因为fallbackToNoOpCache=true，那么将返回一个NOP的Cache否则返回null。

除了GuavaCacheManager之外，其他Cache都支持Spring事务的，即如果事务回滚了，Cache的数据也会移除掉。 

Spring不进行Cache的缓存策略的维护，这些都是由底层Cache自己实现，Spring只是提供了一个Wrapper，提供一套对外一致的API。 

四：SpEL上下文数据

Spring Cache提供了一些供我们使用的SpEL上下文数据，下表直接摘自Spring官方文档：

名称位置描述示例
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

注意：

1.当我们要使用root对象的属性作为key时我们也可以将“#root”省略，因为Spring默认使用的就是root对象的属性。 如

@Cacheable(key = "targetClass + methodName +#p0")

2.使用方法参数时我们可以直接使用“#参数名”或者“#p参数index”。 如：

@Cacheable(value="users", key="#id")

@Cacheable(value="users", key="#p0")

SpEL提供了多种运算符

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

五、扩展性

　　上面基本能够满足一般应用对缓存的需求，但现实总是很复杂，当你的用户量上去或者性能跟不上，总需要进行扩展，这个时候你或许对其提供的内存缓存不满意了，因为其不支持高可用性，也不具备持久化数据能力，这个时候，你就需要自定义你的缓存方案了，还好，spring 也想到了这一点。

我们先不考虑如何持久化缓存，毕竟这种第三方的实现方案很多，我们要考虑的是，怎么利用 spring 提供的扩展点实现我们自己的缓存，且在不改原来已有代码的情况下进行扩展。

首先，我们需要提供一个 CacheManager 接口的实现，这个接口告诉 spring 有哪些 cache 实例，spring 会根据 cache 的名字查找 cache 的实例。另外还需要自己实现 Cache 接口，Cache 接口负责实际的缓存逻辑，例如增加键值对、存储、查询和清空等。利用 Cache 接口，我们可以对接任何第三方的缓存系统，例如 EHCache、OSCache，甚至一些内存数据库例如 memcache 或者 h2db 等。下面我举一个简单的例子说明如何做。

六、注意和限制

1、基于 proxy 的 spring aop 带来的内部调用问题

《关于AOP无法切入同类调用方法的问题》

上面介绍过 spring cache 的原理，即它是基于动态生成的 proxy 代理机制来对方法的调用进行切面，这里关键点是对象的引用问题，如果对象的方法是内部调用（即 this 引用）而不是外部引用，则会导致 proxy 失效，那么我们的切面就失效，也就是说上面定义的各种注释包括 @Cacheable、@CachePut 和 @CacheEvict 都会失效，我们来演示一下。

public Account getAccountByName2(String userName) { 
  return this.getAccountByName(userName); 
} 
 
@Cacheable(value="accountCache")// 使用了一个缓存名叫 accountCache 
public Account getAccountByName(String userName) { 
  // 方法内部实现不考虑缓存逻辑，直接实现业务
  return getFromDB(userName); 
}

上面我们定义了一个新的方法 getAccountByName2，其自身调用了 getAccountByName 方法，这个时候，发生的是内部调用（this），所以没有走 proxy，导致 spring cache 失效

 可见，结果是每次都查询数据库，缓存没起作用。要避免这个问题，就是要避免对缓存方法的内部调用，或者避免使用基于 proxy 的 AOP 模式，可以使用基于 aspectJ 的 AOP 模式来解决这个问题。

 2、@CacheEvict 的可靠性问题

我们看到，@CacheEvict 注释有一个属性 beforeInvocation，缺省为 false，即缺省情况下，都是在实际的方法执行完成后，才对缓存进行清空操作。期间如果执行方法出现异常，则会导致缓存清空不被执行。我们演示一下

清单 31. AccountService.java
@CacheEvict(value="accountCache",allEntries=true)// 清空 accountCache 缓存
public void reload() {
  throw new RuntimeException();
}

注意上面的代码，我们在 reload 的时候抛出了运行期异常，这会导致清空缓存失败。

3、非 public 方法问题

和内部调用问题类似，非 public 方法如果想实现基于注释的缓存，必须采用基于 AspectJ 的 AOP 机制。

《关于AOP无法切入同类调用方法的问题》

4、放入缓存的对象，比如 EntityBean，必须 implements Serializable

5、@Cacheable() 的使用

@Cacheable() 是先在缓存中查找，如果没有就执行方法里面的代码，如果找到了，就直接返回 cache 里面的对象

1) 其中value 参数是一个字符串，代表在 redis 里面会建立以这个字符串命名的 set 对象。在srping cache 1.4以后，多了一个 cacheNames ,其实就是 value 的别名。二者等价，建议使用 cacheName。如果不设置，spring 会去类上找 @CacheConfig中指定的 cacheNames.
2) set 值是保存的 cache 中 set 的 key 值，如果不指定，则spring 会把方法所有的参数整理放入。也可以设置为通过 SpEL 指定的返回值。
例如：

在这个例子里面：

@Cacheable() //等价于@Cacheable(key = "#name")
public UserEntity findByName(String name) {...}

表示 会把参数 name的值当做 redis 中的 set 的 key 值。代表着如果 name 是“张三”的话，就会产生 set 值是"张三"的一个 UserEntity 的对象（序列化后的）。

在这个例子里面：

@CachePut(key = "#userEntity.name")
public UserEntity update(UserEntity userEntity) throws ServiceException {
    return iUserRepository.save(userEntity);
}

表示会把 参数 userEntity 对象实例中的name 属性值的内容作为 redis 的 set 中的 key 值，然后对这个 key对应的内容进行更新。

3) cache 放置，或者更新的值，就是函数返回的对象序列化后的内容。

6.填坑

a. 为了更有效的对cache 进行管理。尝试把 service 上的注解移到 repository interface 上。

package com.test.repository;

import com.alcor.ril.entity.UserEntity;
import org.springframework.cache.annotation.CacheConfig;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.repository.PagingAndSortingRepository;
import org.springframework.stereotype.Repository;

@Repository("com.alcor.ril.repository.IUserRepository")
@CacheConfig(cacheNames = "spring:cache:UserEntity")
public interface IUserRepository extends JpaRepository<UserEntity, String>, PagingAndSortingRepository<UserEntity, String> {

@Cacheable()
public UserEntity findOne(String name);

@CachePut(key = "#p0.name")
public UserEntity save(UserEntity userEntity);
}

这样 service 中只要调用 repository 中的 findXXX 方法，就会进行缓存管理。调用 update 方法，就会进行缓存更新。

这个时候，如果沿用 service 上使用 #name 作为的写法，就会产生：

Null key returned for cache operation (maybe you are using named params on classes without debug info?

这样的错误。
解决方案：
见上面的代码，使用#p0这样的写法。

【推广】 免费学中医，健康全家人
原文地址：https://www.cnblogs.com/duanxz/p/2767547.html