
前言
在實際工作中,重處理是一個非常常見的場景,比如:
- 發(fā)送消息失敗。
- 調(diào)用遠程服務(wù)失敗。
- 爭搶鎖失敗。
這些錯誤可能是因為網(wǎng)絡(luò)波動造成的,等待過后重處理就能成功。通常來說,會用try/catch,while循環(huán)之類的語法來進行重處理,但是這樣的做法缺乏統(tǒng)一性,并且不是很方便,要多寫很多代碼。然而spring-retry卻可以通過注解,在不入侵原有業(yè)務(wù)邏輯代碼的方式下,優(yōu)雅的實現(xiàn)重處理功能。
基于 Spring Boot + MyBatis Plus + Vue & Element 實現(xiàn)的后臺管理系統(tǒng) + 用戶小程序,支持 RBAC 動態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能
- 項目地址:https://github.com/YunaiV/ruoyi-vue-pro
- 視頻教程:https://doc.iocoder.cn/video/
@Retryable是什么?
spring系列的spring-retry是另一個實用程序模塊,可以幫助我們以標(biāo)準(zhǔn)方式處理任何特定操作的重試。在spring-retry中,所有配置都是基于簡單注釋的。
基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實現(xiàn)的后臺管理系統(tǒng) + 用戶小程序,支持 RBAC 動態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能
- 項目地址:https://github.com/YunaiV/yudao-cloud
- 視頻教程:https://doc.iocoder.cn/video/
使用步驟
POM依賴
<dependency>
<groupId>org.springframework.retrygroupId>
<artifactId>spring-retryartifactId>
dependency>
啟用@Retryable
@EnableRetry
@SpringBootApplication
publicclassHelloApplication{
publicstaticvoidmain(String[]args){
SpringApplication.run(HelloApplication.class,args);
}
}
在方法上添加@Retryable
importcom.mail.elegant.service.TestRetryService;
importorg.springframework.retry.annotation.Backoff;
importorg.springframework.retry.annotation.Retryable;
importorg.springframework.stereotype.Service;
importjava.time.LocalTime;
@Service
publicclassTestRetryServiceImplimplementsTestRetryService{
@Override
@Retryable(value=Exception.class,maxAttempts=3,backoff=@Backoff(delay=2000,multiplier=1.5))
publicinttest(intcode)throwsException{
System.out.println("test被調(diào)用,時間:"+LocalTime.now());
if(code==0){
thrownewException("情況不對頭!");
}
System.out.println("test被調(diào)用,情況對頭了!");
return200;
}
}
來簡單解釋一下注解中幾個參數(shù)的含義:
-
value:拋出指定異常才會重試 -
include:和value一樣,默認為空,當(dāng)exclude也為空時,默認所有異常 -
exclude:指定不處理的異常 -
maxAttempts:最大重試次數(shù),默認3次 -
backoff:重試等待策略,默認使用@Backoff,@Backoff的value默認為1000L,我們設(shè)置為2000L;multiplier(指定延遲倍數(shù))默認為0,表示固定暫停1秒后進行重試,如果把multiplier設(shè)置為1.5,則第一次重試為2秒,第二次為3秒,第三次為4.5秒。
當(dāng)重試耗盡時還是失敗,會出現(xiàn)什么情況呢?
當(dāng)重試耗盡時,RetryOperations可以將控制傳遞給另一個回調(diào),即RecoveryCallback。Spring-Retry還提供了@Recover注解,用于@Retryable重試失敗后處理方法。如果不需要回調(diào)方法,可以直接不寫回調(diào)方法,那么實現(xiàn)的效果是,重試次數(shù)完了后,如果還是沒成功沒符合業(yè)務(wù)判斷,就拋出異常。
@Recover
@Recover
publicintrecover(Exceptione,intcode){
System.out.println("回調(diào)方法執(zhí)行?。。。?);
//記日志到數(shù)據(jù)庫或者調(diào)用其余的方法
return400;
}
可以看到傳參里面寫的是 Exception e,這個是作為回調(diào)的接頭暗號(重試次數(shù)用完了,還是失敗,我們拋出這個Exception e通知觸發(fā)這個回調(diào)方法)。對于@Recover注解的方法,需要特別注意的是:
-
方法的返回值必須與
@Retryable方法一致 -
方法的第一個參數(shù),必須是Throwable類型的,建議是與
@Retryable配置的異常一致,其他的參數(shù),需要哪個參數(shù),寫進去就可以了(@Recover方法中有的) - 該回調(diào)方法與重試方法寫在同一個實現(xiàn)類里面
注意事項
- 由于是基于AOP實現(xiàn),所以不支持類里自調(diào)用方法
-
如果重試失敗需要給
@Recover注解的方法做后續(xù)處理,那這個重試的方法不能有返回值,只能是void -
方法內(nèi)不能使用
try catch,只能往外拋異常 -
@Recover注解來開啟重試失敗后調(diào)用的方法(注意,需跟重處理方法在同一個類中),此注解注釋的方法參數(shù)一定要是@Retryable拋出的異常,否則無法識別,可以在該方法中進行日志處理。
總結(jié)
本篇主要簡單介紹了Springboot中的Retryable的使用,主要的適用場景和注意事項,當(dāng)需要重試的時候還是很有用的。
審核編輯 :李倩
-
參數(shù)
+關(guān)注
關(guān)注
11文章
1869瀏覽量
33955 -
spring
+關(guān)注
關(guān)注
0文章
341瀏覽量
15940
原文標(biāo)題:求求你們了,別再重復(fù)造輪子了,一個 Spring 注解輕松搞定循環(huán)重試功能!
文章出處:【微信號:芋道源碼,微信公眾號:芋道源碼】歡迎添加關(guān)注!文章轉(zhuǎn)載請注明出處。
發(fā)布評論請先 登錄
Spring Boot如何實現(xiàn)異步任務(wù)
使用Spring自定義注解的實現(xiàn)
教你如何用一個注解搞定Spring Boot接口防刷
關(guān)于Spring的循環(huán)依賴問題
淺談Spring事務(wù)底層原理
從源碼層面深度剖析Spring循環(huán)依賴
Spring Web MVC注解
Spring Bean相關(guān)的4個注解及使用方法
Spring Dependency Inject與Bean Scops注解
Spring中@Component注解是怎么實現(xiàn)的
一個Spring注解輕松搞定循環(huán)重試功能!
評論