再也不用重複造輪子了 一個Spring註解輕鬆解決
theme: nico
開啟掘金成長之旅!這是我參與「掘金日新計劃 · 12 月更文挑戰」的第31天,點選檢視活動詳情
在實際工作中,重處理是一個非常常見的場景,比如:
- 傳送訊息失敗。
- 呼叫遠端服務失敗。
- 爭搶鎖失敗。
這些錯誤可能是因為網路波動造成的,等待過後重處理就能成功。通常來說,會用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
``` @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
方法中有的) - 該回調方法與重試方法寫在同一個實現類裡面
5. 注意事項
- 由於是基於AOP實現,所以不支援類裡自呼叫方法
- 如果重試失敗需要給
@Recover
註解的方法做後續處理,那這個重試的方法不能有返回值,只能是void - 方法內不能使用
try catch
,只能往外拋異常 @Recover
註解來開啟重試失敗後呼叫的方法(注意,需跟重處理方法在同一個類中),此註解註釋的方法引數一定要是@Retryable
丟擲的異常,否則無法識別,可以在該方法中進行日誌處理。