SpringBoot項(xiàng)目中使用緩存的正確方法

前言

緩存可以通過(guò)將經(jīng)常訪問(wèn)的數(shù)據(jù)存儲(chǔ)在內(nèi)存中，減少底層數(shù)據(jù)源如數(shù)據(jù)庫(kù)的壓力，從而有效提高系統(tǒng)的性能和穩(wěn)定性。我想大家的項(xiàng)目中或多或少都有使用過(guò)，我們項(xiàng)目也不例外，但是最近在review公司的代碼的時(shí)候?qū)懙暮艽狼襩ow, 大致寫(xiě)法如下：

publicUsergetById(Stringid){
Useruser=cache.getUser();
if(user!=null){
returnuser;
}
//從數(shù)據(jù)庫(kù)獲取
user=loadFromDB(id);
cahce.put(id,user);
returnuser;
}

其實(shí)Spring Boot 提供了強(qiáng)大的緩存抽象，可以輕松地向您的應(yīng)用程序添加緩存。本文就講講如何使用 Spring 提供的不同緩存注解實(shí)現(xiàn)緩存的最佳實(shí)踐。

基于 Spring Boot + MyBatis Plus + Vue & Element 實(shí)現(xiàn)的后臺(tái)管理系統(tǒng) + 用戶(hù)小程序，支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶(hù)、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

項(xiàng)目地址：https://github.com/YunaiV/ruoyi-vue-pro

視頻教程：https://doc.iocoder.cn/video/

啟用緩存@EnableCaching

現(xiàn)在大部分項(xiàng)目都是是SpringBoot項(xiàng)目，我們可以在啟動(dòng)類(lèi)添加注解@EnableCaching來(lái)開(kāi)啟緩存功能。

@SpringBootApplication
@EnableCaching
publicclassSpringCacheApp{

publicstaticvoidmain(String[]args){
SpringApplication.run(Cache.class,args);
}
}

既然要能使用緩存，就需要有一個(gè)緩存管理器Bean，默認(rèn)情況下，@EnableCaching 將注冊(cè)一個(gè)ConcurrentMapCacheManager的Bean，不需要單獨(dú)的 bean 聲明。ConcurrentMapCacheManager將值存儲(chǔ)在ConcurrentHashMap的實(shí)例中，這是緩存機(jī)制的最簡(jiǎn)單的線程安全實(shí)現(xiàn)。

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實(shí)現(xiàn)的后臺(tái)管理系統(tǒng) + 用戶(hù)小程序，支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶(hù)、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

項(xiàng)目地址：https://github.com/YunaiV/yudao-cloud

視頻教程：https://doc.iocoder.cn/video/

自定義緩存管理器

默認(rèn)的緩存管理器并不能滿(mǎn)足需求，因?yàn)樗谴鎯?chǔ)在jvm內(nèi)存中的，那么如何存儲(chǔ)到redis中呢？這時(shí)候需要添加自定義的緩存管理器。

添加依賴(lài)

org.springframework.boot
spring-boot-starter-data-redis

配置Redis緩存管理器

@Configuration
@EnableCaching
publicclassCacheConfig{

@Bean
publicRedisConnectionFactoryredisConnectionFactory(){
returnnewLettuceConnectionFactory();
}

@Bean
publicCacheManagercacheManager(){
RedisCacheConfigurationredisCacheConfiguration=RedisCacheConfiguration.defaultCacheConfig()
.disableCachingNullValues()
.serializeValuesWith(SerializationPair.fromSerializer(newGenericJackson2JsonRedisSerializer()));

RedisCacheManagerredisCacheManager=RedisCacheManager.builder(redisConnectionFactory())
.cacheDefaults(redisCacheConfiguration)
.build();

returnredisCacheManager;
}
}

現(xiàn)在有了緩存管理器以后，我們?nèi)绾卧跇I(yè)務(wù)層面操作緩存呢？

我們可以使用@Cacheable、@CachePut 或@CacheEvict 注解來(lái)操作緩存了。

@Cacheable

該注解可以將方法運(yùn)行的結(jié)果進(jìn)行緩存，在緩存時(shí)效內(nèi)再次調(diào)用該方法時(shí)不會(huì)調(diào)用方法本身，而是直接從緩存獲取結(jié)果并返回給調(diào)用方。

例子1：緩存數(shù)據(jù)庫(kù)查詢(xún)的結(jié)果。

@Service
publicclassMyService{

@Autowired
privateMyRepositoryrepository;

@Cacheable(value="myCache",key="#id")
publicMyEntitygetEntityById(Longid){
returnrepository.findById(id).orElse(null);
}
}

在此示例中，@Cacheable 注解用于緩存 getEntityById()方法的結(jié)果，該方法根據(jù)其 ID 從數(shù)據(jù)庫(kù)中檢索 MyEntity 對(duì)象。

但是如果我們更新數(shù)據(jù)呢？舊數(shù)據(jù)仍然在緩存中？

@CachePut

