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

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

快速入門

下面我們將使用 使用Spring Data JPA訪問MySQL 一文的案例爲基礎。這個案例中包含了使用Spring Data JPA訪問User數據的操作，利用這個基礎，我們爲其添加緩存，來減少對數據庫的IO，以達到訪問加速的作用。如果您還不熟悉如何實現對MySQL的讀寫操作，那麼建議先閱讀前文，完成這個基礎案例的編寫。

先簡單回顧下這個案例的基礎內容：

User實體的定義

@Entity
@Data
@NoArgsConstructor
public class User {

    @Id
    @GeneratedValue
    private Long id;

    private String name;
    private Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }
}

User實體的數據訪問實現

public interface UserRepository extends JpaRepository<User, Long> {

    User findByName(String name);

    User findByNameAndAge(String name, Integer age);

    @Query("from User u where u.name=:name")
    User findUser(@Param("name") String name);

}

爲了更好的理解緩存，我們先對該工程做一些簡單的改造。

  • application.properties 文件中新增 spring.jpa.show-sql=true ，開啓hibernate對sql語句的打印。如果是1.x版本，使用 spring.jpa.properties.hibernate.show_sql=true 參數。
  • 修改單元測試類，插入User表一條用戶名爲AAA，年齡爲10的數據。並通過findByName函數完成兩次查詢，具體代碼如下：
@RunWith(SpringRunner.class)
@SpringBootTest
public class Chapter51ApplicationTests {

    @Autowired
    private UserRepository userRepository;

    @Test
    public void test() throws Exception {
        // 創建1條記錄
        userRepository.save(new User("AAA", 10));

        User u1 = userRepository.findByName("AAA");
        System.out.println("第一次查詢：" + u1.getAge());

        User u2 = userRepository.findByName("AAA");
        System.out.println("第二次查詢：" + u2.getAge());
    }

}

在沒有加入緩存之前，我們可以先執行一下這個案例，可以看到如下的日誌：

Hibernate: select user0_.id as id1_0_, user0_.age as age2_0_, user0_.name as name3_0_ from user user0_ where user0_.name=?
第一次查詢：10
Hibernate: select user0_.id as id1_0_, user0_.age as age2_0_, user0_.name as name3_0_ from user user0_ where user0_.name=?
第二次查詢：10

兩次 findByName 查詢都執行了兩次SQL，都是對MySQL數據庫的查詢。

引入緩存

第一步：在 pom.xml 中引入cache依賴，添加如下內容： 

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

第二步：在Spring Boot主類中增加 @EnableCaching 註解開啓緩存功能，如下： 

@EnableCaching
@SpringBootApplication
public class Chapter51Application {

	public static void main(String[] args) {
		SpringApplication.run(Chapter51Application.class, args);
	}

}

第三步：在數據訪問接口中，增加緩存配置註解，如：

@CacheConfig(cacheNames = "users")
public interface UserRepository extends JpaRepository<User, Long> {

    @Cacheable
    User findByName(String name);

}

第四步：再來執行以下單元測試，可以在控制檯中輸出了下面的內容

Hibernate: insert into user (age, name, id) values (?, ?, ?)
Hibernate: select user0_.id as id1_0_, user0_.age as age2_0_, user0_.name as name3_0_ from user user0_ where user0_.name=?
第一次查詢：10
第二次查詢：10

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

爲了可以更好的觀察，緩存的存儲，我們可以在單元測試中注入 CacheManager 。 

@Autowired
private CacheManager cacheManager;

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

可以看到，在第一次調用 findByName 函數之後， CacheManager 將這個查詢結果保存了下來，所以在第二次訪問的時候，就能匹配上而不需要再訪問數據庫了。

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
beforeInvocation

代碼示例

本文的相關例子可以查看下面倉庫中的 chapter5-1 目錄：

如果您覺得本文不錯，歡迎 Star 支持，您的關注是我堅持的動力！

相關文章