一個注解@Recover搞定丑陋的回圈重試代碼

使用背景

在實際專案中其中一部分邏輯可能會因為呼叫了外部服務或者等待鎖等情況下出現不可預料的例外，在這個時候我們可能需要對呼叫這部分邏輯進行重試，代碼里面主要就是使用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標示的方法（此時方法引數可隨意，但是不能是除開當前例外的類及父類的例外類）

標籤：Java

上一篇：Java案例——HashMap集合存盤學生物件并遍歷

下一篇：markdown語法