Spring缓存的注解关键词解释

Spring缓存的注解关键词解释

@Cacheable支持缓存

　　@Cacheable可以标记在一个方法上，也可以标记在一个类上。

　　　　1.当标记在一个方法上时表示该方法是支持缓存的，当标记在一个类上时则表示该类所有的方法都是支持缓存的。

　　　　2.Spring会在其被调用后将其返回值缓存起来，以保证下次利用同样的参数来执行该方法时可以直接从缓存中获取结果，而不需要再次执行该方法。

　　　　3.Spring在缓存方法的返回值时是以键值对进行缓存的，值就是方法的返回结果，至于键的话，Spring又支持两种策略，默认策略和自定义策略。

　　　　4.当一个支持缓存的方法在对象内部被调用时是不会触发缓存功能的。

@Cacheable可以指定三个属性，value、key和condition：

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

　　在支持Spring Cache的环境下，对于使用@Cacheable标注的方法，Spring在每次执行前都会检查Cache中是否存在相同key的缓存元素，如果存在就不再执行该方法，而是直接从缓存中获取结果进行返回，否则才会执行并将返回结果存入指定的缓存中。

　　@CachePut也可以声明一个方法支持缓存功能。

　　与@Cacheable不同的是使用@CachePut标注的方法在执行前不会去检查缓存中是否存在之前执行过的结果，而是每次都会执行该方法，并将执行结果以键值对的形式存入指定的缓存中。

　　其中参数与@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”)

在方法前面定义，如下所示：

1 @CachePut("users")//每次都会执行方法，并将结果存入指定的缓存中
2 public User find(Integer id) {
3     returnnull;
4 }

@CacheEvict 清除缓存元素

　　@CacheEvict是用来标注在需要清除缓存元素的方法或类上的。

　　当标记在一个类上时表示其中所有的方法的执行都会触发缓存的清除操作。

　　@CacheEvict可以指定的属性有value、key、condition、allEntries和beforeInvocation。其中value、key和condition的语义与@Cacheable对应的属性类似：

　　　　即value表示清除操作是发生在哪些Cache上的（对应Cache的名称）；

　　　　key表示需要清除的是哪个key，如未指定则会使用默认策略生成的key；

　　　　condition表示清除操作发生的条件。

　　　　allEntries表示是否需要清除缓存中的所有元素：

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

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

　　　　beforeInvocation表示在对应方法成功执行之后触发的，即方法如果因为抛出异常而未能成功返回时也不会触发清除操作：

　　　　　　使用beforeInvocation可以改变触发清除操作的时间，当我们指定该属性值为true时，Spring会在调用该方法之前清除缓存中的指定元素。

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

@Caching

　　Caching注解可以让我们在一个方法或者类上同时指定多个Spring Cache相关的注解。

　　其拥有三个属性：cacheable、put和evict，分别用于指定@Cacheable、@CachePut和@CacheEvict。

示例代码如下：

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

补充

@cache（“something");这个相当于save（）操作，@cachePut相当于Update（）操作，只要他标示的方法被调用，那么都会缓存起来，而@cache则是先看下有没已经缓存了，然后再选择是否执行方法。@CacheEvict相当于Delete（）操作。用来清除缓存用的。