spring與緩存注解,以及encache緩存使用


隨着時間的積累,應用的使用用戶不斷增加,數據規模也越來越大,往往數據庫查詢操作會成為影響用戶使用體驗的瓶頸,此時使用緩存往往是解決這一問題非常好的手段之一。Spring 3開始提供了強大的基於注解的緩存支持,可以通過注解配置方式低侵入的給原有Spring應用增加緩存功能,提高數據訪問性能。

在Spring Boot中對於緩存的支持,提供了一系列的自動化配置,使我們可以非常方便的使用緩存。下面我們通過一個簡單的例子來展示,我們是如何給一個既有應用增加緩存功能的。

快速入門

首先,下載樣例工程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; 

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

Cache注解詳解

回過頭來我們再來看,這里使用到的兩個注解分別作了什么事情。

  • @CacheConfig:主要用於配置該類中會用到的一些共用的緩存配置。在這里@CacheConfig(cacheNames = "users"):配置了該數據訪問對象中返回的內容將存儲於名為users的緩存對象中,我們也可以不使用該注解,直接通過@Cacheable自己配置緩存集的名字來定義。

  • @Cacheable:配置了findByName函數的返回值將被加入緩存。同時在查詢時,會先從緩存中獲取,若不存在才再發起對數據庫的訪問。該注解主要有下面幾個參數:

  • valuecacheNames:兩個等同的參數(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


作者:程序猿DD
鏈接:https://www.jianshu.com/p/64f684bd0ce9
來源:簡書
簡書著作權歸作者所有,任何形式的轉載都請聯系作者獲得授權並注明出處。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM