spring的redis注解使用@Cacheable、@Cacheput、@CacheEvict

概述

---

  我这里说的是spring的redis注解的使用，其实是spring的cache缓冲机制中的，只不过是缓冲管理使用的是redis，所以这些个注解也就可以为redis服务了。至于怎么配置cache，这个就不是这里说明的范围了，我这里只是简单的说明几个注解的使用。

• @Caching
• @Cacheable
• @Cacheput
• @CacheEvict
• @EnableCaching

  介绍内容包括：

1. 如何为注解缓冲设置有效时间
2. 如何清除指定前缀的注解
3. 如何一起清除多个key的数据
4. 注解的使用

说明

---

  介绍内容过多，所以要分成多篇文档来进行说明，当前文档只进行介绍各个注解的使用。(该内容属于个人理解，如有不当，请各位指出)

一、注解使用

1、@EnableCaching

属性	说明
proxyTargetClass	是否创建基于子类的（CGLIB）代理。（不是标准java接口的代理），默认值是false，并且紧当mode设置为advicemode.proxy才可以使用
mode	这个是模式设置，模式有代理模式和拦截器模式
order	这个属性是用来设置执行顺序的，表示的是当某个连接点有多个通知（通知的概念可以查找拦截器里面的定义）时，当前缓冲注解的执行顺序。

  一般我们使用的时候都是不去配置里面的东西的，直接都是采用的时默认的值，主要就是让它来使能注解的使用。

@Cacheable注解中的condition和unless都是用于控制缓存行为的，但它们在判断缓存时的时机和逻辑上有所不同。
condition：
    判断时机：condition是在方法执行前进行判断的，即在方法体被调用之前。
    作用：condition用于对方法的入参进行判断。如果条件满足（通常为true），那么会尝试从缓存中获取结果。如果缓存中有结果，则直接返回缓存结果；如果缓存中没有结果，则执行方法体，并将结果存入缓存。如果条件不满足（通常为false），则不会尝试从缓存中获取结果，而是直接执行方法体，并且执行结果也不会被放入缓存。
unless：
    判断时机：unless是在方法执行结束后进行判断的，即在方法体已经执行完毕并有了返回值之后。
    作用：unless用于对方法的出参进行判断。如果条件满足（通常为true），则不会将方法执行的结果存入缓存；如果条件不满足（通常为false），则会将结果存入缓存。
综上所述，condition和unless的主要区别在于它们判断缓存的时机和依据。condition是在方法执行前根据入参来判断是否进行缓存，而unless是在方法执行后根据出参来判断是否将结果存入缓存。两者结合使用，可以更加灵活地控制缓存行为，以适应不同的业务需求。
需要注意的是，condition和unless的条件表达式通常使用Spring Expression Language (SpEL)来编写，可以方便地引用方法的参数和返回值。然而，在使用condition时，需要特别注意不能使用#result，因为这是在方法执行后才有的值，而在condition进行判断时，方法还没有执行，所以会造成SpEL解析错误。

2、@Cacheable

属性	说明
value	缓冲名称；可以用户确定目标缓冲，与指定bean定义的限定符的值或者bean名称相匹配。根据这个特性，我们就可以设置一些策略，对不同的缓冲对象设置各自的缓冲方式。（为缓冲注解设置缓冲有效时间就是使用这个特性做的一个策略）
cacheNames	和value是一样的，它们两个互为别名
key	这个是key键，只不过这里是spring表达式语言（spel），默认值是‘’（spel表达式将大大方便key值得设置）。如果设置了keyGenerator属性，这个属性将会失效。
keyGenerator	自定义键值生成器对象的名称，相当于自己定义一个redis键的解析器
cacheManager	这里是设置缓冲管理器的。不设置采用默认定义的缓冲管理器；这里我们可以自己顶一个多个缓冲管理器，然后在缓冲指定数据的时候可以使用指定的缓冲管理器。
cacheResolver	自定义缓冲解析程序
condition	缓冲条件，采用spring表达式语言（spel）。默认值是‘’，表示直接缓冲。条件为true时进行缓冲，false不缓冲
unless	spring表达式语言（spel）用于否决方法缓存的表达式。与condition（）不同，此表达式在调用方法后计算，因此可以引 用结果。true不缓冲，false缓冲，其实和condition正好相反
sync	如果多个线程试图加载同一个键的值，则同步底层方法的调用。同步会导致一些限制： unless() 不受支持 只能指定一个缓存 不能组合其他与缓存相关的操作

  这个注解时用来充缓冲中提取数据的，如果提取不到数据就会执行后面的方法，然后讲方法返回的结果保存到redis中。

