Spring Boot 2.x基礎教程：進程內緩存的使用與Cache註解詳解

隨着時間的積累，應用的使用用戶不斷增長，數據規模也愈來愈大，每每數據庫查詢操做會成爲影響用戶使用體驗的瓶頸，此時使用緩存每每是解決這一問題很是好的手段之一。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：非必需，默認爲false。當爲true時，會移除全部數據
  • beforeInvocation：非必需，默認爲false，會在調用方法以後移除數據。當爲true時，會在調用方法以前移除數據。

代碼示例

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

• Github：https://github.com/dyc87112/SpringBoot-Learning/
• Gitee：https://gitee.com/didispace/SpringBoot-Learning/

若是您以爲本文不錯，歡迎Star支持，您的關注是我堅持的動力！

本文首發：Spring Boot 2.x基礎教程：進程內緩存的使用與Cache註解詳解，轉載請註明出處。
歡迎關注個人公衆號：程序猿DD，得到獨家整理的學習資源和平常乾貨推送。
若是您對個人其餘專題內容感興趣，直達個人我的博客：didispace.com。