Spring Boot教程（一）註解配置與EhCache使用

快速入門

首先，下載樣例工程chapter3-2-2。本例經過spring-data-jpa實現了對User用戶表的一些操做，若沒有這個基礎，能夠先閱讀《使用Spring-data-jpa簡化數據訪問層》一文對數據訪問有所基礎。

準備工做

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

• application.properties文件中新增spring.jpa.properties.hibernate.show_sql=true，開啓hibernate對sql語句的打印

• 修改單元測試ApplicationTests，初始化插入User表一條用戶名爲AAA，年齡爲10的數據。並經過findByName函數完成兩次查詢。

  @RunWith(SpringJUnit4ClassRunner.class)
  @SpringApplicationConfiguration(Application.class)
  public class ApplicationTests {
  
  	@Autowired
  	private UserRepository userRepository;
  
  	@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());
  	}
  
  }

   

• 執行單元測試，咱們能夠在控制檯中看到下面內容。

  Hibernate: insert into user (age, name) 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
  Hibernate: select user0_.id as id1_0_, user0_.age as age2_0_, user0_.name as name3_0_ from user user0_ where user0_.name=?
  第二次查詢：10

  在測試用例執行前，插入了一條User記錄。而後每次findByName調用時，都執行了一句select語句來查詢用戶名爲AAA的記錄。

  引入緩存

• 在pom.xml中引入cache依賴，添加以下內容：

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

   

• 在Spring Boot主類中增長@EnableCaching註解開啓緩存功能，以下：

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

   

• 在數據訪問接口中，增長緩存配置註解，如：

  @CacheConfig(cacheNames = "users")
  public interface UserRepository extends JpaRepository<User, Long> {
  
      @Cacheable
      User findByName(String name);
  
  }

   

• 再來執行如下單元測試，能夠在控制檯中輸出了下面的內容：

  Hibernate: insert into user (age, name) 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;

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

回過頭來咱們再來看，這裏使用到的兩個註解分別做了什麼事情。

• @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時，會在調用方法以前移除數據。

緩存配置

完成了上面的緩存實驗以後，可能你們會問，那咱們在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對象的實例來判斷當前使用了什麼緩存。

本文中不對全部的緩存作詳細介紹，下面以經常使用的EhCache爲例，看看如何配置來使用EhCache進行緩存管理。

在Spring Boot中開啓EhCache很是簡單，只須要在工程中加入ehcache.xml配置文件並在pom.xml中增長ehcache依賴，框架只要發現該文件，就會建立EhCache的緩存管理器。

• 在src/main/resources目錄下建立：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>

   

• pom.xml中加入

  <dependency>
      <groupId>net.sf.ehcache</groupId>
      <artifactId>ehcache</artifactId>
  </dependency>

  完成上面的配置以後，再經過debug模式運行單元測試，觀察此時CacheManager已是EhCacheManager實例，說明EhCache開啓成功了。

  對於EhCache的配置文件也能夠經過application.properties文件中使用spring.cache.ehcache.config屬性來指定，好比：

  spring.cache.ehcache.config=classpath:config/another-config.xml

  源碼來源