SpringBoot中使用spring-retry 解決失敗重試調(diào)用
在日常開發(fā)過程中,難免會與第三方接口發(fā)生交互,例如:短信發(fā)送、遠程服務(wù)調(diào)用、爭搶鎖等場景,當正常調(diào)用發(fā)生異常時,例如:網(wǎng)絡(luò)抖動,這些間歇性的異常在一段時候之后會自行恢復,程序為了更加健壯并且更不容易出現(xiàn)故障,需要重新觸發(fā)業(yè)務(wù)操作,以防止間歇性的異常對程序照成的影響。
常用的重試策略,比如通過 while 循環(huán)手動重復調(diào)用或是通過 JDK/CGLib 動態(tài)代理的方式來進行重試。但是這種方法比較笨重,且對原有邏輯代碼的入侵性比較大。
1、引入spring-retry
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> <dependency> <groupId>org.springframework.retry</groupId> <artifactId>spring-retry</artifactId> </dependency>
這里我們還引入了 aop 的依賴,因為 spring-retry 的原理就是基于 aop 來實現(xiàn)的
2、開啟spring-retry
啟動類上增加注解 @EnableRetry
@EnableRetry @SpringBootApplication public class AsurplusApplication { public static void main(String[] args) { SpringApplication.run(AsurplusApplication.class, args); } }
3、@Retryable
在需要重試的方法上增加注解 @Retryable,表示該方法需要重試
@Component public class TestRetry { int a = 0; @Retryable(value = {RuntimeException.class}, maxAttempts = 5, backoff = @Backoff(delay = 1000, multiplier = 2)) public String test() { a++; System.out.println(a + " - " + System.currentTimeMillis()); if (a < 10) { throw new RuntimeException("未滿足條件"); } return "執(zhí)行成功"; } }
@Retryable 注解
- value,可重試的異常類型。含義同include。默認為空(如果excludes也為空,則重試所有異常)
- include:可重試的異常類型。默認為空(如果excludes也為空,則重試所有異常)
- exclude:無需重試的異常類型。默認為空(如果includes也為空,則重試所有異常)
- maxAttempts:最大重試次數(shù)(包括第一次失敗),默認為3次
- backoff:重試等待策略,下面會在@Backoff中介紹
- recover:表示重試次數(shù)到達最大重試次數(shù)后的回調(diào)方法
@Backoff 注解
- delay,重試之間的等待時間(以毫秒為單位)
- maxDelay,重試之間的最大等待時間(以毫秒為單位)
- multiplier,指定延遲的倍數(shù)
- delayExpression,重試之間的等待時間表達式
- maxDelayExpression,重試之間的最大等待時間表達式
- multiplierExpression,指定延遲的倍數(shù)表達式
- random,隨機指定延遲時間
4、重試耗盡
當重試耗盡時,RetryOperations 可以將控制傳遞給另一個回調(diào),即 RecoveryCallback。Spring-Retry 還提供了 @Recover 注解,用于 @Retryable 重試失敗后處理方法。若不需要重試失敗后的處理方法,則不寫回調(diào)方法,重試耗盡后拋出異常。
@Recover public String recoverTest(RuntimeException e) { return "回調(diào)方法-" + e.getMessage(); }
- 方法的返回值必須與 @Retryable 方法一致
- 方法的第一個參數(shù),必須是 Throwable 類型的,建議是與 @Retryable 配置的異常一致,其他的參數(shù),需要哪個參數(shù),寫進去就可以了(@Recover 方法中有的)
- 該回調(diào)方法與重試方法寫在同一個實現(xiàn)類里面
若同一個實現(xiàn)類中有多個回調(diào)方法,我們需要使用 recover 屬性指定回調(diào)的方法名
@Component public class TestRetry { int a = 0; @Retryable(recover = "recoverTest1", value = {RuntimeException.class}, maxAttempts = 5, backoff = @Backoff(delay = 1000, multiplier = 2)) public String test() { a++; System.out.println(a + " - " + System.currentTimeMillis()); if (a < 10) { throw new RuntimeException("未滿足條件"); } return "執(zhí)行成功"; } @Recover public String recoverTest(RuntimeException e) { return "回調(diào)方法-" + e.getMessage(); } @Recover public String recoverTest1(RuntimeException e) { return "回調(diào)方法1-" + e.getMessage(); } }
指定了回調(diào)方法為 recoverTest1
5、注意事項
由于是基于 AOP 實現(xiàn),所以不支持類里自調(diào)用方法
如果重試失敗需要給 @Recover 注解的方法做后續(xù)處理,那這個重試的方法不能有返回值,只能是 void
方法內(nèi)不能使用 try catch,只能往外拋異常
@Recover 注解來開啟重試失敗后調(diào)用的方法(注意,需跟重處理方法在同一個類中),此注解注釋的方法參數(shù)一定要是 @Retryable 拋出的異常,否則無法識別,可以在該方法中進行日志處理。
到此這篇關(guān)于SpringBoot中使用spring-retry 解決失敗重試調(diào)用的文章就介紹到這了,更多相關(guān)SpringBoot spring-retry失敗重試內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
JDK動態(tài)代理之WeakCache緩存的實現(xiàn)機制
這篇文章主要介紹了JDK動態(tài)代理之WeakCache緩存的實現(xiàn)機制2018-02-02Springboot的ThreadPoolTaskScheduler線程池輕松搞定15分鐘不操作自動取消訂單
這篇文章主要介紹了Springboot的ThreadPoolTaskScheduler線程池輕松搞定15分鐘不操作自動取消訂單,本文給大家介紹的非常詳細,需要的朋友可以參考下2025-01-01java編程無向圖結(jié)構(gòu)的存儲及DFS操作代碼詳解
這篇文章主要介紹了java編程無向圖結(jié)構(gòu)的存儲及DFS操作代碼詳解,具有一定借鑒價值,需要的朋友可以了解下。2017-12-12Java中ShardingSphere 數(shù)據(jù)分片的實現(xiàn)
其實很多人對分庫分表多少都有點恐懼,我們今天用ShardingSphere 給大家演示數(shù)據(jù)分片,具有一定的參考價值,感興趣的小伙伴們可以參考一下2021-09-09