Flask_自定義引數型別（自定義轉換器）
隨著時間的積累，應用的使用使用者不斷增加，資料規模也越來越大，往往資料庫查詢操作會成為影響使用者使用體驗的瓶頸，此時使用快取往往是解決這一問題非常好的手段之一。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")
為了更好的理解快取，我們先對該工程做一些簡單的改造。
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)
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。