在實(shí)際工作中欠拾，重處理是一個(gè)非常常見(jiàn)的場(chǎng)景胰锌，比如:
- 發(fā)送消息失敗。
- 調(diào)用遠(yuǎn)程服務(wù)失敗藐窄。
- 爭(zhēng)搶鎖失敗资昧。
這些錯(cuò)誤可能是因?yàn)榫W(wǎng)絡(luò)波動(dòng)造成的，等待過(guò)后重處理就能成功枷邪。通常來(lái)說(shuō)榛搔，會(huì)用try/catch诺凡，while循環(huán)之類(lèi)的語(yǔ)法來(lái)進(jìn)行重處理东揣，但是這樣的做法缺乏統(tǒng)一性，并且不是很方便腹泌，要多寫(xiě)很多代碼嘶卧。
然而spring-retry卻可以通過(guò)注解，在不入侵原有業(yè)務(wù)邏輯代碼的方式下凉袱，優(yōu)雅的實(shí)現(xiàn)重處理功能芥吟。
一侦铜、@Retryable是什么？
spring系列的spring-retry是另一個(gè)實(shí)用程序模塊钟鸵，可以幫助我們以標(biāo)準(zhǔn)方式處理任何特定操作的重試钉稍。在spring-retry中，所有配置都是基于簡(jiǎn)單注釋的棺耍。
二贡未、使用步驟
1.POM依賴(lài)
<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)用,時(shí)間："+LocalTime.now());
if (code==0){
throw new Exception("情況不對(duì)頭！");
}
System.out.println("test被調(diào)用,情況對(duì)頭了蒙袍！");
return 200;
}
}
來(lái)簡(jiǎn)單解釋一下注解中幾個(gè)參數(shù)的含義：
-
value：拋出指定異常才會(huì)重試 -
include：和value一樣俊卤，默認(rèn)為空，當(dāng)exclude也為空時(shí)害幅，默認(rèn)所有異常 -
exclude：指定不處理的異常 -
maxAttempts：最大重試次數(shù)消恍，默認(rèn)3次 -
backoff：重試等待策略，默認(rèn)使用@Backoff以现，@Backoff的value默認(rèn)為1000L狠怨，我們?cè)O(shè)置為2000L；multiplier（指定延遲倍數(shù)）默認(rèn)為0邑遏，表示固定暫停1秒后進(jìn)行重試取董，如果把multiplier設(shè)置為1.5，則第一次重試為2秒无宿，第二次為3秒茵汰，第三次為4.5秒。
當(dāng)重試耗盡時(shí)還是失敗孽鸡，會(huì)出現(xiàn)什么情況呢蹂午？
當(dāng)重試耗盡時(shí)，RetryOperations可以將控制傳遞給另一個(gè)回調(diào)彬碱，即RecoveryCallback豆胸。Spring-Retry還提供了@Recover注解，用于@Retryable重試失敗后處理方法巷疼。如果不需要回調(diào)方法晚胡，可以直接不寫(xiě)回調(diào)方法，那么實(shí)現(xiàn)的效果是嚼沿，重試次數(shù)完了后估盘，如果還是沒(méi)成功沒(méi)符合業(yè)務(wù)判斷，就拋出異常骡尽。
4.@Recover
@Recover
public int recover(Exception e, int code){
System.out.println("回調(diào)方法執(zhí)行Ｇ餐住！Ｅ氏浮箫踩！");
//記日志到數(shù)據(jù)庫(kù) 或者調(diào)用其余的方法
return 400;
}
可以看到傳參里面寫(xiě)的是 Exception e爱态，這個(gè)是作為回調(diào)的接頭暗號(hào)（重試次數(shù)用完了，還是失敗境钟，我們拋出這個(gè)Exception e通知觸發(fā)這個(gè)回調(diào)方法）锦担。
對(duì)于@Recover注解的方法，需要特別注意的是：
- 方法的返回值必須與
@Retryable方法一致 - 方法的第一個(gè)參數(shù)慨削，必須是Throwable類(lèi)型的吆豹，建議是與
@Retryable配置的異常一致，其他的參數(shù)理盆，需要哪個(gè)參數(shù)痘煤，寫(xiě)進(jìn)去就可以了（@Recover方法中有的） - 該回調(diào)方法與重試方法寫(xiě)在同一個(gè)實(shí)現(xiàn)類(lèi)里面
5. 注意事項(xiàng)
- 由于是基于AOP實(shí)現(xiàn)，所以不支持類(lèi)里自調(diào)用方法
- 如果重試失敗需要給
@Recover注解的方法做后續(xù)處理猿规，那這個(gè)重試的方法不能有返回值衷快，只能是void - 方法內(nèi)不能使用
try catch，只能往外拋異常 -
@Recover注解來(lái)開(kāi)啟重試失敗后調(diào)用的方法(注意,需跟重處理方法在同一個(gè)類(lèi)中)姨俩，此注解注釋的方法參數(shù)一定要是@Retryable拋出的異常蘸拔，否則無(wú)法識(shí)別，可以在該方法中進(jìn)行日志處理环葵。