3、@Cacheput

属性	说明
value	缓冲名称；可以用户确定目标缓冲，与指定bean定义的限定符的值或者bean名称相匹配。根据这个特性，我们就可以设置一些策略，对不同的缓冲对象设置各自的缓冲方式。（为缓冲注解设置缓冲有效时间就是使用这个特性做的一个策略）
cacheNames	和value是一样的，它们两个互为别名
key	这个是key键，只不过这里是spring表达式语言（spel），默认值是‘’（spel表达式将大大方便key值得设置）。如果设置了keyGenerator属性，这个属性将会失效。
keyGenerator	自定义键值生成器对象的名称，相当于自己定义一个redis键的解析器
cacheManager	这里是设置缓冲管理器的。不设置采用默认定义的缓冲管理器；这里我们可以自己顶一个多个缓冲管理器，然后在缓冲指定数据的时候可以使用指定的缓冲管理器。
cacheResolver	自定义缓冲解析程序
condition	缓冲条件，采用spring表达式语言（spel）。默认值是‘’，表示直接缓冲。条件为true时进行缓冲，false不缓冲
unless	spring表达式语言（spel）用于否决方法缓存的表达式。与condition（）不同，此表达式在调用方法后计算，因此可以引 用结果。true不缓冲，false缓冲，其实和condition正好相反

  这个注解只是向缓冲中写入数据。

4、@CacheEvict

属性	说明
value	缓冲名称
cacheNames	和value是一样的，它们两个互为别名
key	这个是key键，只不过这里是spring表达式语言（spel），默认值是‘’（spel表达式将大大方便key值得设置）。如果设置了keyGenerator属性，这个属性将会失效。
keyGenerator	自定义键值生成器对象的名称，相当于自己定义一个redis键的解析器
cacheManager	这里是设置缓冲管理器的。不设置采用默认定义的缓冲管理器；这里我们可以自己顶一个多个缓冲管理器，然后在缓冲指定数据的时候可以使用指定的缓冲管理器。
cacheResolver	自定义缓冲解析程序
condition	缓冲条件，采用spring表达式语言（spel）。默认值是‘’，表示直接缓冲。条件为true时进行缓冲，false不缓冲
allEntries	是否清除缓冲中的所有数据。如果这个值设置为true，那么key的设置将失去意义（因为所有数据都会被删除），所以true的情况下就不要设置key属性了。
beforeInvocation	是否在方法执行之前就执行缓冲清除操作。 true 表示，在方法执行前就执行缓冲清除操作。 false 表示在方法执行后执行缓冲清除操作，如果方法执行异常则不进行缓冲清除操作。

  这个注解可以删除缓冲中的数据。

5、@Caching

属性	说明
cacheable	Cacheable注解数组
evict	CacheEvict注解数组
put	Cacheput注解数组

  通过这个注解我们就可以进行批量的操作，批量删除等。

6、@CacheConfig

属性	说明
cacheNames	缓冲名称
cacheManager	这里是设置缓冲管理器的。不设置采用默认定义的缓冲管理器；这里我们可以自己顶一个多个缓冲管理器，然后在缓冲指定数据的时候可以使用指定的缓冲管理器。
keyGenerator	自定义键值生成器对象的名称，相当于自己定义一个redis键的解析器。
cacheResolver	自定义缓冲解析程序。

  这个注解只能作用与类，它的作用时辅助其它的注解，像我们的@Cacheable，@Cacheput，@CacheEvict虽然可以作用与类，但是平时我们都作用于方法，而上面的这4中属性，这些注解也都包含。
  这个时候如果一个类里面方法上的缓冲注解上面4中属性配置一样，我们就可以直接在类上面使用@CacheConfig注解配置好上面4种属性，这样方法中的缓冲注解就不用专门配置这4个属性了。

二、注解设置redis数据有效时间

三、注解上批量操作redis数据

四、使用注解删除指定前缀的redis数据