#spring boot 3 -- cache

EHcache

引入：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>

在Spring Boot主類中增加@EnableCaching註解開啓緩存功能
在數據訪問接口中，增加緩存配置註解

@CacheConfig(cacheNames = "users")
public interface UserRepository extends JpaRepository<User, Long> {
    @Cacheable
    User findByName(String name);
}

Cache註解詳解

@CacheConfig：主要用於配置該類中會用到的一些共用的緩存配置。在這裏@CacheConfig(cacheNames = “users”)：配置了該數據訪問對象中返回的內容將存儲於名爲users的緩存對象中，我們也可以不使用該註解，直接通過@Cacheable自己配置緩存集的名字來定義。

@Cacheable：配置了findByName函數的返回值將被加入緩存。同時在查詢時，會先從緩存中獲取，若不存在纔再發起對數據庫的訪問。該註解主要有下面幾個參數：

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的時候纔會被緩存，若做此配置上面的AAA用戶就不會被緩存，讀者可自行實驗嘗試。

unless：另外一個緩存條件參數，非必需，需使用SpEL表達式。它不同於condition參數的地方在於它的判斷時機，該條件是在函數被調用之後才做判斷的，所以它可以通過對result進行判斷。
keyGenerator：用於指定key生成器，非必需。若需要指定一個自定義的key生成器，我們需要去實現org.springframework.cache.interceptor.KeyGenerator接口，並使用該參數來指定。需要注意的是：該參數與key是互斥的
cacheManager：用於指定使用哪個緩存管理器，非必需。只有當有多個時才需要使用

cacheResolver：用於指定使用那個緩存解析器，非必需。需通過org.springframework.cache.interceptor.CacheResolver接口來實現自己的緩存解析器，並用該參數指定。

除了這裏用到的兩個註解之外，還有下面幾個核心註解：

@CachePut：配置於函數上，能夠根據參數定義條件來進行緩存，它與@Cacheable不同的是，它每次都會真是調用函數，所以主要用於數據新增和修改操作上。它的參數與@Cacheable類似，具體功能可參考上面對@Cacheable參數的解析
@CacheEvict：配置於函數上，通常用在刪除方法上，用來從緩存中移除相應數據。除了同@Cacheable一樣的參數之外，它還有下面兩個參數：
allEntries：非必需，默認爲false。當爲true時，會移除所有數據
beforeInvocation：非必需，默認爲false，會在調用方法之後移除數據。當爲true時，會在調用方法之前移除數據

緩存配置

完成了上面的緩存實驗之後，可能大家會問，那我們在Spring Boot中到底使用了什麼緩存呢？

在Spring Boot中通過@EnableCaching註解自動化配置合適的緩存管理器（CacheManager），Spring Boot根據下面的順序去偵測緩存提供者：

Generic
JCache (JSR-107)
EhCache 2.x
Hazelcast
Infinispan
Redis
Guava
Simple
除了按順序偵測外，我們也可以通過配置屬性spring.cache.type來強制指定。我們可以通過debug調試查看cacheManager對象的實例來判斷當前使用了什麼緩存。

本文中不對所有的緩存做詳細介紹，下面以常用的EhCache爲例，看看如何配置來使用EhCache進行緩存管理。

在Spring Boot中開啓EhCache非常簡單，只需要在工程中加入ehcache.xml配置文件並在pom.xml中增加ehcache依賴，框架只要發現該文件，就會創建EhCache的緩存管理器。

在src/main/resources目錄下創建：ehcache.xml

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="ehcache.xsd">
    <cache name="users"
           maxEntriesLocalHeap="200"
           timeToLiveSeconds="600">
    </cache>
</ehcache>

在pom.xml中加入

<dependency>
    <groupId>net.sf.ehcache</groupId>
    <artifactId>ehcache</artifactId>
</dependency>

完成上面的配置之後，再通過debug模式運行單元測試，觀察此時CacheManager已經是EhCacheManager實例，說明EhCache開啓成功了。

對於EhCache的配置文件也可以通過application.properties文件中使用spring.cache.ehcache.config屬性來指定，比如：

spring.cache.ehcache.config=classpath:config/another-config.xml

RedisCache

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

application.properties中增加redis配置，以本地運行爲例，比如：

spring.redis.host=localhost
spring.redis.port=6379
spring.redis.pool.max-idle=8
spring.redis.pool.min-idle=0
spring.redis.pool.max-active=8
spring.redis.pool.max-wait=-1

我們需要做的配置到這裏就已經完成了，Spring Boot會在偵測到存在Redis的依賴並且Redis的配置是可用的情況下，使用RedisCacheManager初始化CacheManager。

爲此，我們可以單步運行我們的單元測試，可以觀察到此時CacheManager的實例是org.springframework.data.redis.cache.RedisCacheManager

@CacheConfig(cacheNames = "users")
public interface UserRepository extends JpaRepository<User, Long> {
    @Cacheable(key = "#p0")
    User findByName(String name);
    @CachePut(key = "#p0.name")
    User save(User user);
}