@Cacheable缓存注解（以Redis作为缓存）

使用时需要先导入依赖包，

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
            <version>2.1.1.RELEASE</version>
</dependency>

此处注意，导入2.1.3版本的依赖时会报错找不到加载类的错误，尽管在maven官方仓库中包含了2.1.3的依赖信息，所以导入的使用较多的2.1.1依赖。

使用方法

1.@Cacheable

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

所谓键值对缓存key，就是说redis缓存的时候key的生成时如下格式：value::key，例如，指定value为test，key为1，即@Cacheable(value="test",key="1")生成的缓存key值为test::1。

在@Cacheable注解中key的取值也可以使用SpringEL表达式来生成，内部可以嵌套方法的参数信息，例如，

@Cacheable(value = "fuck",key = "#id") 
    public List<String> getPrud(@RequestParam("test") String id){
        System.out.println("如果第二次没有走到这里说明缓存被添加了");
        List<String> list = new ArrayList<>();
        list.add(id);
        list.add("123");
        list.add("123");
        return list;
    }

此处的key值生成就是使用getPrud方法中的id参数生成的，即fuck:: + 参数id，除了这种方法以外还可以使用keyGenerator策略来生成key，即实现KeyGenerator方法，

@Component("myKeyGenerator")
public class MyKeyGenerator implements KeyGenerator {
    @Override
    public Object generate(Object o, Method method, Object... objects) {
        return "";
    }

在此方法中生成的返回值就是最终拼凑起来的test::后面的东西，实现方法之后再需要使用生成策略的方法中使用，

@Cacheable(value = "fuck",keyGenerator = "myKeyGenerator")
    public List<String> getPrud(@RequestParam("test") String id){
        System.out.println("如果第二次没有走到这里说明缓存被添加了");
        List<String> list = new ArrayList<>();
        list.add(id);
        list.add("123");
        list.add("123");
        return list;
    }

此方法的Redis缓存key值会按照fuck:: + myKeyGenerator组件中声明的返回值来生成。

condition属性是用来指定判断条件从而确定是否生成缓存，例如

@Cacheable(value = "fuck",key = "#id",condition="#id%2 == 0")
    public List<String> getPrud(@RequestParam("test") int id){

        System.out.println("如果第二次没有走到这里说明缓存被添加了");
        List<String> list = new ArrayList<>();
        list.add(String.valueOf(id));
        list.add("123");
        list.add("123");
        return list;
    }

在此例子中，如果id%2 == 0判断条件成立的话，将会生成redis缓存，即返回true时生成Redis缓存，如果EL表达式返回false的话则不生成缓存。

注意:使用@Cacheable生成的缓存是不会清除的，同时当redis中已经存在相同的key时，@Cacheable默认不生成缓存，即

@Cacheable(value = "fuck") 
    public List<String> getPrud(@RequestParam("test") String id){
        System.out.println("如果第二次没有走到这里说明缓存被添加了");
        List<String> list = new ArrayList<>();
        list.add(id);
        list.add("123");
        list.add("123");
        return list;
    }

在这段代码中只会生成一个缓存，就是第一次运行程序时生成的fuck::，在第二次运行程序时将不会生成缓存因为Redis中已经生成了该缓存fuck::，程序检查Redis服务器的key，发现已存在key则不生成缓存，同理在@cacheable中加入Key参数也是同样的判断逻辑。

2.@CachePut

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

3.@CacheEvict

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

此注解的使用方法与@Cacheable基本一致，也有三个基本属性，value、key和condition。不同的是在此注解中筛选出来的key值将被清除掉，例如：

@CacheEvict(value = "fuck",key = "1")
    public String test1(){
        return "fuck";
    }

执行这个方法的时候我的redis库中存在三个缓存分别如下所示，

执行完毕之后，结果为，

同时@CacheEvict也有自己的独有的属性操作，

3.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);

   }

 

3.2  beforeInvocation属性

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

   @CacheEvict(value="users", beforeInvocation=true)

   public void delete(Integer id) {

      System.out.println("delete user by id: " + id);

   }

4.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;

   }

5.使用自定义注解

       Spring允许我们在配置可缓存的方法时使用自定义的注解，前提是自定义的注解上必须使用对应的注解进行标注。如我们有如下这么一个使用@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;

   }