JCache (JSR-107) Annotations
自 4.1 版本以来,Spring 的缓存抽象完全支持 JCache 标准 (JSR-107) 注解:@CacheResult
、@CachePut
、@CacheRemove
和 @CacheRemoveAll
,以及 @CacheDefaults
、@CacheKey
和 @CacheValue
伙伴。即使不将缓存存储迁移到 JSR-107,您也可以使用这些注释。内部实现使用 Spring 的缓存抽象,并提供与规范兼容的默认 CacheResolver
和 KeyGenerator
实现。换句话说,如果您已经在使用 Spring 的缓存抽象,则可以在不更改缓存存储(或配置)的情况下切换到这些标准注释。
Feature Summary
对于熟悉 Spring 的缓存注释的人来说,下表描述了 Spring 注释与其 JSR-107 对应项之间的主要差异:
Spring | JSR-107 | Remark |
---|---|---|
|
|
非常相似。 |
|
|
当 Spring 使用方法调用的结果更新缓存时,JCache 需要将它作为一个带 |
|
|
非常相似。 |
|
|
See |
|
|
按照类似的方式,可用于配置相同概念。 |
JCache 有 javax.cache.annotation.CacheResolver
的概念,它与 Spring 的 CacheResolver
接口相同,只是 JCache 只支持一个缓存。默认情况下,一个简单的实现基于注释中声明的名称检索要使用的缓存。需要注意的是,如果注释中未指定缓存名称,则会自动生成一个默认名称。有关详细信息,请参阅 @CacheResult#cacheName()
的 Java 文档。
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 的 custom key generation declaration 类似。例如,以下操作是相同的,一个使用 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)