原文:blog.csdn.net/h254931252/article/details/109257998 在實際工作中,重處理是一個非常常見的場景,比如: 發送消息失敗。 調用遠程服務失敗。 爭搶鎖失敗。 這些錯誤可能是因為網路波動造成的,等待過後重處理就能成功。通常來說,會用try/catch, ...
原文:blog.csdn.net/h254931252/article/details/109257998
在實際工作中,重處理是一個非常常見的場景,比如:
- 發送消息失敗。
- 調用遠程服務失敗。
- 爭搶鎖失敗。
這些錯誤可能是因為網路波動造成的,等待過後重處理就能成功。通常來說,會用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. 在啟動類上加上啟用註解@EnableRetry
@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拋出的異常,否則無法識別,可以在該方法中進行日誌處理。
本篇主要簡單介紹了Springboot中的Retryable的使用,主要的適用場景和註意事項,當需要重試的時候還是很有用的。