一、前言
今天遇到了一个问题,就是关于@CacheEvict,这个相信大家都很熟悉了,是Spring整合一些缓存的专用注解,它和@Cacheable是一对。一个是新增缓存一个是删除缓存,搭配使用,不用自己手动删除!
今天遇到的问题是,@CacheEvict失效了,不会删除redis缓存。有两个方法都用了,一个会删除,一个不会删除。直接懵逼,随后和同事一起打断点发现了问题所在,其实还是自己没有看@CacheEvict注解的文档!
「是因为key的没有匹配上,我的方法参数有两个参数,并且没有指定key这样就匹配不到,无法删除!」
key注解注释:
默认值为 "",表示除非设置了自定义 keyGenerator ,否则所有方法参数都被视为键。
如果看了注释也不会浪费时间去找答案,但是查找问题的思路大家可以参考一下,我们也可以看看源码里面是怎么实现的!
二、找错过程
1、错误代码
@CacheEvict(value = {"warehouse:id"})
@GetMapping("/updateSubWarehouse")
public R updateSubWarehouse(@RequestParam("subWarehouseId") Integer subWarehouseId, @RequestParam("warehouseId") Integer warehouseId) {
return warehouseService.updateSubWarehouse(subWarehouseId, warehouseId);
}
2、分析原因
我们看到@CacheEvict(value = {"warehouse:id"})只指定了value的值,也就是缓存的名称!
在看注解里的一个参数:
boolean allEntries() default false。
其一:我们看到这个是删除缓存的所有key,默认不开启,「不开启就会根据你传的名称和key去匹配删除缓存,然后删除!」
其二:如果接口是一个参数,不会有问题,这个接口是两个参数;redis默认把所有参数解析为SimpleKey作为key,有两个参数就会生成:SimpleKey [6267,467]。此时在去匹配,根本找不到,也就没有删除缓存了!
就是因为这样才会删除失败,当然简单粗暴的方式就是把allEntries = true,这样就会拿着缓存名称把所有key全部删除,不用在意生成的key了!
这样太粗暴,我们还是要选择第二种方式,两个参数及其以上时或者传的是对象时我们指定需要删除的key即可!
3、源码分析
是不是懂了,咱们再来debug源码一下:
源码类和方法大家可以自行debug一下:org.springframework.cache.interceptor.CacheAspectSupport#performCacheEvict。
第一次没有指定key会生成一个:
key = generateKey(context, result);得到:key = SimpleKey [6267,467]。
这个方法里面会把key和缓存名称拼接在一起去删除key:
doEvict(cache, key, operation.isBeforeInvocation())。
拼接key方法:createCacheKey(key)。
我们看一下一个参数的时候,key是怎么生成的:
我们看到一个参数的时候返回的是controller接口的参数类型,多个是返回的SimpleKey对象。
这样一个参数的就可以匹配到指定的key去删除!
三、解决方案
上面也说了,解决方案有两种:
- @CacheEvict(value = {"warehouse:id"}, allEntries = true)。
- @CacheEvict(value = {"warehouse:id"}, key = "#subWarehouseId")。
这样就完美解决了,其实还是没有把这个注解看明白,只知道有这么个东西可以删除缓存,出问题才发现。