聊聊一個注解實現(xiàn)接口重試
在實際工作中,重處理是一個非常常見的場景,比如:
- 發(fā)送消息失敗。
- 調(diào)用遠程服務(wù)失敗。
- 爭搶鎖失敗。
這些錯誤可能是因為網(wǎng)絡(luò)波動造成的,等待過后重處理就能成功。通常來說,會用try/catch,while?循環(huán)之類的語法來進行重處理,但是這樣的做法缺乏統(tǒng)一性,并且不是很方便,要多寫很多代碼。然而spring-retry卻可以通過注解,在不入侵原有業(yè)務(wù)邏輯代碼的方式下,優(yōu)雅的實現(xiàn)重處理功能。
1.@Retryable是什么?
spring系列的spring-retry?是另一個實用程序模塊,可以幫助我們以標(biāo)準(zhǔn)方式處理任何特定操作的重試。在spring-retry中,所有配置都是基于簡單注釋的。
2.使用步驟
(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被調(diào)用,時間:"+LocalTime.now());
if (code==0){
throw new Exception("情況不對頭!");
}
System.out.println("test被調(diào)用,情況對頭了!");
return 200;
}
}
來簡單解釋一下注解中幾個參數(shù)的含義:
- value:拋出指定異常才會重試。
- include:和value一樣,默認(rèn)為空,當(dāng)exclude也為空時,默認(rèn)所有異常。
- exclude:指定不處理的異常。
- maxAttempts:最大重試次數(shù),默認(rèn)3次。
- backoff?:重試等待策略,默認(rèn)使用@Backoff,@Backoff?的value默認(rèn)為1000L,我們設(shè)置為2000L;multiplier?(指定延遲倍數(shù))默認(rèn)為0,表示固定暫停1秒后進行重試,如果把multiplier設(shè)置為1.5,則第一次重試為2秒,第二次為3秒,第三次為4.5秒。
當(dāng)重試耗盡時還是失敗,會出現(xiàn)什么情況呢?
當(dāng)重試耗盡時,RetryOperations?可以將控制傳遞給另一個回調(diào),即RecoveryCallback。Spring-Retry?還提供了@Recover注解,用于@Retryable重試失敗后處理方法。如果不需要回調(diào)方法,可以直接不寫回調(diào)方法,那么實現(xiàn)的效果是,重試次數(shù)完了后,如果還是沒成功沒符合業(yè)務(wù)判斷,就拋出異常。
(4)@Recover
@Recover
public int recover(Exception e, int code){
System.out.println("回調(diào)方法執(zhí)行?。。?!");
//記日志到數(shù)據(jù)庫 或者調(diào)用其余的方法
return 400;
}
可以看到傳參里面寫的是 Exception e?,這個是作為回調(diào)的接頭暗號(重試次數(shù)用完了,還是失敗,我們拋出這個Exception e?通知觸發(fā)這個回調(diào)方法)。對于@Recover注解的方法,需要特別注意的是:
- 方法的返回值必須與@Retryable方法一致。
- 方法的第一個參數(shù),必須是Throwable類型的,建議是與@Retryable?配置的異常一致,其他的參數(shù),需要哪個參數(shù),寫進去就可以了(@Recover方法中有的)。
- 該回調(diào)方法與重試方法寫在同一個實現(xiàn)類里面。
- 復(fù)java面試,獲取最新面試題資料。
(5)注意事項
- 由于是基于AOP實現(xiàn),所以不支持類里自調(diào)用方法。
- 如果重試失敗需要給@Recover注解的方法做后續(xù)處理,那這個重試的方法不能有返回值,只能是void。
- 方法內(nèi)不能使用try catch,只能往外拋異常。
- @Recover?注解來開啟重試失敗后調(diào)用的方法(注意,需跟重處理方法在同一個類中),此注解注釋的方法參數(shù)一定要是@Retryable拋出的異常,否則無法識別,可以在該方法中進行日志處理。
3.總結(jié)
本篇主要簡單介紹了Springboot中的Retryable的使用,主要的適用場景和注意事項,當(dāng)需要重試的時候還是很有用的。