一個註解@Recover搞定醜陋的迴圈重試程式碼

淼淼之森發表於2022-03-30

使用背景

在實際專案中其中一部分邏輯可能會因為呼叫了外部服務或者等待鎖等情況下出現不可預料的異常，在這個時候我們可能需要對呼叫這部分邏輯進行重試，程式碼裡面主要就是使用for迴圈寫一大坨重試的邏輯，各種硬編碼，各種辣眼睛的補丁。

特別是針對重試的邏輯，到處都有。所以我決定用一個重試元件spring-retry優化一波。它的出現，解決掉這部分醜陋的程式碼！

這個元件的原始碼地址如下：https://github.com/spring-projects/spring-retry

廢話不多說，直接上程式碼吧！

開始上程式碼

首先引入依賴：

<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
    <version>1.3.2</version>
</dependency>

由於該元件是依賴於 AOP 給你的，所以還需要引入這個依賴（如果你其他 jar 包中引用過了，當然也就不需要再次引用了）：

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

開啟重試：

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

Controller層

@RestController
public class TestController {
@Autowired
private IRecursiveCallService recursiveCallService;

    @GetMapping("test2")
    public Object test2() {
        return recursiveCallService.testService();
    }
}

Service層

public interface IRecursiveCallService {

    /**
     * 測試service
     *
     * @return
     */
    List<Integer> testService();
}

Service層具體實現

@Service
public class RecursiveCallServiceImpl implements IRecursiveCallService {

    @Override
    @Retryable(recover = "testService3")
    public List<Integer> testService() {
        System.out.println("到此一遊！");
        System.out.println(1 / 0);
        return null;
    }

    @Recover
    public List<String> testService1() {
        System.out.println("錯誤的返回");
        return Collections.singletonList("S");
    }

    @Recover
    public List<Integer> testService2(String i) {
        System.out.println("正確的返回");
        return Collections.singletonList(1);
    }

    @Recover
    public List<Integer> testService3() {
        System.out.println("正確的返回2");
        return Collections.singletonList(2);
    }
}

@Retryable註解重要屬性解析

  • recover: 此類中用於恢復的方法的名稱。方法必須用 {@link Recover} 註釋標記。
  • value: 可重試的異常型別。包括（）的同義詞。預設為空（如果 excludes 也為空，則重試所有異常）。
  • exclude: 不可重試的異常型別。預設為空（如果包含也為空，則重試所有異常）。如果 include 為空但 excludes 不是，則重試所有未排除的異常
  • maxAttempts: 方法重試呼叫次數，預設3次
  • backoff: 指定用於重試此操作的其他屬性

@backoff註解

  • value：重試之間間隔時間
  • delay：重試之間的等待時間(以毫秒為單位)
  • maxDelay：重試之間的最大等待時間(以毫秒為單位)
  • multiplier：指定延遲的倍數
  • delayExpression：重試之間的等待時間表示式
  • maxDelayExpression：重試之間的最大等待時間表示式
  • multiplierExpression：指定延遲的倍數表示式
  • random：隨機指定延遲時間

@Recover註解

主要作用是標記方法為一個重試方法的補償方法！！！

注意事項

  • 方法重試依賴於 spring 注入，所以呼叫的方法的類必須是被spring管理的，然後通過 @Autowired 或 @Resource 引入使用，不然不會生效
  • 方法重試的前提是方法丟擲了異常，在方法執行出現了異常且沒有被捕獲的情況下重試
  • 方法重試需要在方法上面加上註解 @Retryable
  • 方法重試的補償方法上面必須攜帶@Recover註解
  • @Recover方法需要和@Retryable方法在同一個類中才能生效@Recover方法(@Recover方法在父類中也可以生效)
  • 使用@Retryable註解，如果類中沒有被@Recover標示的方法，無論是否使用 recover 屬性都丟擲原有異常
  • 使用@Retryable註解同時 recover 屬性不是空，如果類中有@Recover標示的方法，但是標示的方法不是 recover 指定的方法，丟擲ExhaustedRetryException異常
  • 使用@Retryable註解同時 recover 屬性不是空，同時方法有註解@Recover，但是補償方法的引數不是當前異常或者異常的父類，丟擲ExhaustedRetryException 異常
  • 使用@Retryable註解不使用 recover 屬性，如果類中被@Recover標示的方法有和原方法返回值一樣的，使用當前被@Recover標示的方法（此時方法引數可隨意，但是不能是除開當前異常的類及父類的異常類）

相關文章