spring框架cacheAnnotation缓存注释声明解析-FinClip官网

spring框架cacheAnnotation缓存注释声明解析

网友投稿 665 2022-12-02

spring框架cacheAnnotation缓存注释声明解析

目录1.基于注释声明缓存1.1@EnableCaching1.2@Cacheable1.2.1默认key生成规则1.2.2声明自定义key 生成1.2.3默认的cache resolution1.2.4同步缓存1.2.5 缓存的条件1.2.6可用的Spel 评估上下文

1.基于注释声明缓存

声明缓存,Spring缓存抽象提供了一个java annotation集合.

@Cacheable:触发缓存填充.

@CacheEvict: 触发缓存删除.

@CachePut: 不干扰方法执行的情况下更新缓存.

@Caching: 把多种缓存操作应用重组到一个方法上

@CacheConfig: 在类上设置,将一些共用缓存相关设置共享

1.1@EnableCaching

将该注解放在配置类上开启缓存,使用该注解后,允许你指定各种选项,通过AOP的方式把这些影响添加到你的应用程序中. 类似于 @Transactional

1.2@Cacheable

触发数据存储于缓存

顾名思义,@Cacheable用于标示可缓存的方法 - 即将结果存储到缓存中的方法,以便在后续调用(具有相同的参数)时,返回缓存中的值而不必实际执行该方法.

下图是所有的缓存的存储结构

cacheNames：指定缓存的名称，不同缓存的数据是彼此隔离的,可以指定多个缓存名称.(就是生成多个缓存name).如果有一个缓存命中,关联值就会返回.

更新一个name的缓存,其他所有没有包含这个值的缓存也会被更新,即使这个缓存方法没有实际调用.

@Cacheable({"coffees","coffees2"})

public List findAllCoffee() {

return coffeeRepository.findAll();

}

1.2.1默认key生成规则

Key :

上面cacheNames指定了缓存名称，但是每个方法由于传参不同，其return数据也会不同，所以一个方法中可能会有多个缓存。要在同一个cacheNames中区别不同的缓存，就需要使用key。通过SPEL表达式,指定 name为key。Spring 会默认以参数为key 如果没有参数则有一个org.springframework.cache.interceptor.SimpleKey.

@Cacheable(cacheNames = "coffees",key = "#name")

public Optional findOneCoffee(String name) {

ExampleMatcher matcher = ExampleMatcher.matching()

.withMatcher("name", exact().ignoreCase());

Optional 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只给方法使用),这一点变得很明显.

@Cacheable("books")