接口請求重試的八種方法，你用哪種？
大家都知道老三是做跨境業務的，在跨境業務中，可能第三方的服務器分布在世界的各個角落，所以請求三方接口的時候，難免會遇到一些網絡問題，這時候需要加入重試機制了，這期就給大家分享幾個接口重試的寫法。
重試機制實現
8種重試機制實現
1. 循環重試
這是最簡單也最直接的一種方式。在請求接口的代碼塊中加入循環，如果請求失敗則繼續請求，直到請求成功或達到最大重試次數。
示例代碼：
int retryTimes = 3;
for(int i = 0; i < retryTimes; i++){
try{
// 請求接口的代碼
break;
}catch(Exception e){
// 處理異常
Thread.sleep(1000); // 延遲1秒后重試
}
}這段簡單的示例代碼里，直接用了一個for循環來進行重試，最大重試次數設置為3次。同時在發生異常的時候，為了避免頻繁請求，使用Thread.sleep()加一個適當的延遲。
2. 使用遞歸結構
除了循環，還可以使用遞歸來實現接口的請求重試。遞歸是我們都比較熟悉的編程技巧，在請求接口的方法中調用自身，如果請求失敗則繼續調用，直到請求成功或達到最大重試次數。
示例代碼：
public void requestWithRetry(int retryTimes){
if(retryTimes <= 0) return;
try{
// 請求接口的代碼
}catch(Exception e){
// 處理異常
Thread.sleep(1000); // 延遲1秒后重試
requestWithRetry(retryTimes - 1);
}
}這段代碼里，我們定義了一個名為requestWithRetry的方法，其中retryTimes表示最大重試次數。如果重試次數小于等于0，則直接返回。否則，在捕獲到異常后，我們使用Thread.sleep()方法來添加一個適當的延遲，然后調用自身進行重試。
3.使用網絡工具的內置重試機制
我們常用的一些HTTP客戶端通常內置了一些重試機制，只需要在創建對應的客戶端實例的時候進行配置即可，以Apache HttpClient為例：
- 4.5+版本：使用 HttpClients.custom().setRetryHandler() 方法來設置重試機制
CloseableHttpClient httpClient = HttpClients.custom()
.setRetryHandler(new DefaultHttpRequestRetryHandler(3, true))
.build();- 5.x版本：使用HttpClients.custom().setRetryStrategy()方法來設置重試機制
CloseableHttpClient httpClient = HttpClients.custom()
.setRetryStrategy(new DefaultHttpRequestRetryStrategy(3,NEG_ONE_SECOND))
.build();在上面的示例代碼中，我們使用DefaultHttpRequestRetryHandler或DefaultHttpRequestRetryStrategy來創建一個重試機制，最大重試次數為3次。如果請求失敗，則會自動重試。
Apache HttpClient還支持自定義重試策略，可以可以實現HttpRequestRetryHandler接口（4.5+版本）或者RetryStrategy接口（5.x版本），并根據需要進行重試邏輯的實現。
這是一個自定義重試策略的示例：
CloseableHttpClient httpClient = HttpClients.custom()
.setRetryStrategy((response, executionCount, context) -> {
if (executionCount > 3) {
// 如果重試次數超過3次，則放棄重試
return false;
}
int statusCode = response.getCode();
if (statusCode >= 500 && statusCode < 600) {
// 如果遇到服務器錯誤狀態碼，則進行重試
return true;
}
// 其他情況不進行重試
return false;
})
.build();4.使用Spring Retry庫
當在Spring項目中使用重試機制時，可以使用Spring Retry庫來實現。Spring Retry提供了一組注解和工具類，可以方便地為方法添加重試功能。
<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
<version>1.3.1</version>
</dependency>Spring Retry的使用有兩種方式，一種是使用RetryTemplate來顯式調用需要重試的方法，一種實用注解來自動觸發重試。
顯式使用RetryTemplate
- 創建RetryTemplate對象并配置重試策略：
RetryTemplate retryTemplate = new RetryTemplate();
// 配置重試策略
RetryPolicy retryPolicy = new SimpleRetryPolicy(3);
retryTemplate.setRetryPolicy(retryPolicy);
// 配置重試間隔策略
FixedBackOffPolicy backOffPolicy = new FixedBackOffPolicy();
backOffPolicy.setBackOffPeriod(1000);
retryTemplate.setBackOffPolicy(backOffPolicy);在代碼里，我們創建了一個RetryTemplate對象，并配置了重試策略和重試間隔策略。這里使用了SimpleRetryPolicy來指定最大重試次數為3次，使用FixedBackOffPolicy來指定重試間隔為1秒。
- 使用RetryTemplate調用方法：
retryTemplate.execute((RetryCallback<Void, Exception>) context -> {
// 請求接口的代碼
return null;
});代碼里，我們使用retryTemplate.execute()方法來執行需要重試的代碼塊。在RetryCallback的doWithRetry()方法中，可以編寫需要重試的邏輯。如果方法執行失敗，RetryTemplate會根據配置的重試策略和重試間隔策略進行重試。
Spring Retry是一個提供重試機制的庫，可以方便地在Spring項目中使用。使用@Retryable注解標記需要重試的方法，如果方法拋出異常則會自動重試。
@Retryable(value = Exception.class, maxAttempts = 3)
public void request(){
// 請求接口的代碼
}Spring Retry提供了多種重試策略和重試間隔策略，我們可以根據具體的業務需求選擇合適的策略：
- 重試策略：
SimpleRetryPolicy：指定最大重試次數。
TimeoutRetryPolicy：指定最大重試時間。
AlwaysRetryPolicy：無條件進行重試。
- 重試間隔策略：
FixedBackOffPolicy：固定間隔重試。
ExponentialBackOffPolicy：指數遞增間隔重試。
UniformRandomBackOffPolicy：隨機間隔重試。
通過配置不同的重試策略和重試間隔策略，可以靈活地控制重試行為。Spring Retry還提供了自定義重試策略和重試間隔策略，可以通過實現RetryPolicy 接口和BackOffPolicy 接口，分別實現自定義的重試策略和重試間隔策略。
使用注解調用
除了顯式使用RetryTemplate調用，Spring Retry還提供了注解方式來觸發重試。
- 配置重試切面：
@Configuration
@EnableRetry
public class RetryConfig {
// 配置其他的Bean
}代碼里，我們使用@Configuration注解將類標記為配置類，使用@EnableRetry注解啟用重試功能。
- 使用@Retryable注解標記需要重試的方法：
@Retryable(maxAttempts = 3)
public void request() {
// 請求接口的代碼
}我們使用@Retryable注解標記了request()方法，指定了最大重試次數為3次。
- 調用被標記的方法：
@Autowired
private HttpService httpService;
httpService.request();在SpringBoot項目里使用更加地簡單，使用@EnableRetry注解啟用Spring Retry功能，并在需要進行重試的方法上添加@Retryable注解。
示例代碼：
@SpringBootApplication
@EnableRetry // 啟用Spring Retry功能
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
@Service
public class MyService {
@Retryable(value = {MyException.class}, maxAttempts = 3, backoff = @Backoff(delay = 1000))
public void doSomething() {
// 需要進行重試的方法邏輯
}
}代碼里，@EnableRetry注解啟用了Spring Retry功能，@Retryable注解標記了需要進行重試的方法，并指定了重試的異常類型、最大重試次數和重試間隔。
其中，@Backoff注解用于指定重試間隔策略，delay屬性表示每次重試之間的間隔時間。在這個例子中，每次重試之間的間隔時間為1秒。
需要注意的是，@Retryable注解只能標記在public方法上。如果需要在非public方法上使用重試功能，可以使用代理模式實現。
另外，如果需要在重試過程中進行一些特定的操作，比如記錄日志、發送消息等，可以在重試方法中使用RetryContext參數，它提供了一些有用的方法來獲取重試的上下文信息。例如：
@Service
public class MyService {
@Retryable(value = {MyException.class}, maxAttempts = 3, backoff = @Backoff(delay = 1000))
public void doSomething(RetryContext context) {
// 獲取重試次數
int retryCount = context.getRetryCount();
// 獲取上一次異常
Throwable lastThrowable = context.getLastThrowable();
// 記錄日志、發送消息等操作
// ...
// 需要進行重試的方法邏輯
}
}5.使用Resilience4j庫
Resilience4j是一個輕量級的，易于使用的容錯庫，提供了重試、熔斷、限流等多種機制。
<dependency>
<groupId>io.github.resilience4j</groupId>
<artifactId>resilience4j-spring-boot2</artifactId>
<version>1.7.0</version>
</dependency>我們來看下Resilience4j的使用，Resilience4j也支持代碼顯式調用和注解配置調用。
通過代碼顯式調用
- 創建創建一個RetryRegistry對象：首先，需要創建一個RetryRegistry對象，用于管理Retry實例。可以使用RetryRegistry.ofDefaults()方法創建一個默認的RetryRegistry對象。
RetryRegistry retryRegistry = RetryRegistry.ofDefaults();- 配置Retry實例：接下來，可以通過RetryRegistry對象創建和配置Retry實例。可以使用RetryConfig類來自定義Retry的配置，包括最大重試次數、重試間隔等。
RetryConfig config = RetryConfig.custom()
.maxAttempts(3)
.waitDuration(Duration.ofMillis(1000))
.retryOnResult(response -> response.getStatus() == 500)
.retryOnException(e -> e instanceof WebServiceException)
.retryExceptions(IOException.class, TimeoutException.class)
.ignoreExceptions(BusinessException.class, OtherBusinessException.class)
.failAfterMaxAttempts(true)
.build();
Retry retry = retryRegistry.retry("name", config);通過以上代碼，我們創建了一個名為"name"的Retry實例，并配置了最大重試次數為3次，重試間隔為1秒，當返回結果的狀態碼為500時進行重試，當拋出WebServiceException異常時進行重試，忽略BusinessException和OtherBusinessException異常，達到最大重試次數后拋出MaxRetriesExceededException異常。
- 使用Retry調用：最后，可以使用Retry來裝飾和執行需要進行重試的代碼塊。比如，可以使用Retry.decorateCheckedSupplier()方法來裝飾一個需要重試的Supplier。
CheckedFunction0<String> retryableSupplier = Retry.decorateCheckedSupplier(retry, () -> {
// 需要進行重試的代碼
return "result";
});通過注解調用
通過注解的方式，使用Resilience4j來使用重試功能，更加簡潔。
在Spring Boot項目中，可以使用@Retryable注解來標記需要進行重試的方法。
@Service
public class MyService {
@Retryable(value = {MyException.class}, maxAttempts = 3, backoff = @Backoff(delay = 1000))
public void doSomething() {
// 需要進行重試的方法邏輯
}
}代碼里，@Retryable注解標記了doSomething()方法，指定了重試的異常類型為MyException.class，最大重試次數為3次，重試間隔為1秒。
6.自定義重試工具類
如果說我們不想在項目里額外地引入一些重試的框架，自己定義一個重試工具類也是可以的，這是我在某個第三方提供的client-sdk里發現的一套重試工具類，比較輕量級，給大家分享一下。
- 首先，定義一個實現了Callback抽象類的具體回調類，實現其中的doProcess()方法來執行需要重試的邏輯。回調類的doProcess()方法返回一個RetryResult對象，表示重試的結果。
public abstract class Callback {
public abstract RetryResult doProcess();
}- 然后，定義一個RetryResult類，用于封裝重試的結果。RetryResult類包含一個isRetry屬性表示是否需要進行重試，以及一個obj屬性表示重試的結果對象。
public class RetryResult {
private Boolean isRetry;
private Object obj;
// 構造方法和getter方法省略
public static RetryResult ofResult(Boolean isRetry, Object obj){
return new RetryResult(isRetry, obj);
}
public static RetryResult ofResult(Boolean isRetry){
return new RetryResult(isRetry, null);
}
}- 最后，定義一個RetryExecutor類，其中的execute()方法接收一個重試次數和一個回調對象，根據重試次數循環執行回調對象的doProcess()方法，直到達到最大重試次數或回調對象返回不需要重試的結果。
public class RetryExecutor {
public static Object execute(int retryCount, Callback callback) {
for (int curRetryCount = 0; curRetryCount < retryCount; curRetryCount++) {
RetryResult retryResult = callback.doProcess();
if (retryResult.isRetry()) {
continue;
}
return retryResult.getObj();
}
return null;
}
}- 使用這個自定義的重試工具類時，只需要實現一個繼承自Callback的回調類，并在其中實現具體的重試邏輯。然后，通過調用RetryExecutor.execute()方法來執行重試操作。這里直接用了一個匿名的實現：
//最大重試次數
int maxRetryCount = 3;
Object result = RetryExecutor.execute(maxRetryCount, new Callback() {
@Override
public RetryResult doProcess() {
// 執行需要重試的邏輯
// 如果需要重試，返回 RetryResult.ofResult(true)
// 如果不需要重試，返回 RetryResult.ofResult(false, result)
}
});7.并發框架異步重試
在有些需要快速響應的場景下，我們可以使用并發框架，來實現異步的重試。
比如使用線程池ThreadPoolExecutor，把請求接口轉化成一個異步任務，將任務放入線程池中異步執行，并發地重試請求接口。可以在任務執行完成后，判斷任務執行結果，如果失敗則繼續重試。
int maxRetryTimes = 3;
int currentRetryTimes = 0;
ThreadPoolExecutor executor = new ThreadPoolExecutor(
10, // 核心線程數
10, // 最大線程數
0L, // 空閑線程存活時間
TimeUnit.MILLISECONDS, // 時間單位
new LinkedBlockingQueue<>() // 任務隊列
);
Callable<String> task = () -> {
// 請求接口的代碼
return "result";
};
Future<String> future;
while (currentRetryTimes < maxRetryTimes) {
try {
future = executor.submit(task);
String result = future.get();
// 判斷任務執行結果
break;
} catch (Exception e) {
currentRetryTimes++;
// 處理異常
try {
Thread.sleep(1000);
} catch (InterruptedException ex) {
Thread.currentThread().interrupt();
}
}
}在這個示例中，我們直接使用ThreadPoolExecutor來創建線程池，設置核心線程數和最大線程數為10，使用LinkedBlockingQueue作為任務隊列。然后，我們定義了一個Callable類型的任務，用于執行請求接口的代碼。在重試的過程中，我們使用executor.submit(task)提交任務并獲得一個Future對象，通過future.get()獲取任務的執行結果。如果任務執行成功，則跳出循環；如果任務執行失敗，則繼續重試，直到達到最大重試次數。
8. 消息隊列重試
在某些情況下，我們希望盡可能保證重試的可靠性，不會因為服務中斷，而導致重試任務的丟失，我們可以引入消息隊列。我們直接把消息投遞到消息隊列里，通過對消息的消費，來實現重試機制。
使用RocketMQ的示例代碼如下：
@Component
@RocketMQMessageListener(topic = "myTopic", consumerGroup = "myConsumerGroup")
public class MyConsumer implements RocketMQListener<String> {
@Override
public void onMessage(String message) {
try {
// 請求接口的代碼
} catch (Exception e) {
// 處理異常
DefaultMQProducer producer = new DefaultMQProducer("myProducerGroup");
producer.setNamesrvAddr("127.0.0.1:9876");
try {
producer.start();
Message msg = new Message("myTopic", "myTag", message.getBytes());
producer.send(msg);
} catch (Exception ex) {
// 處理發送異常
} finally {
producer.shutdown();
}
}
}
}上面的代碼里，我們使用@RocketMQMessageListener注解標記MyConsumer類，并指定了消費者的相關配置，包括消費者組和訂閱的主題。
在onMessage()方法中，我們處理請求的邏輯。如果請求失敗，我們創建一個RocketMQ的生產者，并將請求重新發送到消息隊列中，等待下一次處理。
通過使用消息隊列（如RocketMQ）來實現重試機制，可以提高系統的可靠性和穩定性。即使在服務中斷的情況下，重試任務也不會丟失，而是等待服務恢復后再次進行處理。
最佳實踐和注意事項
在請求重試的時候，我們也要注意一些關鍵點，以免因為重試，引發更多的問題：
- 合理設置重試次數和重試間隔時間，避免頻繁地發送請求，同時也不要設置過大的重試次數，以免影響系統的性能和響應時間。
- 考慮接口冪等性：如果請求是寫操作，而且下游的服務不保證請求的冪等性，那么在重試時需要謹慎處理，可以通過查詢等冪等的方式進行重試
- 在重試過程中，需要考慮并發的問題。如果多個線程同時進行重試，可能會導致請求重復發送或請求順序混亂等問題。可以使用鎖或者分布式鎖來解決并發問題。
- 在處理異常時，需要根據具體的異常類型來進行處理。有些異常是可以通過重試來解決的，例如網絡超時、連接異常等；而有些異常則需要進行特殊的處理，例如數據庫異常、文件讀寫異常等。
- 在使用重試機制時，需要注意不要陷入死循環。如果請求一直失敗，重試次數一直增加，可能會導致系統崩潰或者資源耗盡等問題。
參考：
[1]. 《Java業務開發常見錯誤100例》
[2]. https://juejin.cn/post/7028947828248412168#heading-9
[3].https://resilience4j.readme.io/docs/retry
