一 點睛

隨著時間的積累，應用的使用使用者不斷增加，資料規模也越來越大，往往資料庫查詢操作會成為影響使用者使用體驗的瓶頸，此時使用快取往往是解決這一問題非常好的手段之一。

Spring 3開始提供了強大的基於註解的快取支援，可以通過註解配置方式低侵入的給原有Spring應用增加快取功能，提高資料訪問效能。

Spring Boot中對於快取的支援，提供了一系列的自動化配置，使我們可以非常方便的使用快取。

下面我們通過一個簡單的例子來展示如何給一個既有應用增加快取功能的。

二 實戰

1 引入依賴

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.21</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <!--引入cache依賴-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-cache</artifactId>
    </dependency>
    <!--引入EhCache快取-->
    <dependency>
        <groupId>net.sf.ehcache</groupId>
        <artifactId>ehcache</artifactId>
    </dependency>
</dependencies>
 

2 資料訪問介面中，增加快取配置註解

package com.didispace.domain;

import org.springframework.cache.annotation.CacheConfig;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.data.jpa.repository.JpaRepository;

//在資料訪問介面中，增加快取配置註解
@CacheConfig(cacheNames = "users")
public interface UserRepository extends JpaRepository<User, Long> {

    @Cacheable(key = "#p0", condition = "#p0.length() < 10")
    User findByName(String name);

}
 

3 實體類

package com.didispace.domain;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

/**
* @author 程式猿DD
* @version 1.0.0
* @date 16/3/21 下午3:35.
* @blog http://blog.didispace.com
*/
@Entity
public class User {

    @Id
    @GeneratedValue
    private Long id;

    @Column(nullable = false)
    private String name;

    @Column(nullable = false)
    private Integer age;

    public User(){}

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

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

}
 

4 啟動類

package com.didispace;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;


@SpringBootApplication
//@EnableCaching註解開啟快取功能
@EnableCaching
public class Application {

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

}

5 application.properties

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

spring.jpa.properties.hibernate.hbm2ddl.auto=create-drop
spring.jpa.properties.hibernate.show_sql=true

6 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>

7 測試類

package com.didispace;

import com.didispace.domain.User;
import com.didispace.domain.UserRepository;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.cache.CacheManager;
import org.springframework.cache.ehcache.EhCacheCacheManager;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;


@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(Application.class)
public class ApplicationTests {

    @Autowired
    private UserRepository userRepository;

    @Autowired
    private CacheManager cacheManager;

    @Before
    public void before() {
        userRepository.save(new User("AAA", 10));
    }

    @Test
    public void test() throws Exception {

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

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

        u1.setAge(20);
        userRepository.save(u1);
        User u3 = userRepository.findByName("AAA");
        System.out.println("第三次查詢：" + u3.getAge());

    }

}

三 測試

在呼叫第二次findByName函式時，沒有再執行select語句，也就直接減少了一次資料庫的讀取操作。

四 實戰說明

1 Cache註解詳解

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

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

1. value、cacheNames：兩個等同的引數（cacheNames為Spring 4新增，作為value的別名），用於指定快取儲存的集合名。由於Spring 4中新增了@CacheConfig，因此在Spring 3中原本必須有的value屬性，也成為非必需項了

2. key：快取物件儲存在Map集合中的key值，非必需，預設按照函式的所有引數組合作為key值，若自己配置需使用SpEL表示式，比如：@Cacheable(key = "#p0")：使用函式第一個引數作為快取的key值

3. condition：快取物件的條件，非必需，也需使用SpEL表示式，只有滿足表示式條件的內容才會被快取，比如：@Cacheable(key = "#p0", condition = "#p0.length() < 3")，表示只有當第一個引數的長度小於3的時候才會被快取，若做此配置上面的AAA使用者就不會被快取，讀者可自行實驗嘗試。

4. unless：另外一個快取條件引數，非必需，需使用SpEL表示式。它不同於condition引數的地方在於它的判斷時機，該條件是在函式被呼叫之後才做判斷的，所以它可以通過對result進行判斷。

5. keyGenerator：用於指定key生成器，非必需。若需要指定一個自定義的key生成器，我們需要去實現org.springframework.cache.interceptor.KeyGenerator介面，並使用該引數來指定。需要注意的是：該引數與key是互斥的

6. cacheManager：用於指定使用哪個快取管理器，非必需。只有當有多個時才需要使用

7. cacheResolver：用於指定使用那個快取解析器，非必需。需通過org.springframework.cache.interceptor.CacheResolver介面來實現自己的快取解析器，並用該引數指定。

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

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

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

1. allEntries：非必需，預設為false。當為true時，會移除所有資料

2. beforeInvocation：非必需，預設為false，會在呼叫方法之後移除資料。當為true時，會在呼叫方法之前移除資料。

2 快取配置

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物件的例項來判斷當前使用了什麼快取。

五 參考