在SpringBoot中主要有以下几种注解:
一.总览
Cache | 缓存接口,定义缓存操作。实现有:RedisCache、EhCacheCache、ConcurrentMapCache等 |
---|---|
CacheManager | 缓存管理器,管理各种缓存(Cache)组件 |
@Cacheable | 主要针对方法配置,能够根据方法的请求参数对其结果进行缓存 |
@CacheEvict | 清空缓存 |
@CachePut | 保证方法被调用,又希望结果被缓存。 |
@EnableCaching | 开启基于注解的缓存,用于Config文件 |
keyGenerator | 缓存数据时key生成策略 |
serialize | 缓存数据时value序列化策略 |
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 | 当前方法调用使用的缓存列表(如@Cacheable(value={"cache1", "cache2"})),则有两个cache | #root.caches[0].name |
argument name | evaluation context | 方法参数的名字. 可以直接 #参数名 ,也可以使用 #p0或#a0 的形式,0代表参数的索引; | #id 、 #a0 、 #p0 |
result | evaluation context | 方法执行后的返回值(仅当方法执行之后的判断有效,如‘unless’,’cache put’的表达式 ’cache evict’的表达式,'cacheable'中不可用’'beforeInvocation=false) | #result |
二.@Cacheable & @CachePut 简介
@Cacheable:是运行了该方法后,下次请求时就请求缓存不再运行方法,主要用于查询。
@CachePut:保证方法每次都被运行,并把结果加入到缓存中,主要用于更新数据。
@Cacheable & @CachePut 可配置的属性一样。关于功能查看源代码英文注解已经写的十分详细,不过这里还是重写编辑转化成自己的语言,为了加深理解印象。
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Cacheable {
/**
* cacheNames/value 指定缓存组件的名字
*/
@AliasFor("cacheNames")
String[] value() default {};
@AliasFor("value")
String[] cacheNames() default {};
/**
* 缓存数据用的key,默认说是利用SpEL把所有方法的参数动态生成一个Key。当然你也可以自己指定
*/
String key() default "";
/**
* 指定key的生成器,可以自己指定key生成器的,与key属性互斥
*/
String keyGenerator() default "";
/**
* 指定缓存管理器,与cacheResolver缓存解析器互斥
*/
String cacheManager() default "";
/**
* 指定缓存解析器。
*/
String cacheResolver() default "";
/**
* 利用SpEL语言,指定符合缓存的条件
*/
String condition() default "";
/**
* condition相当于if,unless相当于if not
*/
String unless() default "";
/**
* 是否使用同步模式。这个设置可以减少对数据库的瞬间并发访问。
* 1.不支持unless
* 2.只能指定一个缓存
* 3.不能组合其他缓存相关操作
* 4.使用之前先确认你使用的缓存支持同步模式,
*/
boolean sync() default false;
}
实验一:替换key
@Cacheable(cacheNames = {"empCache"} ,key = "#root.method+'['+#id+']'")
public Employee getEmp(Integer id) {
System.out.println("查询了");
return mapper.getEmpById(id);
}
实验二:替换Key生成器&添加条件缓存
/**
* @author BaoZhou
* @date 2018/5/30
*/
@Configuration
public class MyKeyGenerateConfig {
@Bean(name = "MyKeyGenerate")
public KeyGenerator myKeyGenerator() {
return (target, method, params) -> method.getName() + "[" + Arrays.asList(params).toString() + "]";
}
}
@Cacheable(cacheNames = {"empCache"} ,keyGenerator = "MyKeyGenerate",condition = "#id>0",unless = "#a0==2")
public Employee getEmp(Integer id) {
System.out.println("查询了");
return mapper.getEmpById(id);
}
实验三:更新缓存
@Service
public class EmployeeService {
@Autowired
private EmployeeMapper mapper;
//保证查询Key和更新Key保持一致
@Cacheable(cacheNames = {"empCache"}, key = "#id")
public Employee getEmp(Integer id) {
System.out.println("查询");
return mapper.getEmpById(id);
}
@CachePut(cacheNames = {"empCache"},key = "#employee.id")
public Employee updateEmp(Employee employee) {
System.out.println("更新");
mapper.updateEmp(employee);
return employee;
}
}
三.@CacheEvict 简介
@CacheEvict主要用于删除缓存
其参数基本与@Cacheable & @CachePut一致,但是有几个特有参数。
- @allEntries:是否删除指定缓存组件下所有的缓存。
- @beforeInvocation:缓存的清楚是否在方法之前执行。假如为True就是假如删除方法出现异常,缓存还是会被清除。假如为False,那么缓存还会保留。
四.@Catching 简介
@Catching: 多个缓存注释的组合注释(不同或相同类型),在有多种缓存需求的时候使用。
示例代码
@Caching(
cacheable = {
@Cacheable(value = "empCache",key = "#lastName")
},
put =
{
@CachePut(value = "empCache",key = "#lastName")
@CachePut(value = "empCache",key = "#result.id")
@CachePut(value = "empCache",key = "#result.email")
}
)
public Employee getEmpByLastName(String lastName)
{
return mapper.getEmpByLastName(lastName);
}
五.@CacheConfig 简介
假如一个功能下,每个缓存操作都要写cacheName,keygenerator那一定是太麻烦了。
@CacheConfig就是为了统一配置而生。只要在你service上统一配置,就一劳永逸了。
@CacheConfig(cacheNames = "cacheNames")
@Service
public class EmployeeService {
...
}
那么有关于缓存的注解以及作用就介绍到这里了。