JCache(JSR-107)注解

从4.1版本开始,Spring的缓存抽象完全支持JCache标准(JSR-107)注解:@CacheResult, @CachePut, @CacheRemove, 和@CacheRemoveAll,以及@CacheDefaults, @CacheKey, 和@CacheValue 伴生注解。即使不将您的缓存存储迁移到JSR-107,您也可以使用这些注解。内部实现使用Spring的缓存抽象,并提供符合规范的默认CacheResolverKeyGenerator实现。换句话说,如果您已经在使用Spring的缓存抽象,则无需更改缓存存储(或配置),即可切换到这些标准注解。

功能总结

对于熟悉Spring缓存注解的人来说,下表描述了Spring注解和JSR-107对应注解的主要区别

表1. Spring与JSR-107缓存注解
Spring JSR-107 备注

@Cacheable

@CacheResult

非常相似。@CacheResult可以缓存特定异常,并强制执行方法,而不管缓存的内容。

@CachePut

@CachePut

虽然Spring使用方法调用的结果更新缓存,但JCache要求将其作为用@CacheValue注解的参数传递。由于这种差异,JCache允许在实际方法调用之前或之后更新缓存。

@CacheEvict

@CacheRemove

非常相似。@CacheRemove在方法调用导致异常时支持条件驱逐。

@CacheEvict(allEntries=true)

@CacheRemoveAll

参见@CacheRemove

@CacheConfig

@CacheDefaults

允许您以类似的方式配置相同的概念。

JCache具有javax.cache.annotation.CacheResolver的概念,它与Spring的CacheResolver接口相同,只是JCache只支持单个缓存。默认情况下,简单的实现根据注解中声明的名称检索要使用的缓存。需要注意的是,如果注解中没有指定缓存名称,则会自动生成默认名称。有关更多信息,请参见@CacheResult#cacheName()的javadoc。

CacheResolver实例由CacheResolverFactory检索。可以为每个缓存操作自定义工厂,如下例所示

@CacheResult(cacheNames="books", cacheResolverFactory=MyCacheResolverFactory.class) (1)
public Book findBook(ISBN isbn)
1 自定义此操作的工厂。
对于所有引用的类,Spring都会尝试查找具有给定类型的bean。如果存在多个匹配项,则会创建一个新实例,并且可以使用常规的bean生命周期回调,例如依赖注入。

键由javax.cache.annotation.CacheKeyGenerator生成,其作用与Spring的KeyGenerator相同。默认情况下,所有方法参数都会被考虑在内,除非至少一个参数用@CacheKey进行注解。这与Spring的自定义键生成声明类似。例如,以下操作是相同的,一个使用Spring的抽象,另一个使用JCache

@Cacheable(cacheNames="books", key="#isbn")
public Book findBook(ISBN isbn, boolean checkWarehouse, boolean includeUsed)

@CacheResult(cacheName="books")
public Book findBook(@CacheKey ISBN isbn, boolean checkWarehouse, boolean includeUsed)

您还可以指定操作上的CacheKeyResolver,类似于指定CacheResolverFactory的方式。

JCache可以管理注解方法抛出的异常。这可以阻止缓存的更新,但它也可以将异常缓存为失败的指示器,而不是再次调用方法。假设如果ISBN的结构无效,则会抛出InvalidIsbnNotFoundException。这是一个永久性故障(永远无法使用此参数检索任何书籍)。以下代码会缓存异常,以便使用相同无效ISBN的后续调用直接抛出缓存的异常,而不是再次调用方法

@CacheResult(cacheName="books", exceptionCacheName="failures"
			cachedExceptions = InvalidIsbnNotFoundException.class)
public Book findBook(ISBN isbn)

启用JSR-107支持

您无需执行任何特定操作即可启用JSR-107支持以及Spring的声明式注解支持。如果类路径中同时存在JSR-107 API和spring-context-support模块,则@EnableCachingcache:annotation-driven XML元素会自动启用JCache支持。

根据您的用例,选择权基本上取决于您。您甚至可以通过对某些服务使用JSR-107 API,对其他服务使用Spring自己的注解来混合和匹配服务。但是,如果这些服务影响相同的缓存,则应使用一致且相同的键生成实现。