然后@CachePut 出來(lái)了, 與 @Cacheable 注解不同的是使用 @CachePut 注解標(biāo)注的方法，在執(zhí)行前不會(huì)去檢查緩存中是否存在之前執(zhí)行過(guò)的結(jié)果，而是每次都會(huì)執(zhí)行該方法，并將執(zhí)行結(jié)果以鍵值對(duì)的形式寫(xiě)入指定的緩存中。@CachePut 注解一般用于更新緩存數(shù)據(jù)，相當(dāng)于緩存使用的是寫(xiě)模式中的雙寫(xiě)模式。

@Service
publicclassMyService{

@Autowired
privateMyRepositoryrepository;

@CachePut(value="myCache",key="#entity.id")
publicvoidsaveEntity(MyEntityentity){
repository.save(entity);
}
}

@CacheEvict

標(biāo)注了 @CacheEvict 注解的方法在被調(diào)用時(shí)，會(huì)從緩存中移除已存儲(chǔ)的數(shù)據(jù)。@CacheEvict 注解一般用于刪除緩存數(shù)據(jù)，相當(dāng)于緩存使用的是寫(xiě)模式中的失效模式。

@Service
publicclassMyService{

@Autowired
privateMyRepositoryrepository;

@CacheEvict(value="myCache",key="#id")
publicvoiddeleteEntityById(Longid){
repository.deleteById(id);
}
}

@Caching

@Caching 注解用于在一個(gè)方法或者類(lèi)上，同時(shí)指定多個(gè) Spring Cache 相關(guān)的注解。

例子1：@Caching注解中的evict屬性指定在調(diào)用方法 saveEntity 時(shí)失效兩個(gè)緩存。

@Service
publicclassMyService{

@Autowired
privateMyRepositoryrepository;

@Cacheable(value="myCache",key="#id")
publicMyEntitygetEntityById(Longid){
returnrepository.findById(id).orElse(null);
}

@Caching(evict={
@CacheEvict(value="myCache",key="#entity.id"),
@CacheEvict(value="otherCache",key="#entity.id")
})
publicvoidsaveEntity(MyEntityentity){
repository.save(entity);
}

}

例子2：調(diào)用getEntityById方法時(shí)，Spring會(huì)先檢查結(jié)果是否已經(jīng)緩存在myCache緩存中。如果是，Spring 將返回緩存的結(jié)果而不是執(zhí)行該方法。如果結(jié)果尚未緩存，Spring 將執(zhí)行該方法并將結(jié)果緩存在 myCache 緩存中。方法執(zhí)行后，Spring會(huì)根據(jù)@CacheEvict注解從otherCache緩存中移除緩存結(jié)果。

@Service
publicclassMyService{

@Caching(
cacheable={
@Cacheable(value="myCache",key="#id")
},
evict={
@CacheEvict(value="otherCache",key="#id")
}
)
publicMyEntitygetEntityById(Longid){
returnrepository.findById(id).orElse(null);
}

}

例子3：當(dāng)調(diào)用saveData方法時(shí)，Spring會(huì)根據(jù)@CacheEvict注解先從otherCache緩存中移除數(shù)據(jù)。然后，Spring 將執(zhí)行該方法并將結(jié)果保存到數(shù)據(jù)庫(kù)或外部 API。

方法執(zhí)行后，Spring 會(huì)根據(jù)@CachePut注解將結(jié)果添加到 myCache、myOtherCache 和 myThirdCache 緩存中。Spring 還將根據(jù)@Cacheable注解檢查結(jié)果是否已緩存在 myFourthCache 和 myFifthCache 緩存中。如果結(jié)果尚未緩存，Spring 會(huì)將結(jié)果緩存在適當(dāng)?shù)木彺嬷?。如果結(jié)果已經(jīng)被緩存，Spring 將返回緩存的結(jié)果，而不是再次執(zhí)行該方法。

@Service
publicclassMyService{

@Caching(
put={
@CachePut(value="myCache",key="#result.id"),
@CachePut(value="myOtherCache",key="#result.id"),
@CachePut(value="myThirdCache",key="#result.name")
},
evict={
@CacheEvict(value="otherCache",key="#id")
},
cacheable={
@Cacheable(value="myFourthCache",key="#id"),
@Cacheable(value="myFifthCache",key="#result.id")
}
)
publicMyEntitysaveData(Longid,Stringname){
//CodetosavedatatoadatabaseorexternalAPI
MyEntityentity=newMyEntity(id,name);
returnentity;
}

}

@CacheConfig

通過(guò)@CacheConfig 注解，我們可以將一些緩存配置簡(jiǎn)化到類(lèi)級(jí)別的一個(gè)地方，這樣我們就不必多次聲明相關(guān)值：

@CacheConfig(cacheNames={"myCache"})
@Service
publicclassMyService{

@Autowired
privateMyRepositoryrepository;

@Cacheable(key="#id")
publicMyEntitygetEntityById(Longid){
returnrepository.findById(id).orElse(null);
}

@CachePut(key="#entity.id")
publicvoidsaveEntity(MyEntityentity){
repository.save(entity);
}

@CacheEvict(key="#id")
publicvoiddeleteEntityById(Longid){
repository.deleteById(id);
}
}

