Spring-Retry(重試機(jī)制)解讀
Spring-Retry(重試機(jī)制)
在實(shí)際工作中,重處理是一個(gè)非常常見的場(chǎng)景,比如:
發(fā)送消息失敗。調(diào)用遠(yuǎn)程服務(wù)失敗。爭(zhēng)搶鎖失敗。
這些錯(cuò)誤可能是因?yàn)榫W(wǎng)絡(luò)波動(dòng)造成的,等待過后重處理就能成功。
通常來(lái)說,會(huì)用 try/catch
, while
循環(huán)之類的語(yǔ)法來(lái)進(jìn)行重處理,但是這樣的做法缺乏統(tǒng)一性,并且不是很方便,要多寫很多代碼。
然而 spring-retry
卻可以通過注解,在不入侵原有業(yè)務(wù)邏輯代碼的方式下,優(yōu)雅的實(shí)現(xiàn)重處理功能。
一、@Retryable是什么?
spring系列的 spring-retry
是另一個(gè)實(shí)用程序模塊,可以幫助我們以標(biāo)準(zhǔn)方式處理任何特定操作的重試。
在 spring-retry
中,所有配置都是基于簡(jiǎn)單注釋的。
二、使用步驟
1.POM依賴
基于AOP實(shí)現(xiàn),因此還需引入aop相關(guān)的依賴
<dependency> <groupId>org.springframework.retry</groupId> <artifactId>spring-retry</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
2.啟用 @Retryable
@EnableRetry @SpringBootApplication public class HelloApplication { public static void main(String[] args) { SpringApplication.run(HelloApplication.class, args); } }
3.在方法上添加 @Retryable
1.創(chuàng)建測(cè)試controller
@RestController public class TestRetryController { @Resource private TestRetryService testRetryService; @RequestMapping(value = "/test") public int test(int code) throws Exception { return testRetryService.testRetry(code); } }
2.創(chuàng)建service接口
public interface TestRetryService { int testRetry(int code) throws Exception; }
3.創(chuàng)建service實(shí)現(xiàn)類并添加@Retryable
@Service public class TestRetryServiceImpl implements TestRetryService { /** * value:拋出指定異常才會(huì)重試 * include:和value一樣,默認(rèn)為空,當(dāng)exclude也為空時(shí),默認(rèn)所有異常 * exclude:指定不處理的異常 * maxAttempts:最大重試次數(shù),默認(rèn)3次 * backoff:重試等待策略, * 默認(rèn)使用@Backoff,@Backoff的value默認(rèn)為1000L,我們?cè)O(shè)置為2000; 以毫秒為單位的延遲(默認(rèn) 1000) * multiplier(指定延遲倍數(shù))默認(rèn)為0,表示固定暫停1秒后進(jìn)行重試,如果把multiplier設(shè)置為1.5,則第一次重試為2秒,第二次為3秒,第三次為4.5秒。 * @param code * @return * @throws Exception */ @Override @Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 2000,multiplier = 1.5)) public int testRetry(int code) throws Exception{ System.out.println("test被調(diào)用,時(shí)間:"+ LocalTime.now()); if (code==0){ throw new Exception("情況不對(duì)頭!"); } System.out.println("test被調(diào)用,情況對(duì)頭了!"); return 200; } /** * Spring-Retry還提供了@Recover注解,用于@Retryable重試失敗后處理方法。 * 如果不需要回調(diào)方法,可以直接不寫回調(diào)方法,那么實(shí)現(xiàn)的效果是,重試次數(shù)完了后,如果還是沒成功沒符合業(yè)務(wù)判斷,就拋出異常。 * 可以看到傳參里面寫的是 Exception e,這個(gè)是作為回調(diào)的接頭暗號(hào)(重試次數(shù)用完了,還是失敗,我們拋出這個(gè)Exception e通知觸發(fā)這個(gè)回調(diào)方法)。 * 注意事項(xiàng): * 方法的返回值必須與@Retryable方法一致 * 方法的第一個(gè)參數(shù),必須是Throwable類型的,建議是與@Retryable配置的異常一致,其他的參數(shù),需要哪個(gè)參數(shù),寫進(jìn)去就可以了(@Recover方法中有的) * 該回調(diào)方法與重試方法寫在同一個(gè)實(shí)現(xiàn)類里面 * * 由于是基于AOP實(shí)現(xiàn),所以不支持類里自調(diào)用方法 * 如果重試失敗需要給@Recover注解的方法做后續(xù)處理,那這個(gè)重試的方法不能有返回值,只能是void * 方法內(nèi)不能使用try catch,只能往外拋異常 * @Recover注解來(lái)開啟重試失敗后調(diào)用的方法(注意,需跟重處理方法在同一個(gè)類中),此注解注釋的方法參數(shù)一定要是@Retryable拋出的異常,否則無(wú)法識(shí)別,可以在該方法中進(jìn)行日志處理。 * @param e * @param code * @return */ @Recover public int recover(Exception e, int code){ System.out.println("回調(diào)方法執(zhí)行!?。。?); //記日志到數(shù)據(jù)庫(kù) 或者調(diào)用其余的方法 System.out.println("異常信息:"+e.getMessage()); return 400; } }
來(lái)簡(jiǎn)單解釋一下注解中幾個(gè)參數(shù)的含義:
value
:拋出指定異常才會(huì)重試include
:和value一樣,默認(rèn)為空,當(dāng)exclude也為空時(shí),默認(rèn)所有異常exclude
:指定不處理的異常maxAttempts
:最大重試次數(shù),默認(rèn)3次backoff
:重試等待策略,默認(rèn)使用@Backoff
,@Backoff
的value默認(rèn)為1000(單位毫秒),我們?cè)O(shè)置為2000;multiplier
(指定延遲倍數(shù))默認(rèn)為0,表示固定暫停1秒后進(jìn)行重試,如果把multiplier
設(shè)置為1.5,則第一次重試為2秒,第二次為3秒,第三次為4.5秒。
當(dāng)重試耗盡時(shí)還是失敗,會(huì)出現(xiàn)什么情況呢?
當(dāng)重試耗盡時(shí), RetryOperations
可以將控制傳遞給另一個(gè)回調(diào),即 RecoveryCallback
。
Spring-Retry
還提供了 @Recover
注解,用于@Retryable重試失敗后處理方法。如果不需要回調(diào)方法,可以直接不寫回調(diào)方法,那么實(shí)現(xiàn)的效果是,重試次數(shù)完了后,如果還是沒成功沒符合業(yè)務(wù)判斷,就拋出異常。
@Recover public int recover(Exception e, int code){ System.out.println("回調(diào)方法執(zhí)行?。。。?); //記日志到數(shù)據(jù)庫(kù) 或者調(diào)用其余的方法 System.out.println("異常信息:"+e.getMessage()); return 400; }
4.測(cè)試效果
這里我們傳入的code=0因此走異常的分支,由于我們添加@Retryable注解并設(shè)置了相關(guān)的參數(shù),程序會(huì)按照配置進(jìn)行重試,重試都失敗之后會(huì)調(diào)用@Recover修飾的方法,最終返回400給瀏覽器
控制臺(tái)輸出結(jié)果
總結(jié)
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
- SpringBoot使用spring retry重試機(jī)制的操作詳解
- Java中使用Spring Retry實(shí)現(xiàn)重試機(jī)制的流程步驟
- spring @retryable不生效的一種場(chǎng)景分析
- 重試框架Guava-Retry和spring-Retry的使用示例
- SpringBoot中使用spring-retry 解決失敗重試調(diào)用
- Spring-retry實(shí)現(xiàn)循環(huán)重試功能
- spring-retry組件的使用教程
- Spring @Retryable注解輕松搞定循環(huán)重試功能
- Spring?Retry?實(shí)現(xiàn)樂觀鎖重試實(shí)踐記錄
相關(guān)文章
mybatis連接PGSQL中對(duì)于json和jsonb的處理方法
在使用PostgreSQL數(shù)據(jù)庫(kù)時(shí),將表字段設(shè)置為jsonb格式可以存儲(chǔ)JSON數(shù)據(jù),本文給大家介紹mybatis連接PGSQL中對(duì)于json和jsonb的處理方法,感興趣的朋友一起看看吧2024-11-11IDEA如何切換數(shù)據(jù)庫(kù)版本mysql5或mysql8
本文介紹了如何將IntelliJ IDEA從MySQL5切換到MySQL8的詳細(xì)步驟,包括下載MySQL8、安裝、配置、停止舊服務(wù)、啟動(dòng)新服務(wù)以及更改密碼等2025-01-01Java實(shí)現(xiàn)動(dòng)態(tài)驗(yàn)證碼生成
這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)動(dòng)態(tài)驗(yàn)證碼生成,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-04-04如何使用MyBatis框架實(shí)現(xiàn)增刪改查(CRUD)操作
本文主要介紹了如何使用MyBatis框架實(shí)現(xiàn)增刪改查(CRUD)操作。首先介紹了MyBatis框架的基本概念和使用方法,然后分別介紹了如何使用MyBatis實(shí)現(xiàn)增刪改查操作。最后,通過一個(gè)簡(jiǎn)單的示例演示了如何使用MyBatis框架實(shí)現(xiàn)CRUD操作。2023-05-05Java使用application.property讀取文件里面的值
本文通過實(shí)例代碼給大家介紹了Java使用application.property讀取文件里面的值,需要的朋友可以參考下2018-10-10spring 整合 mybatis 中數(shù)據(jù)源的幾種配置方式(總結(jié)篇)
因?yàn)閟pring 整合mybatis的過程中, 有好幾種整合方式,尤其是數(shù)據(jù)源那塊,經(jīng)??吹讲灰粯拥呐渲梅绞?,總感覺有點(diǎn)亂,所以今天有空總結(jié)下,感興趣的朋友跟隨腳本之家小編一起學(xué)習(xí)吧2018-05-05SpringBoot項(xiàng)目部署到服務(wù)器的兩種方式
目前,前后端分離的架構(gòu)已成主流,而使用SpringBoot構(gòu)建Web應(yīng)用是非??焖俚?項(xiàng)目發(fā)布到服務(wù)器上的時(shí)候,只需要打成一個(gè)jar包,然后通過命令 : java -jar jar包名稱即可啟動(dòng)服務(wù)了,本文介紹了SpringBoot項(xiàng)目部署到服務(wù)器的兩種方式,需要的朋友可以參考下2024-10-10spring boot使用logback實(shí)現(xiàn)多環(huán)境日志配置詳解
這篇文章主要介紹了spring boot使用logback實(shí)現(xiàn)多環(huán)境日志配置詳解,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來(lái)看看吧2018-08-08Java?Maven構(gòu)建工具中mvnd和Gradle誰(shuí)更快
這篇文章主要介紹了Java?Maven構(gòu)建工具中mvnd和Gradle誰(shuí)更快,mvnd?是?Maven?Daemon?的縮寫?,翻譯成中文就是?Maven?守護(hù)進(jìn)程,下文更多相關(guān)資料,需要的小伙伴可以參考一下2022-05-05jsp頁(yè)面中獲取servlet請(qǐng)求中的參數(shù)的辦法詳解
在JAVA WEB應(yīng)用中,如何獲取servlet請(qǐng)求中的參數(shù),本文講解了jsp頁(yè)面中獲取servlet請(qǐng)求中的參數(shù)的辦法2018-03-03