1. 程式人生 > >Spring Cache常用註解【轉】

Spring Cache常用註解【轉】

ner 頻率 blog https face ict 解析 map let

轉自博客:https://www.cnblogs.com/kingsonfu/p/10409596.html

原文博主:傻不拉幾貓

作參考儲備用

1、@CacheConfig

主要用於配置該類中會用到的一些共用的緩存配置。示例:

@CacheConfig(cacheNames = "users")
public interface UserService {。。。}

配置了該數據訪問對象中返回的內容將存儲於名為users的緩存對象中,我們也可以不使用該註解,直接通過@Cacheable自己配置緩存集的名字來定義。

2、@Cacheable

應用到讀取數據的方法上,即可緩存的方法,如查找方法,先從緩存中讀取,如果沒有再調用相應方法獲取數據,然後把數據添加到緩存中。

該註解主要有下面幾個參數:

  • value、cacheNames:兩個等同的參數(cacheNames為Spring 4新增,作為value的別名),用於指定緩存存儲的集合名。由於Spring 4中新增了@CacheConfig,因此在Spring 3中原本必須有的value屬性,也成為非必需項了
  • key:緩存對象存儲在Map集合中的key值,非必需,缺省按照函數的所有參數組合作為key值,若自己配置需使用SpEL表達式,比如:@Cacheable(key = "#p0"):使用函數第一個參數作為緩存的key值,更多關於SpEL表達式的詳細內容可參考官方文檔
  • condition:緩存對象的條件,非必需,也需使用SpEL表達式,只有滿足表達式條件的內容才會被緩存,比如:@Cacheable(key = "#p0", condition = "#p0.length() < 3"),表示只有當第一個參數的長度小於3的時候才會被緩存。
  • unless:另外一個緩存條件參數,非必需,需使用SpEL表達式。它不同於condition參數的地方在於它的判斷時機,該條件是在函數被調用之後才做判斷的,所以它可以通過對result進行判斷。
  • keyGenerator:用於指定key生成器,非必需。若需要指定一個自定義的key生成器,我們需要去實現org.springframework.cache.interceptor.KeyGenerator接口,並使用該參數來指定。需要註意的是:該參數與key是互斥的
  • cacheManager:用於指定使用哪個緩存管理器,非必需。只有當有多個時才需要使用
  • cacheResolver:用於指定使用那個緩存解析器,非必需。需通過org.springframework.cache.interceptor.CacheResolver接口來實現自己的緩存解析器,並用該參數指定。

示例如下:

@Cacheable(value = "user", key = "#id")
User selectUserById(final Integer id);

3、@CachePut

應用到寫數據的方法上,如新增/修改方法,調用方法時會自動把相應的數據放入緩存,示例如下:

@CachePut(value = "user", key = "#user.id")  
public User save(User user) {  
    users.add(user);  
    return user;  
}  

此時會以user.id做為緩存key,返回結果user做為值,測試過程中發現在修改對象後只將緩存結果移除但key未移除,導致查詢依然使用了緩存而結果為空(不知道啥情況)

@CachePut的參數與@Cacheable類似

4、@CacheEvict

應用到移除數據的方法上,如刪除方法,調用方法時會從緩存中移除相應的數據,示例如下:

@CacheEvict(value = "user", key = "#id")
void delete(final Integer id);

除了同@Cacheable一樣的參數之外,@CacheEvict還有下面兩個參數:

  • allEntries:非必需,默認為false。當為true時,會移除所有數據
  • beforeInvocation:非必需,默認為false,會在調用方法之後移除數據。當為true時,會在調用方法之前移除數據。

5、@Caching

組合多個Cache註解使用。示例:

技術分享圖片
@Caching( 
    put = { 
        @CachePut(value = "user", key = "#user.id"), 
        @CachePut(value = "user", key = "#user.username"), 
        @CachePut(value = "user", key = "#user.age") 
   } 
} 
技術分享圖片

以上是將id-->user;username--->user;age--->user進行緩存。

6、緩存策略

如果緩存滿了,從緩存中移除數據的策略,常見的有FIFO, LRU 、LFU

  • FIFO (First in First Out) 先進先出策略,即先放入緩存的數據先被移除
  • LRU (Least Recently Used) 最久未使用策略, 即使用時間距離現在最久的那個數據被移除
  • LFU (Least Frequently Used) 最少使用策略,即一定時間內使用次數(頻率)最少的那個數據被移除
  • TTL(Time To Live)存活期,即從緩存中創建時間點開始至到期的一個時間段(不管在這個時間段內有沒被訪問過都將過期)
  • TTI (Time To Idle)空閑期,即一個數據多久沒有被訪問就從緩存中移除的時間。

7、附註

通過@EnableCaching註解自動化配置合適的緩存管理器(CacheManager),Spring Boot根據下面的順序去偵測緩存提供者:

  • Generic
  • JCache (JSR-107)
  • EhCache 2.x
  • Hazelcast
  • Infinispan
  • Redis
  • Guava
  • Simple

可以通過配置屬性spring.cache.type來強制指定,即

spring.cache.type = xxx

另外可通過註入cacheManager來調試查看使用哪種類型,進一步熟悉cache

@Autowired
private CacheManager cacheManager;

Spring Cache常用註解【轉】