Spring Boot中的緩存支持(一)注解配置與EhCache使用

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

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

快速入門

首先,下載樣例工程chapter3-2-2。本例通過spring-data-jpa實(shí)現(xiàn)了對User用戶表的一些操作,若沒有這個(gè)基礎(chǔ),可以先閱讀《使用Spring-data-jpa簡化數(shù)據(jù)訪問層》一文對數(shù)據(jù)訪問有所基礎(chǔ)。

準(zhǔn)備工作

為了更好的理解緩存,我們先對該工程做一些簡單的改造。

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

  • 修改單元測試ApplicationTests,初始化插入U(xiǎn)ser表一條用戶名為AAA,年齡為10的數(shù)據(jù)。并通過findByName函數(shù)完成兩次查詢。


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

}

  • 執(zhí)行單元測試,我們可以在控制臺中看到下面內(nèi)容。
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

在測試用例執(zhí)行前,插入了一條User記錄。然后每次findByName調(diào)用時(shí),都執(zhí)行了一句select語句來查詢用戶名為AAA的記錄。

引入緩存

  • pom.xml中引入cache依賴,添加如下內(nèi)容:
<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);
    }

}
  • 在數(shù)據(jù)訪問接口中,增加緩存配置注解,如:
@CacheConfig(cacheNames = "users")
public interface UserRepository extends JpaRepository<User, Long> {

    @Cacheable
    User findByName(String name);

}
  • 再來執(zhí)行以下單元測試,可以在控制臺中輸出了下面的內(nèi)容:
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

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

為了可以更好的觀察,緩存的存儲,我們可以在單元測試中注入cacheManager。

@Autowired
private CacheManager cacheManager;

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

Cache注解詳解

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

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

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

  • value、cacheNames:兩個(gè)等同的參數(shù)(cacheNames為Spring 4新增,作為value的別名),用于指定緩存存儲的集合名。由于Spring 4中新增了@CacheConfig,因此在Spring 3中原本必須有的value屬性,也成為非必需項(xiàng)了

  • key:緩存對象存儲在Map集合中的key值,非必需,缺省按照函數(shù)的所有參數(shù)組合作為key值,若自己配置需使用SpEL表達(dá)式,比如:@Cacheable(key = "#p0"):使用函數(shù)第一個(gè)參數(shù)作為緩存的key值,更多關(guān)于SpEL表達(dá)式的詳細(xì)內(nèi)容可參考官方文檔

  • condition:緩存對象的條件,非必需,也需使用SpEL表達(dá)式,只有滿足表達(dá)式條件的內(nèi)容才會被緩存,比如:@Cacheable(key = "#p0", condition = "#p0.length() < 3"),表示只有當(dāng)?shù)谝粋€(gè)參數(shù)的長度小于3的時(shí)候才會被緩存,若做此配置上面的AAA用戶就不會被緩存,讀者可自行實(shí)驗(yàn)嘗試。

  • unless:另外一個(gè)緩存條件參數(shù),非必需,需使用SpEL表達(dá)式。它不同于condition參數(shù)的地方在于它的判斷時(shí)機(jī),該條件是在函數(shù)被調(diào)用之后才做判斷的,所以它可以通過對result進(jìn)行判斷。

  • keyGenerator:用于指定key生成器,非必需。若需要指定一個(gè)自定義的key生成器,我們需要去實(shí)現(xiàn)org.springframework.cache.interceptor.KeyGenerator接口,并使用該參數(shù)來指定。需要注意的是:該參數(shù)與key是互斥的

  • cacheManager:用于指定使用哪個(gè)緩存管理器,非必需。只有當(dāng)有多個(gè)時(shí)才需要使用

  • cacheResolver:用于指定使用那個(gè)緩存解析器,非必需。需通過org.springframework.cache.interceptor.CacheResolver接口來實(shí)現(xiàn)自己的緩存解析器,并用該參數(shù)指定。

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

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

緩存配置

完成了上面的緩存實(shí)驗(yàn)之后,可能大家會問,那我們在Spring Boot中到底使用了什么緩存呢?

在Spring Boot中通過@EnableCaching注解自動(dòng)化配置合適的緩存管理器(CacheManager),Spring Boot根據(jù)下面的順序去偵測緩存提供者:

  • Generic
  • JCache (JSR-107)
  • EhCache 2.x
  • Hazelcast
  • Infinispan
  • Redis
  • Guava
  • Simple

除了按順序偵測外,我們也可以通過配置屬性spring.cache.type來強(qiáng)制指定。我們可以通過debug調(diào)試查看cacheManager對象的實(shí)例來判斷當(dāng)前使用了什么緩存。

本文中不對所有的緩存做詳細(xì)介紹,下面以常用的EhCache為例,看看如何配置來使用EhCache進(jìn)行緩存管理。

在Spring Boot中開啟EhCache非常簡單,只需要在工程中加入ehcache.xml配置文件并在pom.xml中增加ehcache依賴,框架只要發(fā)現(xiàn)該文件,就會創(chuàng)建EhCache的緩存管理器。

  • src/main/resources目錄下創(chuàng)建: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模式運(yùn)行單元測試,觀察此時(shí)CacheManager已經(jīng)是EhCacheManager實(shí)例,說明EhCache開啟成功了。

對于EhCache的配置文件也可以通過application.properties文件中使用spring.cache.ehcache.config屬性來指定,比如:

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

完整示例:Chapter-4-4-1

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,290評論 6 342
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,711評論 19 139
  • spring官方文檔:http://docs.spring.io/spring/docs/current/spri...
    牛馬風(fēng)情閱讀 1,861評論 0 3
  • 前言 Ehcache 是一個(gè)成熟的緩存框架,你可以直接使用它來管理你的緩存。Spring 提供了對緩存功能的抽象:...
    靜默虛空閱讀 2,574評論 3 20
  • 熾烈的陽光奪去人們的膚色拖拉機(jī)的轟鳴聲犁過肥沃的土地留下一道道烙印般的皺紋等待播撒去年剩余的糧食橫跨而過的電線桿壓...
    河島閱讀 483評論 1 1

友情鏈接更多精彩內(nèi)容