Spring Boot 2.x基礎(chǔ)教程：進(jìn)程內(nèi)緩存的使用與Cache注解詳解

隨著時(shí)間的積累，應(yīng)用的使用用戶不斷增加，數(shù)據(jù)規(guī)模也越來(lái)越大，往往數(shù)據(jù)庫(kù)查詢操作會(huì)成為影響用戶使用體驗(yàn)的瓶頸，此時(shí)使用緩存往往是解決這一問(wèn)題非常好的手段之一。Spring 3開始提供了強(qiáng)大的基于注解的緩存支持，可以通過(guò)注解配置方式低侵入的給原有Spring應(yīng)用增加緩存功能，提高數(shù)據(jù)訪問(wèn)性能。

在Spring Boot中對(duì)于緩存的支持，提供了一系列的自動(dòng)化配置，使我們可以非常方便的使用緩存。下面我們通過(guò)一個(gè)簡(jiǎn)單的例子來(lái)展示，我們是如何給一個(gè)既有應(yīng)用增加緩存功能的。

快速入門

下面我們將使用使用Spring Data JPA訪問(wèn)MySQL一文的案例為基礎(chǔ)。這個(gè)案例中包含了使用Spring Data JPA訪問(wèn)User數(shù)據(jù)的操作，利用這個(gè)基礎(chǔ)，我們?yōu)槠涮砑泳彺妫瑏?lái)減少對(duì)數(shù)據(jù)庫(kù)的IO，以達(dá)到訪問(wèn)加速的作用。如果您還不熟悉如何實(shí)現(xiàn)對(duì)MySQL的讀寫操作，那么建議先閱讀前文，完成這個(gè)基礎(chǔ)案例的編寫。

先簡(jiǎn)單回顧下這個(gè)案例的基礎(chǔ)內(nèi)容：

User實(shí)體的定義

@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實(shí)體的數(shù)據(jù)訪問(wèn)實(shí)現(xiàn)

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);

}

為了更好的理解緩存，我們先對(duì)該工程做一些簡(jiǎn)單的改造。

  • application.properties文件中新增spring.jpa.show-sql=true，開啟hibernate對(duì)sql語(yǔ)句的打印。如果是1.x版本，使用spring.jpa.properties.hibernate.show_sql=true參數(shù)。
  • 修改單元測(cè)試類，插入U(xiǎn)ser表一條用戶名為AAA，年齡為10的數(shù)據(jù)。并通過(guò)findByName函數(shù)完成兩次查詢，具體代碼如下：
@RunWith(SpringRunner.class)
@SpringBootTest
public class Chapter51ApplicationTests {

    @Autowired
    private UserRepository userRepository;

    @Test
    public void test() throws Exception {
        // 創(chuàng)建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());
    }

}

在沒(méi)有加入緩存之前，我們可以先執(zhí)行一下這個(gè)案例，可以看到如下的日志：

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查詢都執(zhí)行了兩次SQL，都是對(duì)MySQL數(shù)據(jù)庫(kù)的查詢。

引入緩存

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

<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);
    }

}

第三步：在數(shù)據(jù)訪問(wèn)接口中，增加緩存配置注解，如：

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

    @Cacheable
    User findByName(String name);

}

第四步：再來(lái)執(zhí)行以下單元測(cè)試，可以在控制臺(tái)中輸出了下面的內(nèi)容

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

到這里，我們可以看到，在調(diào)用第二次findByName函數(shù)時(shí)，沒(méi)有再執(zhí)行select語(yǔ)句，也就直接減少了一次數(shù)據(jù)庫(kù)的讀取操作。

為了可以更好的觀察，緩存的存儲(chǔ)，我們可以在單元測(cè)試中注入CacheManager。

@Autowired
private CacheManager cacheManager;

使用debug模式運(yùn)行單元測(cè)試，觀察CacheManager中的緩存集users以及其中的User對(duì)象的緩存加深理解。

可以看到，在第一次調(diào)用findByName函數(shù)之后，CacheManager將這個(gè)查詢結(jié)果保存了下來(lái)，所以在第二次訪問(wèn)的時(shí)候，就能匹配上而不需要再訪問(wèn)數(shù)據(jù)庫(kù)了。

Cache配置注解詳解

回過(guò)頭來(lái)我們?cè)賮?lái)看這里使用到的兩個(gè)注解分別作了什么事情：

  • @CacheConfig：主要用于配置該類中會(huì)用到的一些共用的緩存配置。在這里@CacheConfig(cacheNames = "users")：配置了該數(shù)據(jù)訪問(wèn)對(duì)象中返回的內(nèi)容將存儲(chǔ)于名為users的緩存對(duì)象中，我們也可以不使用該注解，直接通過(guò)@Cacheable自己配置緩存集的名字來(lái)定義。
  • @Cacheable：配置了findByName函數(shù)的返回值將被加入緩存。同時(shí)在查詢時(shí)，會(huì)先從緩存中獲取，若不存在才再發(fā)起對(duì)數(shù)據(jù)庫(kù)的訪問(wèn)。該注解主要有下面幾個(gè)參數(shù)：
    • value、cacheNames：兩個(gè)等同的參數(shù)（cacheNames為Spring 4新增，作為value的別名），用于指定緩存存儲(chǔ)的集合名。由于Spring 4中新增了@CacheConfig，因此在Spring 3中原本必須有的value屬性，也成為非必需項(xiàng)了
    • key：緩存對(duì)象存儲(chǔ)在Map集合中的key值，非必需，缺省按照函數(shù)的所有參數(shù)組合作為key值，若自己配置需使用SpEL表達(dá)式，比如：@Cacheable(key = "#p0")：使用函數(shù)第一個(gè)參數(shù)作為緩存的key值，更多關(guān)于SpEL表達(dá)式的詳細(xì)內(nèi)容可參考官方文檔
    • condition：緩存對(duì)象的條件，非必需，也需使用SpEL表達(dá)式，只有滿足表達(dá)式條件的內(nèi)容才會(huì)被緩存，比如：@Cacheable(key = "#p0", condition = "#p0.length() < 3")，表示只有當(dāng)?shù)谝粋€(gè)參數(shù)的長(zhǎng)度小于3的時(shí)候才會(huì)被緩存，若做此配置上面的AAA用戶就不會(huì)被緩存，讀者可自行實(shí)驗(yàn)嘗試。
    • unless：另外一個(gè)緩存條件參數(shù)，非必需，需使用SpEL表達(dá)式。它不同于condition參數(shù)的地方在于它的判斷時(shí)機(jī)，該條件是在函數(shù)被調(diào)用之后才做判斷的，所以它可以通過(guò)對(duì)result進(jìn)行判斷。
    • keyGenerator：用于指定key生成器，非必需。若需要指定一個(gè)自定義的key生成器，我們需要去實(shí)現(xiàn)org.springframework.cache.interceptor.KeyGenerator接口，并使用該參數(shù)來(lái)指定。需要注意的是：該參數(shù)與key是互斥的
    • cacheManager：用于指定使用哪個(gè)緩存管理器，非必需。只有當(dāng)有多個(gè)時(shí)才需要使用
    • cacheResolver：用于指定使用那個(gè)緩存解析器，非必需。需通過(guò)org.springframework.cache.interceptor.CacheResolver接口來(lái)實(shí)現(xiàn)自己的緩存解析器，并用該參數(shù)指定。

除了這里用到的兩個(gè)注解之外，還有下面幾個(gè)核心注解：

  • @CachePut：配置于函數(shù)上，能夠根據(jù)參數(shù)定義條件來(lái)進(jìn)行緩存，它與@Cacheable不同的是，它每次都會(huì)真是調(diào)用函數(shù)，所以主要用于數(shù)據(jù)新增和修改操作上。它的參數(shù)與@Cacheable類似，具體功能可參考上面對(duì)@Cacheable參數(shù)的解析
  • @CacheEvict：配置于函數(shù)上，通常用在刪除方法上，用來(lái)從緩存中移除相應(yīng)數(shù)據(jù)。除了同@Cacheable一樣的參數(shù)之外，它還有下面兩個(gè)參數(shù)：
    • allEntries：非必需，默認(rèn)為false。當(dāng)為true時(shí)，會(huì)移除所有數(shù)據(jù)
    • beforeInvocation：非必需，默認(rèn)為false，會(huì)在調(diào)用方法之后移除數(shù)據(jù)。當(dāng)為true時(shí)，會(huì)在調(diào)用方法之前移除數(shù)據(jù)。

代碼示例

本文的相關(guān)例子可以查看下面?zhèn)}庫(kù)中的chapter5-1目錄：

如果您覺(jué)得本文不錯(cuò)，歡迎Star支持，您的關(guān)注是我堅(jiān)持的動(dòng)力！

本文首發(fā)：Spring Boot 2.x基礎(chǔ)教程：進(jìn)程內(nèi)緩存的使用與Cache注解詳解，轉(zhuǎn)載請(qǐng)注明出處。
歡迎關(guān)注我的公眾號(hào)：程序猿DD，獲得獨(dú)家整理的學(xué)習(xí)資源和日常干貨推送。
如果您對(duì)我的其他專題內(nèi)容感興趣，直達(dá)我的個(gè)人博客：didispace.com。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。