前言
在實際的軟件開發中，尤其是在涉及網絡請求、數據庫操作或外部服務調用的場景下，我們常常會遇到一些臨時性故障（Transient Failures），例如網絡波動、數據庫連接超時、第三方 API 暫時不可用等。面對這些問題，一種常見的解決方案就是自動重試機制。
Spring Retry 是 Spring 提供的一個模塊，它可以幫助我們以聲明式的方式為方法添加重試功能，從而提升系統的健壯性和可用性。
一、什么是 Spring Retry？
Spring Retry 是 Spring 框架中的一個子項目，提供了對方法調用失敗后進行自動重試的支持。它不僅支持簡單的重試邏輯，還支持重試策略、回退策略以及與 Spring AOP 集成，使得我們可以非常方便地在業務代碼中加入重試邏輯。
二、Spring Retry 的核心組件
1. RetryTemplate
RetryTemplate 是 Spring Retry 的核心類之一，它封裝了重試邏輯的執行過程。你可以通過配置 RetryPolicy 和 BackOffPolicy 來定義重試次數和等待策略。
RetryTemplate retryTemplate = new RetryTemplate();// 設置最多重試3次（包括第一次嘗試）
retryTemplate.setRetryPolicy(new SimpleRetryPolicy(3));// 設置固定間隔2秒再重試
retryTemplate.setBackOffPolicy(new FixedBackOffPolicy(2000L));retryTemplate.execute(context -> {// 調用可能會失敗的方法someService.doSomething();return null;
});
2. RetryPolicy
定義哪些異常需要重試，以及最大重試次數。常用的有：
SimpleRetryPolicy：基于次數的重試。ExceptionClassifierRetryPolicy：根據異常類型決定是否重試。NeverRetryPolicy：從不重試。AlwaysRetryPolicy：無限重試。
3. BackOffPolicy
定義重試之間的等待策略。常用的有：
FixedBackOffPolicy：固定時間間隔。ExponentialBackOffPolicy：指數退避策略（推薦）。NoBackOffPolicy：不等待。
4. RetryListener
可以監聽重試的不同階段，比如開始、重試、結束等事件，用于日志記錄或監控。
三、使用注解方式實現重試（推薦）
Spring Retry 支持通過注解的方式簡化重試邏輯的編寫，只需在方法上添加 @Retryable 注解即可。
1. 引入依賴（Maven）
<dependency><groupId>org.springframework.retry</groupId><artifactId>spring-retry</artifactId><version>1.3.5</version>
</dependency><!-- 同時需要啟用 AspectJ -->
<dependency><groupId>org.aspectj</groupId><artifactId>aspectjweaver</artifactId><version>1.9.7</version>
</dependency>
2. 啟用 Retry 功能
在配置類或啟動類上加上 @EnableRetry 注解：
@SpringBootApplication
@EnableRetry
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}
3. 在方法上使用 @Retryable
@Service
public class MyService {@Retryable(maxAttempts = 3, backoff = @Backoff(delay = 2000))public void doSomething() {// 可能拋出異常的方法體if (Math.random() < 0.7) {throw new RuntimeException("Temporary failure");}System.out.println("Success!");}
}
上面的例子表示：
- 最多嘗試 3 次；
- 每次失敗后等待 2 秒；
- 默認只對
RuntimeException進行重試。
你也可以指定特定異常：
@Retryable(value = {IOException.class}, maxAttempts = 5)
或者排除某些異常：
@Retryable(exclude = {SQLException.class})
四、@Retryable 注解參數詳解
在使用 Spring Retry 的注解方式時，@Retryable 是最核心的注解之一。它提供了多個可配置項，用于定義方法的重試行為。下面是一個詳細的參數說明表：
| 參數名 | 類型 | 默認值 | 描述 |
|---|---|---|---|
value / include | Class<? extends Throwable>[] | {RuntimeException.class} | 指定需要重試的異常類型，默認對所有 RuntimeException 進行重試。 |
exclude | Class<? extends Throwable>[] | {} | 排除某些異常類型，這些異常不會觸發重試。 |
maxAttempts | int | 3 | 最大嘗試次數（包括第一次調用）。 |
maxAttemptsExpression | String | null | 支持通過 SpEL 表達式動態設置最大嘗試次數。 |
backoff | Backoff | @Backoff(delay = 1000L) | 設置退避策略，如固定延遲、指數退避等。 |
interceptorBeanName | String | "" | 自定義攔截器 Bean 名稱（不常用）。 |
label | String | "" | 給重試操作添加標簽，可用于監聽器識別。 |
stateful | boolean | false | 是否為有狀態重試（適用于冪等性要求高的場景）。 |
示例：更復雜的 @Retryable 配置
@Retryable(value = {IOException.class, TimeoutException.class},exclude = SQLException.class,maxAttempts = 5,backoff = @Backoff(delay = 2000, multiplier = 1.5, maxDelay = 10000),stateful = true
)
public void retryableMethod() {// 方法邏輯
}
在這個例子中：
- 只對
IOException和TimeoutException進行重試； - 排除
SQLException； - 最多重試 5 次；
- 使用指數退避策略，初始延遲 2 秒，每次乘以 1.5 倍，最長延遲不超過 10 秒；
- 啟用了有狀態重試（適合涉及外部狀態變更的操作）；
五、高級用法：結合監聽器
你可以通過自定義監聽器來記錄每次重試的日志信息：
@Component
public class MyRetryListener implements RetryListener {@Overridepublic <T, E extends Throwable> boolean open(RetryContext context, RetryCallback<T, E> callback) {System.out.println("Retry: Open");return true;}@Overridepublic <T, E extends Throwable> void close(RetryContext context, RetryCallback<T, E> callback, Throwable throwable) {System.out.println("Retry: Close");}@Overridepublic <T, E extends Throwable> void onError(RetryContext context, RetryCallback<T, E> callback, Throwable throwable) {System.out.println("Retry: Error occurred, attempt " + context.getRetryCount());}
}
然后注冊到 RetryTemplate 中：
retryTemplate.registerListener(new MyRetryListener());
六、注意事項
- 冪等性問題：重試操作必須是冪等的，否則重復執行可能導致數據錯誤。
- 事務控制：如果方法處于事務中，注意事務傳播行為，避免因重試引發事務沖突。
- 性能影響：合理設置重試次數和等待時間，防止系統負載過高。
- 異步 vs 同步：Spring Retry 是同步的，如需異步重試需自行結合線程池處理。
七、總結
Spring Retry 是一個輕量但功能強大的重試框架，它通過模板模式和注解方式幫助開發者快速實現方法級別的自動重試。無論是在微服務調用、消息消費、數據庫訪問等場景中，都可以靈活應用。
合理使用 Spring Retry，可以讓我們的系統更加健壯，有效應對各種瞬時故障。
