快捷導(dǎo)航

Spring @Retryable注解輕松搞定循環(huán)重試功能

更新時(shí)間：2023年04月23日 09:20:41 作者：lockie_zou

spring系列的spring-retry是另一個(gè)實(shí)用程序模塊，可以幫助我們以標(biāo)準(zhǔn)方式處理任何特定操作的重試。在spring-retry中，所有配置都是基于簡(jiǎn)單注釋的。本文主要介紹了Spring@Retryable注解如何輕松搞定循環(huán)重試功能，有需要的朋友可以參考一下

這些錯(cuò)誤可能是因?yàn)榫W(wǎng)絡(luò)波動(dòng)造成的，等待過(guò)后重處理就能成功。通常來(lái)說(shuō)，會(huì)用try/catch，while循環(huán)之類的語(yǔ)法來(lái)進(jìn)行重處理，但是這樣的做法缺乏統(tǒng)一性，并且不是很方便，要多寫很多代碼。然而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依賴

 <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被調(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ù)的含義：

1、value：拋出指定異常才會(huì)重試

2、include：和value一樣，默認(rèn)為空，當(dāng)exclude也為空時(shí)，默認(rèn)所有異常

3、exclude：指定不處理的異常

4、maxAttempts：最大重試次數(shù)，默認(rèn)3次

5、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)方法，可以直接不寫回調(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;
}

可以看到傳參里面寫的是 Exception e，這個(gè)是作為回調(diào)的接頭暗號(hào)（重試次數(shù)用完了，還是失敗，我們拋出這個(gè)Exception e通知觸發(fā)這個(gè)回調(diào)方法）。

對(duì)于@Recover注解的方法，需要特別注意的是：

1、方法的返回值必須與@Retryable方法一致

2、方法的第一個(gè)參數(shù)，必須是Throwable類型的，建議是與@Retryable配置的異常一致，其他的參數(shù)，需要哪個(gè)參數(shù)，寫進(jìn)去就可以了（@Recover方法中有的）

3、該回調(diào)方法與重試方法寫在同一個(gè)實(shí)現(xiàn)類里面

5. 注意事項(xiàng)

1、由于是基于AOP實(shí)現(xiàn)，所以不支持類里自調(diào)用方法

2、如果重試失敗需要給@Recover注解的方法做后續(xù)處理，那這個(gè)重試的方法不能有返回值，只能是void

3、方法內(nèi)不能使用try catch，只能往外拋異常

4、@Recover注解來(lái)開(kāi)啟重試失敗后調(diào)用的方法(注意: 需跟重處理方法在同一個(gè)類中)，此注解注釋的方法參數(shù)一定要是@Retryable拋出的異常，否則無(wú)法識(shí)別，可以在該方法中進(jìn)行日志處理。

到此這篇關(guān)于Spring @Retryable注解輕松搞定循環(huán)重試功能的文章就介紹到這了,更多相關(guān)Spring @Retryable搞定循環(huán)重試內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: