SpringBoot 緩存
在 Spring Boot中逆航,通過(guò)@EnableCaching注解自動(dòng)化配置合適的緩存管理器(CacheManager),Spring Boot根據(jù)下面的順序去偵測(cè)緩存提供者:
- Generic
- JCache (JSR-107)
- EhCache 2.x
- Hazelcast
- Infinispan
- Redis
- Guava
- Simple
關(guān)于 Spring Boot 的緩存機(jī)制:
高速緩存抽象不提供實(shí)際存儲(chǔ),并且依賴于由
org.springframework.cache.Cache
和
org.springframework.cache.CacheManager
接口實(shí)現(xiàn)的抽象。 Spring Boot根據(jù)實(shí)現(xiàn)自動(dòng)配置合適的CacheManager,只要緩存支持通過(guò)@EnableCaching
注釋啟用即可芥颈。
引入依賴
在pom.xml文件中引入以下依賴
<!--開(kāi)啟 cache 緩存-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<!-- ehcache 緩存 -->
<dependency>
<groupId>net.sf.ehcache</groupId>
<artifactId>ehcache</artifactId>
</dependency>
引入配置文件 ehcache.xml
在resource文件夾下創(chuàng)建文件ehcache.xml,并進(jìn)行配置:
<?xml version="1.0" encoding="UTF-8"?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd"
updateCheck="false">
<diskStore path="/data/yogee/ehcache" />
<defaultCache
eternal="false"
maxElementsInMemory="1000"
overflowToDisk="false"
diskPersistent="false"
timeToIdleSeconds="0"
timeToLiveSeconds="600"
memoryStoreEvictionPolicy="LRU" />
<!-- 這里的 users 緩存空間是為了下面的 demo 做準(zhǔn)備 -->
<cache
name="users"
eternal="false"
maxElementsInMemory="100"
overflowToDisk="false"
diskPersistent="false"
timeToIdleSeconds="0"
timeToLiveSeconds="300"
memoryStoreEvictionPolicy="LRU" />
</ehcache>
ehcache.xml 文件配置詳解
- diskStore:為緩存路徑赚抡,ehcache分為內(nèi)存和磁盤(pán)兩級(jí)浇借,此屬性定義磁盤(pán)的緩存位置。
- defaultCache:默認(rèn)緩存策略怕品,當(dāng)ehcache找不到定義的緩存時(shí)妇垢,則使用這個(gè)緩存策略。只能定義一個(gè)肉康。
- name:緩存名稱闯估。
- maxElementsInMemory:緩存最大數(shù)目
- maxElementsOnDisk:硬盤(pán)最大緩存?zhèn)€數(shù)。
- eternal:對(duì)象是否永久有效吼和,一但設(shè)置了涨薪,timeout將不起作用。
- overflowToDisk:是否保存到磁盤(pán)炫乓,當(dāng)系統(tǒng)當(dāng)機(jī)時(shí)
- timeToIdleSeconds:設(shè)置對(duì)象在失效前的允許閑置時(shí)間(單位:秒)刚夺。僅當(dāng)eternal=false對(duì)象不是永久有效時(shí)使用,可選屬性末捣,默認(rèn)值是0侠姑,也就是可閑置時(shí)間無(wú)窮大。
- timeToLiveSeconds:設(shè)置對(duì)象在失效前允許存活時(shí)間(單位:秒)箩做。最大時(shí)間介于創(chuàng)建時(shí)間和失效時(shí)間之間莽红。僅當(dāng)eternal=false對(duì)象不是永久有效時(shí)使用,默認(rèn)是0.,也就是對(duì)象存活時(shí)間無(wú)窮大安吁。
- diskPersistent:是否緩存虛擬機(jī)重啟期數(shù)據(jù) Whether the disk store persists between restarts of the Virtual Machine. The default value is false.diskSpoolBufferSizeMB:這個(gè)參數(shù)設(shè)置DiskStore(磁盤(pán)緩存)的緩存區(qū)大小醉蚁。默認(rèn)是30MB。每個(gè)Cache都應(yīng)該有自己的一個(gè)緩沖區(qū)鬼店。
- diskExpiryThreadIntervalSeconds:磁盤(pán)失效線程運(yùn)行時(shí)間間隔网棍,默認(rèn)是120秒。
- memoryStoreEvictionPolicy:當(dāng)達(dá)到maxElementsInMemory限制時(shí)妇智,Ehcache將會(huì)根據(jù)指定的策略去清理內(nèi)存滥玷。默認(rèn)策略是LRU(最近最少使用)。你可以設(shè)置為FIFO(先進(jìn)先出)或是LFU(較少使用)俘陷。
- clearOnFlush:內(nèi)存數(shù)量最大時(shí)是否清除。
- memoryStoreEvictionPolicy:可選策略有:LRU(最近最少使用观谦,默認(rèn)策略)拉盾、FIFO(先進(jìn)先出)、LFU(最少訪問(wèn)次數(shù))豁状。
- FIFO捉偏,first in first out,先進(jìn)先出泻红。
- LFU夭禽, Less Frequently Used,一直以來(lái)最少被使用的谊路。如上面所講讹躯,緩存的元素有一個(gè)hit屬性,hit值最小的將會(huì)被清出緩存缠劝。
- LRU潮梯,Least Recently Used,最近最少使用的惨恭,緩存的元素有一個(gè)時(shí)間戳秉馏,當(dāng)緩存容量滿了,而又需要騰出地方來(lái)緩存新的元素的時(shí)候脱羡,那么現(xiàn)有緩存元素中時(shí)間戳離當(dāng)前時(shí)間最遠(yuǎn)的元素將被清出緩存萝究。
在主類加上啟動(dòng)注解
@SpringBootApplication
@EnableCaching
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
在數(shù)據(jù)訪問(wèn)接口中,增加緩存配置注解锉罐,如:
@CacheConfig(cacheNames = "users")
public interface UserRepository extends JpaRepository<User, Long> {
@Cacheable
User findByName(String name);
}
Cache注解詳解
@CacheConfig
:主要用于配置該類中會(huì)用到的一些共用的緩存配置帆竹。在這里@CacheConfig(cacheNames = "users")
:配置了該數(shù)據(jù)訪問(wèn)對(duì)象中返回的內(nèi)容將存儲(chǔ)于名為users的緩存對(duì)象中,我們也可以不使用該注解脓规,直接通過(guò)@Cacheable
自己配置緩存集的名字來(lái)定義馆揉。-
@Cacheable
:配置了findByName函數(shù)的返回值將被加入緩存。同時(shí)在查詢時(shí)抖拦,會(huì)先從緩存中獲取升酣,若不存在才再發(fā)起對(duì)數(shù)據(jù)庫(kù)的訪問(wèn)舷暮。該注解主要有下面幾個(gè)參數(shù):-
value
、cacheNames
:兩個(gè)等同的參數(shù)(cacheNames
為Spring 4新增噩茄,作為value
的別名)下面,用于指定緩存存儲(chǔ)的集合名。由于Spring 4中新增了@CacheConfig
绩聘,因此在Spring 3中原本必須有的value
屬性沥割,也成為非必需項(xiàng)了 -
key
:緩存對(duì)象存儲(chǔ)在Map集合中的key值,非必需凿菩,缺省按照函數(shù)的所有參數(shù)組合作為key值机杜,若自己配置需使用SpEL表達(dá)式,比如:@Cacheable(key = "#p0")
:使用函數(shù)第一個(gè)參數(shù)作為緩存的key值衅谷,更多關(guān)于SpEL表達(dá)式的詳細(xì)內(nèi)容可參考官方文檔 -
condition
:緩存對(duì)象的條件椒拗,非必需,也需使用SpEL表達(dá)式获黔,只有滿足表達(dá)式條件的內(nèi)容才會(huì)被緩存蚀苛,比如:@Cacheable(key = "#p0", condition = "#p0.length() < 3")
,表示只有當(dāng)?shù)谝粋€(gè)參數(shù)的長(zhǎng)度小于3的時(shí)候才會(huì)被緩存玷氏,若做此配置上面的AAA用戶就不會(huì)被緩存堵未,讀者可自行實(shí)驗(yàn)嘗試。 -
unless
:另外一個(gè)緩存條件參數(shù)盏触,非必需渗蟹,需使用SpEL表達(dá)式。它不同于condition
參數(shù)的地方在于它的判斷時(shí)機(jī)赞辩,該條件是在函數(shù)被調(diào)用之后才做判斷的拙徽,所以它可以通過(guò)對(duì)result進(jìn)行判斷。 -
keyGenerator
:用于指定key生成器诗宣,非必需膘怕。若需要指定一個(gè)自定義的key生成器,我們需要去實(shí)現(xiàn)org.springframework.cache.interceptor.KeyGenerator
接口召庞,并使用該參數(shù)來(lái)指定岛心。需要注意的是:該參數(shù)與key
是互斥的 -
cacheManager
:用于指定使用哪個(gè)緩存管理器,非必需篮灼。只有當(dāng)有多個(gè)時(shí)才需要使用 -
cacheResolver
:用于指定使用那個(gè)緩存解析器忘古,非必需。需通過(guò)org.springframework.cache.interceptor.CacheResolver
接口來(lái)實(shí)現(xiàn)自己的緩存解析器诅诱,并用該參數(shù)指定髓堪。
-
除了這里用到的兩個(gè)注解之外,還有下面幾個(gè)核心注解:
-
@CachePut
:配置于函數(shù)上,能夠根據(jù)參數(shù)定義條件來(lái)進(jìn)行緩存干旁,它與@Cacheable
不同的是驶沼,它每次都會(huì)真是調(diào)用函數(shù),所以主要用于數(shù)據(jù)新增和修改操作上争群。它的參數(shù)與@Cacheable
類似回怜,具體功能可參考上面對(duì)@Cacheable
參數(shù)的解析 -
@CacheEvict
:配置于函數(shù)上,通常用在刪除方法上换薄,用來(lái)從緩存中移除相應(yīng)數(shù)據(jù)玉雾。除了同@Cacheable
一樣的參數(shù)之外,它還有下面兩個(gè)參數(shù):-
allEntries
:非必需轻要,默認(rèn)為false复旬。當(dāng)為true時(shí),會(huì)移除所有數(shù)據(jù) -
beforeInvocation
:非必需冲泥,默認(rèn)為false驹碍,會(huì)在調(diào)用方法之后移除數(shù)據(jù)。當(dāng)為true時(shí)柏蘑,會(huì)在調(diào)用方法之前移除數(shù)據(jù)幸冻。
-