1.基于注释声明缓存
声明缓存,Spring缓存抽象提供了一个java annotation集合.
@Cacheable:触发缓存填充.
@CacheEvict: 触发缓存删除.
@CachePut: 不干扰方法执行的情况下更新缓存.
@Caching: 把多种缓存操作应用重组到一个方法上
@CacheConfig: 在类上设置,将一些共用缓存相关设置共享
1.1@EnableCaching
将该注解放在配置类上开启缓存,使用该注解后,允许你指定各种选项,通过AOP的方式把这些影响添加到你的应用程序中. 类似于 @Transactional
1.2@Cacheable
触发数据存储于缓存
顾名思义,@Cacheable用于标示可缓存的方法 - 即将结果存储到缓存中的方法,以便在后续调用(具有相同的参数)时,返回缓存中的值而不必实际执行该方法.
下图是所有的缓存的存储结构
cacheNames：指定缓存的名称，不同缓存的数据是彼此隔离的,可以指定多个缓存名称.(就是生成多个缓存name).如果有一个缓存命中,关联值就会返回.
更新一个name的缓存,其他所有没有包含这个值的缓存也会被更新,即使这个缓存方法没有实际调用.
|
1
2
3
4
5
|
@Cacheable({"coffees","coffees2"})
public List<Coffee> findAllCoffee() {
return coffeeRepository.findAll();
}
|
1.2.1默认key生成规则
Key :
上面cacheNames指定了缓存名称，但是每个方法由于传参不同，其return数据也会不同，所以一个方法中可能会有多个缓存。要在同一个cacheNames中区别不同的缓存，就需要使用key。通过SPEL表达式,指定 name为key。Spring 会默认以参数为key 如果没有参数则有一个org.springframework.cache.interceptor.SimpleKey.
|
1
2
3
4
5
6
7
8
9
|
@Cacheable(cacheNames = "coffees",key = "#name")
public Optional<Coffee> findOneCoffee(String name) {
ExampleMatcher matcher = ExampleMatcher.matching()
.withMatcher("name", exact().ignoreCase());
Optional<Coffee> coffee = coffeeRepository.findOne(
Example.of(Coffee.builder().name(name).build(), matcher));
log.info("Coffee Found: {}", coffee);
return coffee;
}
|
因为Caches是一个key-value的存储形式,每次调用缓存方法需要翻译成对应的key来访问缓存。缓存抽象使用简单的 keygenerator 基于以下算法:
- 如果没有参数,返回SimpleKey.EMPTY.
- 如果只有一个参数,就会作为实例返回.
- 如果超过一个参数,就会返回包含所有参数的 SimpleKey.
该方法对大多数case有效,只要参数有nautral keys并且他们有效的实现了 hashcode()和equals()方法.如果不是这个case的需要去改变策略.
提供不同的key 生成器,需要去实现 org.springframework.cache.interceptor.KeyGenerator 这个接口.
默认的key生成策略在spring 4.0以后有所改变.之前的Spring版本使用用的key生成策略,对于多个key参数,仅用参数的hashCode()没有使用equeal().这可能造成key冲突(从 SPR-10237 查看背景).新的 SimpleKeyGenerator对于这种场景使用了组合key.
如果你想保持之前的key生成策略,你可以配置不推荐使用的org.springframework.cache.interceptor.DefaultKeyGenerator或者创建一个自定义的 基于hash的 key产生的实现
1.2.2声明自定义key 生成
因为缓存是通用的,所以目标方法很可能有多种写法,这些不能够被顶层缓存结构简单的映射.当一个方法有多个参数,但只有一些参数需要缓存时(其他key只给方法使用),这一点变得很明显.
|
1
2
|
@Cacheable("books")
public Book findBook(ISBN isbn, boolean checkWarehouse, boolean includeUsed)
|
上面的例子: 用到了两个布尔参数,他们对缓存可能没有用处,此外如果有一个有用另一个没用应该怎么办?
上面说过我们可以通过@Cacheable 来指定key通过哪些参数生成.可以使用SPEL 来选择感兴趣的参数(以及嵌套属性),执行操作,或者甚至调用任意方法都可以不需要写任何代码或者实现任何接口. 推荐的默认的key 产生方式在上面已经说过,但是默认的策略并不能适应所有的方法.
下面例子使用了多种SPEL语法:
|
1
2
3
4
5
6
|
@Cacheable(cacheNames="books", key="#isbn")
public Book findBook(ISBN isbn, boolean checkWarehouse, boolean includeUsed)
@Cacheable(cacheNames="books", key="#isbn.rawNumber")
public Book findBook(ISBN isbn, boolean checkWarehouse, boolean includeUsed)
@Cacheable(cacheNames="books", key="T(someType).hash(#isbn)")
public Book findBook(ISBN isbn, boolean checkWarehouse, boolean includeUsed)
|
如果生成key的算法太过特殊或者需要共享,可以自定义keyGenerator.
|
1
2
|
@Cacheable(cacheNames="books", keyGenerator="myKeyGenerator")
public Book findBook(ISBN isbn, boolean checkWarehouse, boolean includeUsed)
|
注: key 和 keyGenerator是互斥的,同时指定会产生异常
1.2.3默认的cache resolution
默认的cache resolution是一个简单的 CacheResolver ,通过配置CacheManager来检索在操作级别定义的缓存.
通过继承实现org.springframework.cache.interceptor.CacheResolver 接口来提供不同的默认resolver.
默认的cache resolution是由单个CacheManager实现并且没有太复杂的resolution的需求.
默认的cache resolution是由单个CacheManager实现并且没有太复杂的resolution的需求.
当一个应用同时使用多个 cacheManager 可以通过cachemanager指定
|
1
2
|
@Cacheable(cacheNames="books", cacheManager="anotherCacheManager")
public Book findBook(ISBN isbn) {...}
|
也可以通过cacheResolver替换resolver 类似于替换key generation.
|
1
2
|
@Cacheable(cacheResolver="runtimeCacheResolver")
public Book findBook(ISBN isbn) {...}
|
这个resolution在每次缓存操作都会请求,允许我们基于实时的参数来实现解析缓存.
从spring 4.1之后, value的属性不再强制要求传,因为无论annotation的内容传什么,这个特定信息都会被CacheResolver提供.
类似于key和keygenerator,cacheManager和cahceResolver这两个参数都是互斥的,同时指定会返回异常,因为定义的cacheManager会被定义的cacheResolver的实现给忽略.
1.2.4同步缓存
在多线程环境里,某些操作可能使用相同参数并发调用(典型的例如启动).默认情况下,缓存抽象不会加锁,如果一个同样的值多次被计算是违背缓存的初衷的.
在这种特殊的情况下,可以使用 sync 属性来指定缓存提供方在计算缓存实体的时候加锁.
|
1
2
|
@Cacheable(cacheNames="foos", sync=true)
public Foo executeExpensiveOperation(String id) {...}
|
这个可选特性,也许提供缓存的库并不支持.所有的 核心框架提供得CacheManager是支持的.
1.2.5 缓存的条件
有时,一个方法并不能在所有时候都适用于一个缓存(比如,它可能依赖于给定参数).缓存的注解支持这些情况,通过使用 condition 参数.
condition中使用 Spel 表达式可以得出 true 或者false.如果是true,方法缓存,反之,方法不会缓存(这个方法无论什么值或者使用任何参数都会被调用).
|
1
2
|
@Cacheable(cacheNames="book", condition="#name.length() < 32")
public Book findBook(String name)
|
1.上面设置的条件是name的长度 小于32
|
1
2
|
@Cacheable(cacheNames="book", condition="#name.length() < 32", unless="#result.hardback")
public Book findBook(String name)
|
2.使用unless, 否决掉对应的value到缓存中.不像condition,unless表达式是在方法调用完后被调用,上面的例子就是如果我们只想缓存paperback book, 我们可以阻挡 hardback.
缓存抽象同样支持 java.util.Optional,返回类型.如果Optional是present,则被关联到对应缓存,如果not present,将会存储一个null. #result 总是引用业务对象并且永远不会支持包装器,所以上面的例子可以改为
|
1
2
|
@Cacheable(cacheNames="book", condition="#name.length() < 32", unless="#result?.hardback")
public Optional<Book> findBook(String name)
|
上面的例子 #result一直引用Book 而不是Optional<Book>.因为有可能为空,所以使用SpEL's的Safe Navigation Operator
1.2.6可用的Spel 评估上下文
|
名称 |
位置 |
描述 |
例子 |
|
methodName |
Root object |
被调用方法的名称 |
#root.methodName |
|
method |
Root object |
被调用的方法 |
#root.method.name |
|
target |
Root object |
被调用的目标对象 |
#root.target |
|
targetClass |
Root object |
被调用对象的类 |
#root.targetClass |
|
args |
Root object |
调用的参数数组 |
#root.args[0] |
|
caches |
Root object |
针对当前运行方法的所有缓存 |
#root.caches[0].name |
|
Argument name |
Evaluation context |
任何方法参数的名称.如果名称找不到(也许是没有debug信息),这个参数名称可能在#a<#arg>之下找到, 这个#arg表示参数索引(从0开始) |
#iban or #a0 (you can also use #p0 or #p<#arg> notation as an alias). |
|
result |
Evaluation context |
方法返回调用(值将被缓存).只有在 unless表达式中, cache put表达式(去计算一个key)或者 cache evict 表达式(当 beforeInvocation=false）可用. 为了支持wrappers(比如 Optional),#result 引用的实际的对象而非 wrapper |
#result |
以上就是spring框架cacheAnnotation注释声明缓存解析的详细内容，更多关于spring框架cache缓存Annotation注释的资料请关注服务器之家其它相关文章！
原文链接：https://blog.****.net/FantasyBaby/article/details/120650838