一、前言

今天遇到了一個問題，就是關于@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")。

這樣就完美解決了，其實還是沒有把這個注解看明白，只知道有這么個東西可以刪除緩存，出問題才發現。