SpringBoot - 第二十四章 | 緩存支持註解配置與EhCache使用(一)

隨著時間的積累，應用的使用用戶不斷增加，資料規模也越來越大，往往資料庫查詢操作會成為影響用戶使用體驗的瓶頸，此時使用緩存往往是解決這一問題非常好的手段之一。 Spring 3開始提供了強大的基於註解的緩存支持，可以通過註解配置方式低侵入的給原有Spring應用增加緩存功能，提高資料訪問性能。

在Spring Boot中對於緩存的支持，提供了一系列的自動化配置，使我們可以非常方便的使用緩存。下面我們通過一個簡單的例子來展示，我們是如何給一個既有應用增加緩存功能的。

準備工作

首先，下載範例 chapte14 。範例通過spring-data-jpa 實現了對 Customer 用戶表的一些操作，若沒有這個基礎，可以先閱讀 SpringBoot - 第十四章 | Spring-data-jpa訪問資料庫 一文對資料訪問有所基礎。

為了更好的理解緩存，我們先對該專案做一些簡單的修改。

• application.properties 文件中新增 spring.jpa.properties.hibernate.show_sql=true ，開啟 hibernate 對sql 語句的打印。

1
2
3
4
5
6

spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

spring.jpa.properties.hibernate.show_sql=true

• 修改單元測試ApplicationTests，初始化插入Customer表一條用戶名為AAA，年齡為10的資料。並通過findByName函數完成兩次查詢。

• 執行單元測試，我們可以在控制台中看到下面內容。

  1 2 3 4

  Hibernate: select customer0_.id as id1_0_, customer0_.age as age2_0_, customer0_.create_by as create_b3_0_, customer0_.create_dt as create_d4_0_, customer0_.modify_by as modify_b5_0_, customer0_.modify_dt as modify_d6_0_, customer0_.name as name7_0_ from customer customer0_ where customer0_.name=? 第一次查詢：10 Hibernate: select customer0_.id as id1_0_, customer0_.age as age2_0_, customer0_.create_by as create_b3_0_, customer0_.create_dt as create_d4_0_, customer0_.modify_by as modify_b5_0_, customer0_.modify_dt as modify_d6_0_, customer0_.name as name7_0_ from customer customer0_ where customer0_.name=? 第二次查詢：10

在測試執行前，插入了一條Customer記錄。然後每次findByName執行時，都執行了一句select語句來查詢用戶名為AAA的記錄。

引入緩存

加入pom的依賴

1
2
3
4

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

增加@EnableCaching註解開啟緩存功能

資料訪問接口中，增加緩存配置註解@CacheConfig、@Cacheable

• 再次執行單元測試，我們可以在控制台中看到下面內容。

  1 2 3

  Hibernate: select customer0_.id as id1_0_, customer0_.age as age2_0_, customer0_.create_by as create_b3_0_, customer0_.create_dt as create_d4_0_, customer0_.modify_by as modify_b5_0_, customer0_.modify_dt as modify_d6_0_, customer0_.name as name7_0_ from customer customer0_ where customer0_.name=? 第一次查詢：10 第二次查詢：10

我們可以看到，在執行第二次findByName函數時，沒有再執行select語句，也就直接減少了一次資料庫的讀取操作。

CacheManager

為了可以更好的觀察，緩存的存儲，我們可以在單元測試中註入cacheManager。

使用debug模式運行單元測試，觀察cacheManager中的緩存集 customers 以及其中的 Customer 對象的緩存加深理解。

Cache註解詳解

特別說明我們使用得這兩個註解分別做了什麼事情。

• @CacheConfig：主要用於配置該類中會用到的一些共用的緩存配置。在這裡@CacheConfig(cacheNames = "customers")：配置了該資料訪問對像中返回的內容將存儲於名為customers的緩存對像中，我們也可以不使用該註解，直接通過@Cacheable自己配置緩存集的名字來定義。

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

• @CachePut：配置於函數上，能夠根據參數定義條件來進行緩存，它與@Cacheable不同的是，它每次都會真是執行函數，所以主要用於資料新增和修改操作上。它的參數與@Cacheable類似，具體功能可參考上面對@Cacheable參數的解析

• @CacheEvict：配置於函數上，通常用在刪除方法上，用來從緩存中移除相應資料。除了同@Cacheable一樣的參數之外，它還有下面兩個參數：

緩存配置

完成了上面的緩存實驗之後，可能大家會問，那我們在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的緩存管理器。

建立 ehcache.xml

1
2
3
4
5
6
7
8
9

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="ehcache.xsd">

    <cache name="customers"
           maxEntriesLocalHeap="200"
           timeToLiveSeconds="600">
    </cache>

</ehcache>

加入pom的依賴

1
2
3
4

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

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

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

1

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

註：以上參考了
Jax 的工作紀錄 的 Spring 使用 Cache、整合 Ehcache文章。
oKong 的 SpringBoot | 第十一章：Redis的集成和简单使用文章。
程序猿DD-翟永超 的 Spring Boot中的缓存支持（一）注解配置与EhCache使用 文章。