Spring Boot @Retryable 教學新手必看完整指南

1. 什麼是 @Retryable？

定義與用途

@Retryable 是 Spring Retry 模組中的一個註解，旨在為方法提供自動重試的功能。當一個方法因為暫時性故障（例如網絡問題或數據庫短暫不可用）而失敗時，@Retryable 可以自動重試此方法，從而提高應用的穩定性和可靠性。這個註解能夠幫助開發者減少因為瞬時故障而導致的應用崩潰或錯誤響應。

應用場景

@Retryable 的應用場景非常廣泛，以下是一些常見的應用場景：

網絡請求：在進行第三方 API 請求時，網絡不穩定可能導致請求失敗。使用 @Retryable 可以自動重試請求。
數據庫操作：在對數據庫進行讀取或寫入操作時，可能因為數據庫繁忙或短暫故障而導致操作失敗。@Retryable 可以幫助重試這些操作。
消息隊列：在處理消息時，如果消費者未能成功處理消息，可以使用 @Retryable 來重試消息處理。

在選擇使用 @Retryable 時，開發者應考慮到應用的穩定性需求，並確保重試不會引起用戶體驗的顯著下降。

2. 如何在 Spring Boot 中使用 @Retryable

依賴設定

要在 Spring Boot 專案中使用 @Retryable，首先需要在項目的構建工具中添加 Spring Retry 依賴。

Maven

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

Gradle

implementation 'org.springframework.retry:spring-retry'

接著，確保在主應用類中啟用 Spring Retry 的功能，通常通過 @EnableRetry 註解來實現。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.retry.annotation.EnableRetry;

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

基本用法示範

使用 @Retryable 註解非常簡單，以下是一個基本的範例：

import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    @Retryable(value = {RuntimeException.class}, maxAttempts = 5, backoff = @Backoff(delay = 2000))
    public String unreliableMethod() {
        // 模擬一個可能會失敗的操作
        if (Math.random() > 0.7) {
            throw new RuntimeException("Temporary failure");
        }
        return "Success!";
    }
}

在這個範例中，unreliableMethod 方法可能會因為產生 RuntimeException 而失敗。使用 @Retryable 設定最大重試次數為 5 次，並在每次重試之間延遲 2000 毫秒。

解析範例中的關鍵參數

value：指定要重試的異常類型。在這裡，我們指定 RuntimeException.class。
maxAttempts：設定最大重試次數，這裡設為 5。
backoff：設定重試的間隔，這裡設為 2000 毫秒。

3. @Retryable 的參數與配置

常用參數

在使用 @Retryable 時，有幾個主要的參數可以配置：

參數名稱	說明
`value`	指定要重試的異常類型
`maxAttempts`	最大重試次數
`backoff`	設定重試間隔
`include`	指定要重試的異常類型（可選）
`exclude`	指定不重試的異常類型

自定義重試策略

如果預設的重試策略無法滿足特定需求，開發者可以自定義重試策略。例如，根據異常類型使用不同的重試策略：

import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;

@Service
public class CustomService {

    @Retryable(value = {DatabaseException.class}, maxAttempts = 3, backoff = @Backoff(delay = 1000))
    public void processDatabase() {
        // 數據庫操作
    }

    @Retryable(value = {NetworkException.class}, maxAttempts = 5, backoff = @Backoff(delay = 2000))
    public void processNetwork() {
        // 網絡請求操作
    }
}

在這個範例中，processDatabase 方法對於 DatabaseException 重試 3 次，而 processNetwork 方法對於 NetworkException 重試 5 次，顯示了如何根據不同的異常類型設置不同的重試策略。

4. 錯誤處理與回調

錯誤處理機制

在使用 @Retryable 時，必須考慮到如何處理重試過程中的異常。如果所有重試次數都用盡，通常需要一種機制來處理最終的失敗情況。這時，可以搭配使用 @Recover 註解來實現。

回調方法的設計

@Recover 方法用於定義如何處理重試失敗的情況。以下是一個範例：

import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;

@Service
public class RecoverService {

    @Retryable(value = {RuntimeException.class}, maxAttempts = 3)
    public String riskyMethod() {
        // 模擬失敗
        throw new RuntimeException("Failed operation");
    }

    @Recover
    public String recover(RuntimeException e) {
        // 錯誤處理邏輯
        return "Recovering from failure: " + e.getMessage();
    }
}

在這個範例中，如果 riskyMethod 方法因 RuntimeException 失敗，則會調用 recover 方法來處理最終的失敗情況。可在 recover 方法中記錄日誌、發送通知或執行其他的錯誤處理邏輯。

5. 整合 @Retryable 與 Spring 的其他功能

與 AOP 的整合

使用 AOP（面向切面編程）可以進一步增強 @Retryable 的功能。例如，可以使用 AOP 來攔截和記錄重試行為：

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class RetryAspect {

    private static final Logger logger = LoggerFactory.getLogger(RetryAspect.class);

    @Around("@annotation(org.springframework.retry.annotation.Retryable)")
    public Object logRetry(ProceedingJoinPoint joinPoint) throws Throwable {
        logger.info("Attempting to call method: {}", joinPoint.getSignature().getName());
        Object result;
        try {
            result = joinPoint.proceed();
        } catch (Throwable throwable) {
            logger.error("Method failed: {}", throwable.getMessage());
            throw throwable;
        }
        logger.info("Method succeeded: {}", joinPoint.getSignature().getName());
        return result;
    }
}

這樣一來，每當帶有 @Retryable 註解的方法被調用時，AOP 會自動記錄方法名稱及成功或失敗的情況。

與 Spring Cloud 的結合

在分散式架構中，使用 @Retryable 可以有效地處理微服務之間的重試邏輯。例如，在調用其他微服務的 API 時，使用 @Retryable 可以自動重試請求，從而提高系統的可用性。

import org.springframework.retry.annotation.Retryable;
import org.springframework.web.client.RestTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class ExternalService {

    @Autowired
    private RestTemplate restTemplate;

    @Retryable(value = {HttpServerErrorException.class}, maxAttempts = 3)
    public String callExternalApi() {
        return restTemplate.getForObject("http://external-service/api/data", String.class);
    }
}

在這個範例中，callExternalApi 方法會在遇到 HttpServerErrorException 時自動重試，從而提高對外部 API 請求的穩定性。

6. 性能考量與最佳實踐

性能影響

使用 @Retryable 可能會對性能產生影響，特別是在重試次數較多的情況下。每次重試都會增加延遲，這可能影響用戶體驗。在評估是否使用重試機制時，開發者應考慮重試的必要性，並根據具體情況進行調整。

最佳實踐建議

限制重試次數：設定合理的最大重試次數，避免無限重試導致的系統資源浪費。
動態調整重試策略：根據應用的運行狀況動態調整重試策略，確保在高負載時不會影響用戶體驗。
日誌記錄：對重試過程進行日誌記錄，便於後續的問題排查與分析。
定期評估：定期對重試策略的有效性進行評估，必要時進行調整以適應變化的需求。

透過這些最佳實踐，可以更有效地利用 @Retryable 來提高應用的穩定性，同時減少對性能的影響。

關於作者

Carger

我是Oscar (卡哥)，前Yahoo Lead Engineer、高智商同好組織Mensa會員，超過十年的工作經驗，服務過Yahoo關鍵字廣告業務部門、電子商務及搜尋部門，喜歡彈吉他玩音樂，也喜歡投資美股、虛擬貨幣，樂於與人分享交流！