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

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

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

快速入門

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

準(zhǔn)備工作

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

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

  • 修改單元測試ApplicationTests,初始化插入User表一條用戶名為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)用時赤拒,都執(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ù)時墓造,沒有再執(zhí)行select語句堪伍,也就直接減少了一次數(shù)據(jù)庫的讀取操作。

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

@Autowired
private CacheManager cacheManager;

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

Cache注解詳解

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

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

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

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

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

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

  • unless:另外一個緩存條件參數(shù)艺智,非必需,需使用SpEL表達式圾亏。它不同于condition參數(shù)的地方在于它的判斷時機十拣,該條件是在函數(shù)被調(diào)用之后才做判斷的,所以它可以通過對result進行判斷志鹃。

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

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

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

除了這里用到的兩個注解之外蜕着,還有下面幾個核心注解:

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

緩存配置

完成了上面的緩存實驗之后刊咳,可能大家會問彪见,那我們在Spring Boot中到底使用了什么緩存呢?

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

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

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

本文中不對所有的緩存做詳細介紹浪规,下面以常用的EhCache為例,看看如何配置來使用EhCache進行緩存管理探孝。

在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模式運行單元測試粱腻,觀察此時CacheManager已經(jīng)是EhCacheManager實例庇配,說明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)系作者
  • 序言:七十年代末捞慌,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子柬批,更是在濱河造成了極大的恐慌啸澡,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,858評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件氮帐,死亡現(xiàn)場離奇詭異嗅虏,居然都是意外死亡,警方通過查閱死者的電腦和手機上沐,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,372評論 3 395
  • 文/潘曉璐 我一進店門皮服,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事龄广×蛎校” “怎么了?”我有些...
    開封第一講書人閱讀 165,282評論 0 356
  • 文/不壞的土叔 我叫張陵择同,是天一觀的道長舟铜。 經(jīng)常有香客問我,道長奠衔,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,842評論 1 295
  • 正文 為了忘掉前任塘娶,我火速辦了婚禮归斤,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘刁岸。我一直安慰自己脏里,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,857評論 6 392
  • 文/花漫 我一把揭開白布虹曙。 她就那樣靜靜地躺著迫横,像睡著了一般。 火紅的嫁衣襯著肌膚如雪酝碳。 梳的紋絲不亂的頭發(fā)上矾踱,一...
    開封第一講書人閱讀 51,679評論 1 305
  • 那天,我揣著相機與錄音疏哗,去河邊找鬼呛讲。 笑死,一個胖子當(dāng)著我的面吹牛返奉,可吹牛的內(nèi)容都是我干的贝搁。 我是一名探鬼主播,決...
    沈念sama閱讀 40,406評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼芽偏,長吁一口氣:“原來是場噩夢啊……” “哼雷逆!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起污尉,我...
    開封第一講書人閱讀 39,311評論 0 276
  • 序言:老撾萬榮一對情侶失蹤膀哲,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后十厢,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體等太,經(jīng)...
    沈念sama閱讀 45,767評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,945評論 3 336
  • 正文 我和宋清朗相戀三年蛮放,在試婚紗的時候發(fā)現(xiàn)自己被綠了缩抡。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,090評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖瞻想,靈堂內(nèi)的尸體忽然破棺而出压真,到底是詐尸還是另有隱情,我是刑警寧澤蘑险,帶...
    沈念sama閱讀 35,785評論 5 346
  • 正文 年R本政府宣布滴肿,位于F島的核電站,受9級特大地震影響佃迄,放射性物質(zhì)發(fā)生泄漏泼差。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,420評論 3 331
  • 文/蒙蒙 一呵俏、第九天 我趴在偏房一處隱蔽的房頂上張望堆缘。 院中可真熱鬧,春花似錦普碎、人聲如沸吼肥。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,988評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽缀皱。三九已至,卻和暖如春动猬,著一層夾襖步出監(jiān)牢的瞬間啤斗,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,101評論 1 271
  • 我被黑心中介騙來泰國打工赁咙, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留争占,地道東北人。 一個月前我還...
    沈念sama閱讀 48,298評論 3 372
  • 正文 我出身青樓序目,卻偏偏與公主長得像臂痕,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子猿涨,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,033評論 2 355

推薦閱讀更多精彩內(nèi)容

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