使用@CacheEvict清除指定下所有緩存

Posted on by

@CacheEvict清除指定下所有緩存

@CacheEvict(cacheNames = "parts:grid",allEntries = true)

此註解會清除part:grid下所有緩存

@CacheEvict要求指定一個或多個緩存，使之都受影響。此外，還提供瞭一個額外的參數allEntries 。表示是否需要清除緩存中的所有元素。默認為false，表示不需要。

當指定瞭allEntries為true時，Spring Cache將忽略指定的key。有的時候我們需要Cache一下清除所有的元素。

@Cacheable 緩存 @CachePut：緩存更新 @CacheEvict：緩存刪除

@Cacheable 緩存

說明：在支持Spring Cache的環境下，對於使用@Cacheable標註的方法，Spring在每次執行前都會檢查Cache中是否存在相同key的緩存元素，如果存在就不再執行該方法，而是直接從緩存中獲取結果進行返回，否則才會執行並將返回結果存入指定的緩存中。

// @since 3.1  可以標註在方法上、類上  下同
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Cacheable {
    // 緩存名稱  可以寫多個，key的真正組成，以cacheName為前綴，多個就會有多個key產生
    @AliasFor("cacheNames")
    String[] value() default {};
    @AliasFor("value")
    String[] cacheNames() default {};
    // 支持寫SpEL，切可以使用#root，#參數名”或者“#p參數index”
    //詳情去 https://blog.csdn.net/dalong_bamboo/article/details/103844076
    String key() default "";
    // Mutually exclusive：它和key屬性互相排斥。請隻使用一個，直接寫bean的名字就可以
    String keyGenerator() default "";
   //用於選擇使用哪個cacheManager
    String cacheManager() default "";
    //用戶定義如何處理緩存，實現 org.springframework.cache.interceptor.CacheResolver接口
    String cacheResolver() default "";
    // 表示在哪種情況下才緩存結果，可使用SpEL，可以使用#root。  隻有true時，才會作用在這個方法上
    String condition() default "";
    // 表示在哪種情況下不緩存結果，可以寫SpEL #root，並且可以使用#result拿到方法返回值    經典值#result == null
    String unless() default "";
    
    // true：表示強制同步執行。（若多個線程試圖為**同一個鍵**加載值，以同步的方式來進行目標方法的調用）
    // 同步的好處是：後一個線程會讀取到前一個緩存的緩存數據，不用再查庫瞭~~~ 
    // 默認是false，不開啟同步one by one的
    // @since 4.3  註意是sync而不是Async
    // 它的解析依賴於Spring4.3提供的Cache.get(Object key, Callable<T> valueLoader);方法
    boolean sync() default false;
}

@CachePut：緩存更新

說明：@CachePut也可以聲明一個方法支持緩存功能。

與@Cacheable不同的是使用@CachePut標註的方法在執行前不會去檢查緩存中是否存在之前執行過的結果，而是每次都會執行該方法，並將執行結果以鍵值對的形式存入指定的緩存中。

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Cacheable {
 @AliasFor("cacheNames")
 String[] value() default {};
 @AliasFor("value")
 String[] cacheNames() default {};
 // 註意：它和上面區別是。此處key它還能使用#result
 String key() default "";
 String keyGenerator() default "";
 String cacheManager() default "";
 String cacheResolver() default "";
 String condition() default "";
 String unless() default "";
}

@CacheEvict：緩存刪除

說明：@CacheEvict是用來標註在需要清除緩存元素的方法或類上的。當標記在一個類上時表示其中所有的方法的執行都會觸發緩存的清除操作。

@CacheEvict可以指定的屬性有value、key、condition、allEntries和beforeInvocation。其中value、key和condition的語義與@Cacheable對應的屬性類似。

即value表示清除操作是發生在哪些Cache上的（對應Cache的名稱）；key表示需要清除的是哪個key，如未指定則會使用默認策略生成的key；condition表示清除操作發生的條件。

下面我們來介紹一下新出現的兩個屬性allEntries和beforeInvocation。

allEntries屬性，allEntries是boolean類型，表示是否需要清除緩存中的所有元素。

默認為false，表示不需要。當指定瞭allEntries為true時，Spring Cache將忽略指定的key。

有的時候我們需要Cache一下清除所有的元素，這比一個一個清除元素更有效率。

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Cacheable {
 @AliasFor("cacheNames")
 String[] value() default {};
 @AliasFor("value")
 String[] cacheNames() default {};
 // 它也能使用#result
 String key() default "";
 String keyGenerator() default "";
 String cacheManager() default "";
 String cacheResolver() default "";
 String condition() default "";
 // 是否把上面cacheNames指定的所有的緩存都清除掉，默認false
 boolean allEntries() default false;
 // 是否讓清理緩存動作在目標方法之前執行，默認是false（在目標方法之後執行）
 // 註意：若在之後執行的話，目標方法一旦拋出異常瞭，那緩存就清理不掉瞭~~~~
 boolean beforeInvocation() default false;
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：