13.2.2 移除缓存条目

@CacheEvict 并不会往缓存中添加任何东西。相反,如果带有 @CacheEvict 注解的方法被调用的话,那么会有一个或更多的条目会在缓存中移除。

那么在什么场景下需要从缓存中移除内容呢?当缓存值不再合法时,我们应该确保将其从缓存中移除,这样的话,后续的缓存命中就不会返回旧的或者已经不存在的值,其中一个这样的场景就是数据被删除掉了。这样的话,SpittleRepository 的 remove() 方法就是使用 @CacheEvict 的绝佳选择:

@CacheEvict("spittleCache")
void remove(long spittlId)

注意:与 @Cacheable 和 @CachePut 不同,@CacheEvict 能够应用在返回值为 void 的方法上,而 @Cacheable 和 @CachePut 需要非 void 的返回值,它将会作为放在缓存中的条目。因为 @CacheEvict 只是将条目从缓存中移除,因此它可以放在任意的方法上,甚至 void 方法。

从这里可以看到,当 remove() 调用时,会从缓存中删除一个条目。被删除条目的 key 与传递进来的 spittleId 参数的值相等。

@CacheEvict 有多个属性,如表 13.4 所示,这些属性会影响到该注解的行为,使其不同于默认的做法。

可以看到,@CacheEvict 的一些属性与 @Cacheable 和 @CachePut 是相同的,另外还有几个新的属性。与 @Cacheable 和 @CachePut 不同,@CacheEvict 并没有提供 unless 属性。

Spring 的缓存注解提供了一种优雅的方式在应用程序的代码中声明缓存规则。但是,Spring 还为缓存提供了 XML 命名空间。在结束对缓存的讨论之前,我们快速地看一下如何以 XML 的形式配置缓存规则。

属性

类型

描述

value

String []

要使用的缓存名称

key

String

SpEL 表达式,用来计算自定义的缓存 key

condition

String

SpEL 表达式,如果得到的值是 false 的话,缓存不会应用到方法调用上

allEntries

boolean

如果为 true 的话,特定缓存的所有条目都会被移除掉

beforeInvocation

boolean

如果为 true 的话,在方法调用之前移除条目。如果为 false(默认值)的话,在方法成功调用之后再移除条目