SpringBoot中使用spring-retry 解決失敗重試調(diào)用

更新時間：2023年07月28日 15:41:12 作者：莫輕言舞

本文主要介紹了SpringBoot中使用spring-retry 解決失敗重試調(diào)用，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

在日常開發(fā)過程中，難免會與第三方接口發(fā)生交互，例如：短信發(fā)送、遠程服務調(diào)用、爭搶鎖等場景，當正常調(diào)用發(fā)生異常時，例如：網(wǎng)絡抖動，這些間歇性的異常在一段時候之后會自行恢復，程序為了更加健壯并且更不容易出現(xiàn)故障，需要重新觸發(fā)業(yè)務操作，以防止間歇性的異常對程序照成的影響。

常用的重試策略，比如通過 while 循環(huán)手動重復調(diào)用或是通過 JDK/CGLib 動態(tài)代理的方式來進行重試。但是這種方法比較笨重，且對原有邏輯代碼的入侵性比較大。

1、引入spring-retry

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
</dependency>

這里我們還引入了 aop 的依賴，因為 spring-retry 的原理就是基于 aop 來實現(xiàn)的

2、開啟spring-retry

啟動類上增加注解 @EnableRetry

@EnableRetry
@SpringBootApplication
public class AsurplusApplication {
    public static void main(String[] args) {
        SpringApplication.run(AsurplusApplication.class, args);
    }
}

3、@Retryable

在需要重試的方法上增加注解 @Retryable，表示該方法需要重試

@Component
public class TestRetry {
    int a = 0;
    @Retryable(value = {RuntimeException.class}, maxAttempts = 5, backoff = @Backoff(delay = 1000, multiplier = 2))
    public String test() {
        a++;
        System.out.println(a + " - " + System.currentTimeMillis());
        if (a < 10) {
            throw new RuntimeException("未滿足條件");
        }
        return "執(zhí)行成功";
    }
}

@Retryable 注解

value，可重試的異常類型。含義同include。默認為空(如果excludes也為空，則重試所有異常)
include：可重試的異常類型。默認為空(如果excludes也為空，則重試所有異常)
exclude：無需重試的異常類型。默認為空(如果includes也為空，則重試所有異常)
maxAttempts：最大重試次數(shù)(包括第一次失敗)，默認為3次
backoff：重試等待策略,下面會在@Backoff中介紹
recover：表示重試次數(shù)到達最大重試次數(shù)后的回調(diào)方法

@Backoff 注解

delay，重試之間的等待時間(以毫秒為單位)
maxDelay，重試之間的最大等待時間(以毫秒為單位)
multiplier，指定延遲的倍數(shù)
delayExpression，重試之間的等待時間表達式
maxDelayExpression，重試之間的最大等待時間表達式
multiplierExpression，指定延遲的倍數(shù)表達式
random，隨機指定延遲時間

4、重試耗盡

當重試耗盡時，RetryOperations 可以將控制傳遞給另一個回調(diào)，即 RecoveryCallback。Spring-Retry 還提供了 @Recover 注解，用于 @Retryable 重試失敗后處理方法。若不需要重試失敗后的處理方法，則不寫回調(diào)方法，重試耗盡后拋出異常。

@Recover
public String recoverTest(RuntimeException e) {
    return "回調(diào)方法-" + e.getMessage();
}

方法的返回值必須與 @Retryable 方法一致
方法的第一個參數(shù)，必須是 Throwable 類型的，建議是與 @Retryable 配置的異常一致，其他的參數(shù)，需要哪個參數(shù)，寫進去就可以了（@Recover 方法中有的）
該回調(diào)方法與重試方法寫在同一個實現(xiàn)類里面

若同一個實現(xiàn)類中有多個回調(diào)方法，我們需要使用 recover 屬性指定回調(diào)的方法名

@Component
public class TestRetry {
    int a = 0;
    @Retryable(recover = "recoverTest1", value = {RuntimeException.class}, maxAttempts = 5, backoff = @Backoff(delay = 1000, multiplier = 2))
    public String test() {
        a++;
        System.out.println(a + " - " + System.currentTimeMillis());
        if (a < 10) {
            throw new RuntimeException("未滿足條件");
        }
        return "執(zhí)行成功";
    }
    @Recover
    public String recoverTest(RuntimeException e) {
        return "回調(diào)方法-" + e.getMessage();
    }
    @Recover
    public String recoverTest1(RuntimeException e) {
        return "回調(diào)方法1-" + e.getMessage();
    }
}

指定了回調(diào)方法為 recoverTest1