Spring Boot 優雅的實現重處理功能
大家好,我是不才陳某~
在實際工作中,重處理是一個非常常見的場景,比如:
-
發送消息失敗。
-
調用遠程服務失敗。
-
爭搶鎖失敗。
這些錯誤可能是因爲網絡波動造成的,等待過後重處理就能成功。通常來說,會用try/catch
,while
循環之類的語法來進行重處理,但是這樣的做法缺乏統一性,並且不是很方便,要多寫很多代碼。然而spring-retry
卻可以通過註解,在不入侵原有業務邏輯代碼的方式下,優雅的實現重處理功能。
@Retryable 是什麼?
spring 系列的spring-retry
是另一個實用程序模塊,可以幫助我們以標準方式處理任何特定操作的重試。在spring-retry
中,所有配置都是基於簡單註釋的。
使用步驟
1. POM 依賴
<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
</dependency>
2. 啓用@Retryable
@EnableRetry
@SpringBootApplication
public class HelloApplication {
public static void main(String[] args) {
SpringApplication.run(HelloApplication.class, args);
}
}
3. 在方法上添加@Retryable
import com.mail.elegant.service.TestRetryService;
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;
import java.time.LocalTime;
@Service
public class TestRetryServiceImpl implements TestRetryService {
@Override
@Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 2000,multiplier = 1.5))
public int test(int code) throws Exception{
System.out.println("test被調用,時間:"+LocalTime.now());
if (code==0){
throw new Exception("情況不對頭!");
}
System.out.println("test被調用,情況對頭了!");
return 200;
}
}
來簡單解釋一下註解中幾個參數的含義:
-
value
:拋出指定異常纔會重試 -
include
:和 value 一樣,默認爲空,當 exclude 也爲空時,默認所有異常 -
exclude
:指定不處理的異常 -
maxAttempts
:最大重試次數,默認 3 次 -
backoff
:重試等待策略,默認使用@Backoff
,@Backoff
的 value 默認爲 1000L,我們設置爲 2000L;multiplier
(指定延遲倍數)默認爲 0,表示固定暫停 1 秒後進行重試,如果把multiplier
設置爲 1.5,則第一次重試爲 2 秒,第二次爲 3 秒,第三次爲 4.5 秒。
當重試耗盡時還是失敗,會出現什麼情況呢?
當重試耗盡時,RetryOperations
可以將控制傳遞給另一個回調,即RecoveryCallback
。Spring-Retry
還提供了@Recover
註解,用於 @Retryable 重試失敗後處理方法。如果不需要回調方法,可以直接不寫回調方法,那麼實現的效果是,重試次數完了後,如果還是沒成功沒符合業務判斷,就拋出異常。
4.@Recover
@Recover
public int recover(Exception e, int code){
System.out.println("回調方法執行!!!!");
//記日誌到數據庫 或者調用其餘的方法
return 400;
}
可以看到傳參裏面寫的是 Exception e
,這個是作爲回調的接頭暗號(重試次數用完了,還是失敗,我們拋出這個Exception e
通知觸發這個回調方法)。對於@Recover
註解的方法,需要特別注意的是:
-
方法的返回值必須與
@Retryable
方法一致 -
方法的第一個參數,必須是 Throwable 類型的,建議是與
@Retryable
配置的異常一致,其他的參數,需要哪個參數,寫進去就可以了(@Recover
方法中有的) -
該回調方法與重試方法寫在同一個實現類裏面
-
復 java 面試,獲取最新面試題資料。
5. 注意事項
-
由於是基於 AOP 實現,所以不支持類裏自調用方法
-
如果重試失敗需要給
@Recover
註解的方法做後續處理,那這個重試的方法不能有返回值,只能是 void -
方法內不能使用
try catch
,只能往外拋異常 -
@Recover
註解來開啓重試失敗後調用的方法 (注意, 需跟重處理方法在同一個類中),此註解註釋的方法參數一定要是@Retryable
拋出的異常,否則無法識別,可以在該方法中進行日誌處理。
總結
本篇主要簡單介紹了 Springboot 中的Retryable
的使用,主要的適用場景和注意事項,當需要重試的時候還是很有用的。
最後說一句(別白嫖,求關注)
陳某每一篇文章都是精心輸出,已經寫了 3 個專欄,整理成 PDF,獲取方式如下:
-
《Spring Cloud 進階》PDF:關注公衆號:【碼猿技術專欄】回覆關鍵詞 Spring Cloud 進階 獲取!
-
《Spring Boot 進階》PDF:關注公衆號:【碼猿技術專欄】回覆關鍵詞 Spring Boot 進階 獲取!
-
《Mybatis 進階》PDF:關注公衆號:【碼猿技術專欄】回覆關鍵詞 Mybatis 進階 獲取!
如果這篇文章對你有所幫助,或者有所啓發的話,幫忙點贊、在看、轉發、收藏,你的支持就是我堅持下去的最大動力!
關注公衆號:【碼猿技術專欄】,公衆號內有超讚的粉絲福利,回覆:加羣,可以加入技術討論羣,和大家一起討論技術,吹牛逼!
碼猿技術專欄 前螞蟻 P8,純粹的技術人,專注於 Java 後端技術分享,只寫外面看不到的乾貨,你想要的都在這裏……
本文由 Readfog 進行 AMP 轉碼,版權歸原作者所有。
來源:https://mp.weixin.qq.com/s/Tc7USvs_xZ6jPyyeR2jx1Q