一、前言

今天遇到了一個(gè)問(wèn)題，就是關(guān)于@CacheEvict，這個(gè)相信大家都很熟悉了，是Spring整合一些緩存的專用注解，它和@Cacheable是一對(duì)。一個(gè)是新增緩存一個(gè)是刪除緩存，搭配使用，不用自己手動(dòng)刪除！

今天遇到的問(wèn)題是，@CacheEvict失效了，不會(huì)刪除redis緩存。有兩個(gè)方法都用了，一個(gè)會(huì)刪除，一個(gè)不會(huì)刪除。直接懵逼，隨后和同事一起打斷點(diǎn)發(fā)現(xiàn)了問(wèn)題所在，其實(shí)還是自己沒(méi)有看@CacheEvict注解的文檔！

「是因?yàn)閗ey的沒(méi)有匹配上，我的方法參數(shù)有兩個(gè)參數(shù)，并且沒(méi)有指定key這樣就匹配不到，無(wú)法刪除！」

key注解注釋：

默認(rèn)值為 ""，表示除非設(shè)置了自定義 keyGenerator ，否則所有方法參數(shù)都被視為鍵。

如果看了注釋也不會(huì)浪費(fèi)時(shí)間去找答案，但是查找問(wèn)題的思路大家可以參考一下，我們也可以看看源碼里面是怎么實(shí)現(xiàn)的！

二、找錯(cuò)過(guò)程

1、錯(cuò)誤代碼

@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的值，也就是緩存的名稱！

在看注解里的一個(gè)參數(shù)：

boolean allEntries() default false。

其一：我們看到這個(gè)是刪除緩存的所有key，默認(rèn)不開(kāi)啟，「不開(kāi)啟就會(huì)根據(jù)你傳的名稱和key去匹配刪除緩存，然后刪除！」

其二：如果接口是一個(gè)參數(shù)，不會(huì)有問(wèn)題，這個(gè)接口是兩個(gè)參數(shù)；redis默認(rèn)把所有參數(shù)解析為SimpleKey作為key，有兩個(gè)參數(shù)就會(huì)生成：SimpleKey [6267,467]。此時(shí)在去匹配，根本找不到，也就沒(méi)有刪除緩存了！

就是因?yàn)檫@樣才會(huì)刪除失敗，當(dāng)然簡(jiǎn)單粗暴的方式就是把a(bǔ)llEntries = true，這樣就會(huì)拿著緩存名稱把所有key全部刪除，不用在意生成的key了！

這樣太粗暴，我們還是要選擇第二種方式，兩個(gè)參數(shù)及其以上時(shí)或者傳的是對(duì)象時(shí)我們指定需要?jiǎng)h除的key即可！

3、源碼分析

是不是懂了，咱們?cè)賮?lái)debug源碼一下：

源碼類和方法大家可以自行debug一下：org.springframework.cache.interceptor.CacheAspectSupport#performCacheEvict。

第一次沒(méi)有指定key會(huì)生成一個(gè)：

key = generateKey(context, result);得到：key = SimpleKey [6267,467]。

這個(gè)方法里面會(huì)把key和緩存名稱拼接在一起去刪除key：

doEvict(cache, key, operation.isBeforeInvocation())。

拼接key方法：createCacheKey(key)。

我們看一下一個(gè)參數(shù)的時(shí)候，key是怎么生成的：

我們看到一個(gè)參數(shù)的時(shí)候返回的是controller接口的參數(shù)類型，多個(gè)是返回的SimpleKey對(duì)象。

這樣一個(gè)參數(shù)的就可以匹配到指定的key去刪除！

三、解決方案

上面也說(shuō)了，解決方案有兩種：

• @CacheEvict(value = {"warehouse:id"}, allEntries = true)。
• @CacheEvict(value = {"warehouse:id"}, key = "#subWarehouseId")。

這樣就完美解決了，其實(shí)還是沒(méi)有把這個(gè)注解看明白，只知道有這么個(gè)東西可以刪除緩存，出問(wèn)題才發(fā)現(xiàn)。