@Cacheable、@CachePut、@CacheEvict注解简介

短命女 2021-06-11 15:14 815阅读 1赞

## Spring Cache ##

从Spring 3.1开始，Spring引入了对Cache的支持。其使用方法和原理与Spring对事务管理的支持类似。**Spring Cache作用于方法上，其原理是当我们在调用一个缓存方法时会把该方法参数和返回结果作为一个键值对存放在缓存中，等到下次利用同样的参数来调用该方法时将不再执行该方法，而是直接从缓存中获取结果进行返回**。所以在使用Spring Cache的时候我们要保证我们缓存的方法对于相同的方法参数要有相同的返回结果。

Spring对Cache的支持也有**基于注解**和**基于XML配置**两种方式，这里主要讨论基于注解的方式。

## 使用Spring Cache ##

使用Spring Cache需要我们做两件事

> 1.声明某些方法使用缓存  
> 2. 配置Spring对Cache的支持

## 基于注解的支持 ##

Spring为我们提供了几个注解来支持Spring Cache。主要有@Cacheable、@CachePut和@CacheEvict。使用@Cacheable标记的方法在执行后Spring Cache将缓存其返回结果，而使用@CacheEvict标记的方法会在方法执行前或者执行后移除Spring Cache中的某些元素。

**@Cacheable**

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

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

@Cacheable("c1")//Cache是发生在c1上的
    
      public User query(Integer id) {
    
          return null;
     
      }
    
      @Cacheable({"c1", "c2"})//Cache是发生在c1和c2上的
    
      public User query(Integer id) {
    
          return null;
    
      }

**2.使用key属性自定义key**

key属性是用来指定Spring缓存方法的返回结果时对应的key的。该属性支持SpringEL表达式。当我们没有指定该属性时，Spring将使用默认策略生成key。我们这里先来看看自定义策略，至于默认策略会在后文单独介绍。

自定义策略是指我们可以通过Spring的EL表达式来指定我们的key。这里的EL表达式可以使用方法参数及它们对应的属性。使用方法参数时我们可以直接使用“\#参数名”或者“\#p参数index”。

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

**3.condition属性指定发生的条件**

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

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

**@CachePut**

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

//@CachePut也可以标注在类上和方法上。使用@CachePut时我们可以指定的属性跟@Cacheable是一样的。
    
      @CachePut("users")//每次都会执行方法，并将结果存入指定的缓存中
    
      public User query(Integer id) {
    
          return null;
    
      }

**@CacheEvict**

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

**1.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);
    
    }

**2.beforeInvocation属性**

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

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

[Cacheable]: /images/20210607/a87738b4c86a49a291f34701f557ae0a.png