Condition & Unless

condition作用：指定緩存的條件（滿(mǎn)足什么條件才緩存），可用 SpEL 表達(dá)式（如 #id>0，表示當(dāng)入?yún)?id 大于 0 時(shí)才緩存）

unless作用 : 否定緩存，即滿(mǎn)足 unless 指定的條件時(shí)，方法的結(jié)果不進(jìn)行緩存，使用 unless 時(shí)可以在調(diào)用的方法獲取到結(jié)果之后再進(jìn)行判斷（如 #result == null，表示如果結(jié)果為 null 時(shí)不緩存）

//whenid>10,the@CachePutworks.
@CachePut(key="#entity.id",condition="#entity.id>10")
publicvoidsaveEntity(MyEntityentity){
repository.save(entity);
}


//whenresult!=null,the@CachePutworks.
@CachePut(key="#id",condition="#result==null")
publicvoidsaveEntity1(MyEntityentity){
repository.save(entity);
}

清理全部緩存

通過(guò)allEntries、beforeInvocation屬性可以來(lái)清除全部緩存數(shù)據(jù)，不過(guò)allEntries是方法調(diào)用后清理，beforeInvocation是方法調(diào)用前清理。

//方法調(diào)用完成之后，清理所有緩存
@CacheEvict(value="myCache",allEntries=true)
publicvoiddelectAll(){
repository.deleteAll();
}

//方法調(diào)用之前，清除所有緩存
@CacheEvict(value="myCache",beforeInvocation=true)
publicvoiddelectAll(){
repository.deleteAll();
}

SpEL表達(dá)式

Spring Cache注解中頻繁用到SpEL表達(dá)式，那么具體如何使用呢？

SpEL 表達(dá)式的語(yǔ)法

Spring Cache可用的變量

最佳實(shí)踐

通過(guò)Spring緩存注解可以快速優(yōu)雅地在我們項(xiàng)目中實(shí)現(xiàn)緩存的操作，但是在雙寫(xiě)模式或者失效模式下，可能會(huì)出現(xiàn)緩存數(shù)據(jù)一致性問(wèn)題（讀取到臟數(shù)據(jù)），Spring Cache 暫時(shí)沒(méi)辦法解決。最后我們?cè)倏偨Y(jié)下Spring Cache使用的一些最佳實(shí)踐。

只緩存經(jīng)常讀取的數(shù)據(jù)：緩存可以顯著提高性能，但只緩存經(jīng)常訪問(wèn)的數(shù)據(jù)很重要。很少或從不訪問(wèn)的緩存數(shù)據(jù)會(huì)占用寶貴的內(nèi)存資源，從而導(dǎo)致性能問(wèn)題。

根據(jù)應(yīng)用程序的特定需求選擇合適的緩存提供程序和策略。SpringBoot 支持多種緩存提供程序，包括 Ehcache、Hazelcast 和 Redis。

使用緩存時(shí)請(qǐng)注意潛在的線程安全問(wèn)題。對(duì)緩存的并發(fā)訪問(wèn)可能會(huì)導(dǎo)致數(shù)據(jù)不一致或不正確，因此選擇線程安全的緩存提供程序并在必要時(shí)使用適當(dāng)?shù)耐綑C(jī)制非常重要。

避免過(guò)度緩存。緩存對(duì)于提高性能很有用，但過(guò)多的緩存實(shí)際上會(huì)消耗寶貴的內(nèi)存資源，從而損害性能。在緩存頻繁使用的數(shù)據(jù)和允許垃圾收集不常用的數(shù)據(jù)之間取得平衡很重要。

使用適當(dāng)?shù)木彺嬷鸪霾呗?。使用緩存時(shí)，重要的是定義適當(dāng)?shù)木彺嬷鸪霾呗砸源_保在必要時(shí)從緩存中刪除舊的或陳舊的數(shù)據(jù)。

使用適當(dāng)?shù)木彺骀I設(shè)計(jì)。緩存鍵對(duì)于每個(gè)數(shù)據(jù)項(xiàng)都應(yīng)該是唯一的，并且應(yīng)該考慮可能影響緩存數(shù)據(jù)的任何相關(guān)參數(shù)，例如用戶(hù) ID、時(shí)間或位置。

常規(guī)數(shù)據(jù)（讀多寫(xiě)少、即時(shí)性與一致性要求不高的數(shù)據(jù)）完全可以使用 Spring Cache，至于寫(xiě)模式下緩存數(shù)據(jù)一致性問(wèn)題的解決，只要緩存數(shù)據(jù)有設(shè)置過(guò)期時(shí)間就足夠了。

特殊數(shù)據(jù)（讀多寫(xiě)多、即時(shí)性與一致性要求非常高的數(shù)據(jù)），不能使用 Spring Cache，建議考慮特殊的設(shè)計(jì)（例如使用 Cancal 中間件等）。
責(zé)任編輯：彭菁