spring cache是一个简单灵活的缓存框架
简单 : 基于注解,在需要缓存的方法上打上注解就可以缓存方法返回值
灵活 : 可自定义键值如何序列化,TTL等,更换缓存只需要注入相应的CacheManager就可以,同时spring已经提供了一些常用的缓存工具(RedisCacheManager,JCacheCacheManager,EhCacheCacheManager)
CacheManager
/** 可以定义多个CacheManager,在使用时进行选择
* 不过需要指定一个默认的,不然启动会报错
* @param redisConnectionFactory
* @return
*/
@Primary
@Bean("permission")
public CacheManager permissionCacheManager(RedisConnectionFactory redisConnectionFactory) {
RedisCacheConfiguration cacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
//前缀处理,也就是指定的缓存名称将以什么姓氏存到redis
.computePrefixWith(cacheName -> "permission" + ":" + cacheName + ":")
//键的序列化
.serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(keySerializer()))
//值的序列化
.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(valueSerializer()))
//是否缓存空值
.disableCachingNullValues()
//过期时间
.entryTtl(Duration.ofDays(1));
return RedisCacheManager.RedisCacheManagerBuilder
.fromCacheWriter(RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory))
.cacheDefaults(cacheConfiguration)
.build();
}
缓存注解
- @Cacheable 最常用的一个,若缓存中没有对应键,则执行方法,并把返回值放入缓存,如果有则从缓存中取,不执行方法
- @CacheEvict 删除缓存
- @CachePut 修改缓存
- @Caching 同时使用上面多个的时候使用
- @CacheConfig 放在类上,可统一指定该类上的其它注解的一些设置(
@Cacheable
@Cacheable与@CachePut注解有相同的字段
如下是一个查找Menu对象的方法
- cacheNames 缓存名称,默认为空串
- cacheManager 指定cacheManager若不指定则使用默认的cacheManager,这里使用了上面定义的 permission
- key 缓存的键,可使用字符串,入参,以及 #root root里有caches,method,args,target,targetClass可供使用
- condition 条件,只用满足条件注解才生效,如下只有参数menuId==2时才生效
- unless 与condition 类似,不过它可以处理返回值,如下只有返回的对象(#result)中的enable属性为1才生效,但是需要注意如果使用返回值中的某一个属性进行比较,但返回值是一个null,就会报错,unless是除非的意思,也就是说当unless中的条件满足时注解不生效
由于指定的permission cacheManager定义了前缀处理,所以存到resis里的键为
permission :Menu: one: selectOne: 2 只有当入参menuId=2并且返回值中的enable不等于1时注解才生效
@Cacheable(
cacheNames = "Menu",
cacheManager = "permission",
key = "'one:'+#root.methodName+':'+#menuId",
unless = "#result.enable == 1",
condition = "#menuId==2")
public Menu selectOne(int menuId) {
Menu menu = menuRepository.findById(menuId).orElse(null);
System.out.println(menu);
return menu;
}
@CacheEvict
有两个特殊的属性
- allEntries=true 删除同一个cache(cacheName相同)下的所有键
- beforeInvocation=true 无论方法有没有执行成功都删除缓存
@CacheEvict(
cacheManager = "permission",
cacheNames = "Menu",
allEntries = true,
beforeInvocation = true)
public void delete(int menuId) {
if (true) {
throw new RuntimeException();
}
menuRepository.deleteById(menuId);
}
@Caching
同时使用多个缓存注解
@Caching(put = @CachePut(key = "#menu.id"),
evict = {@CacheEvict(key = "'all'"),
@CacheEvict(key = "'enabled'", condition = "#menu.enable == 1")})
public Menu save(Menu menu) {
return menuRepository.save(menu);
}
@CacheConfig
放在类上统一类中的其它缓存注解,如下相当于在这个类中的其它所有缓存注解都被默认加上了cacheNames = "Menu",cacheManager = "permission"
@CacheConfig(cacheNames = "Menu", cacheManager = "permission")
public class MenuService {
......
KeyGenerator
某些业务不必每个cache都手动指定key,我们可以定义一定的策略自动生成key, 首先定义一个KeyGenerator放到spring容器中, KeyGenerator接口的generate方法有三个参数,当前对象,注解所在方法,方法的入参,如下定义一个简单的由类名+方法名+入参生成的key
@Bean("myKeyGenerator")
public KeyGenerator menuKeyGenerator() {
return (target, method, params) -> {
String baseName = target.getClass().getSimpleName() + ":" + method.getName();
if (params.length == 0) {
return baseName;
}
baseName = baseName + ":";
for (Object param : params) {
baseName = baseName + param.toString() + ",";
}
return baseName;
};
}
使用 KeyGenerator
注意注解中的KeyGenerator与key是互斥的,两者只能生效一个
@Cacheable(keyGenerator = "myKeyGenerator")
public Menu select(int menuId) {
return menuRepository.findById(menuId).orElse(null);
}
转载请注明出处,谢谢
