使用前需要在启动类上添加一个注解:@EnableCaching
先说一下SpringCache是不支持灵活的缓存时间设置的,但可以自己实现。且不支持集群,因为不是中间件,是缓存到每台机器上,除非所有机器都有缓存。
所以使用场景一般是数据量较小的单机服务。或者对数据一致性要求不高的场景。
1.@Cacheable介绍
@Cacheable(value = CacheConstants.MENU_DETAILS, key = "#roleId + '_menu'", unless = "#result == null")
@Cacheable(value = CacheConstants.TENANT_CACHE, key = "#tenId + '_cache-tenId'", unless = "#result == null")
value:缓存名称,value属性是必须指定的,其表⽰当前⽅法的返回值是会被缓存在哪个Cache上的,对应Cache的名称。
在方法上加上@Cacheable注解就可以启用缓存了,不需要额外的代码。
key:缓存的 key,可以为空,如果指定要按照 SpEL 表达式编写,如果不指定,则缺省按照⽅法的所有参数进⾏组合。一般用查询的参数名+业务描述。用来在对应缓存中找到这条缓存信息。
unless:当⽅法返回空值时,就不会被缓存起来,决定是否要否定⽅法缓存,可以⽤来做条件。
@Cacheable可以标记在⼀个⽅法上,也可以标记在⼀个类上。当标记在⼀个⽅法上时表⽰该⽅法是⽀持缓存的,当标记在⼀个类上时则表⽰该类所有的⽅法都是⽀持缓存的。对于⼀个⽀持缓存的⽅法,Spring会在其被调⽤后将其返回值缓存起来,以保证下次利⽤同样的参数来执⾏该⽅法时可以直接从缓存中获取结果,⽽不需要再次执⾏该⽅法。Spring在缓存⽅法的返回值时是以键值对进⾏缓存的,值就是⽅法的返回结果,也就是cache本身,⾄于键的话,Spring⼜⽀持两种策略,默认策略和⾃定义策略,这个稍后会进⾏说明。需要注意的是当⼀个⽀持缓存的⽅法
在对象内部被调⽤时是不会触发缓存功能的。适用于查询方法。
2.@CachePut
@CachePut也可以声明一个方法支持缓存功能。适用于更新缓存,其实不是更新缓存而是 更新语义的方法,updateXXX。然后需要把更新的对象结果返回。
与 @Cacheable 不同的是使用 @CachePut标注的方法在执行前不会去检查缓存中是否存在之前执行过的结果,而是每次都会执行该方法,并将执行结果以键值对的形式存入指定的缓存中。
使用@CachePut 可以指定的属性跟 @Cacheable 是一样的。执行方法体 - 将结果缓存起来;意义不大
3.@CacheEvict
@CacheEvict 是用来标注在需要清除缓存元素的方法或类上的。当标记在一个类上时表示其中所有的方法的执行都会触发缓存的清除操作。用于删除缓存
@CacheEvict支持的属性额外增加了两个:
1、allEntries:是否需要清除缓存中的所有元素。默认为 false ,表示不需要。当指定了 allEntries 为 true 时,Spring Cache将忽略指定的key,删除缓存中所有键;
2、beforeInvocation: 是否在方法执行成功之后触发键删除操作,默认是在对应方法成功执行之后触发的,若此时方法抛出异常而未能成功返回,不会触发清除操作。指定该属性值为 true 时,Spring会在调用该方法之前清除缓存中的指定元素。
说明:现在spring cache 也可以+redis 实现支持集群环境(需要配置类),但不如直接使用redis