介面請求重試的8種方法

来源:https://www.cnblogs.com/kenmeon/archive/2023/12/15/17902691.html
-Advertisement-
Play Games

日常業務開發過程中,可能第三方的伺服器分佈在世界的各個角落,所以請求三方介面的時候,難免會遇到一些網路問題,這時候需要加入重試機制了,這期就給大家分享幾個介面重試的寫法。 重試機制實現 1. 迴圈重試 這是最簡單也最直接的一種方式。在請求介面的代碼塊中加入迴圈,如果請求失敗則繼續請求,直到請求成功或 ...


日常業務開發過程中,可能第三方的伺服器分佈在世界的各個角落,所以請求三方介面的時候,難免會遇到一些網路問題,這時候需要加入重試機制了,這期就給大家分享幾個介面重試的寫法。

重試機制實現

 

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();

在上面的示例代碼中,我們使用DefaultHttpRequestRetryHandlerDefaultHttpRequestRetryStrategy來創建一個重試機制,最大重試次數為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

  1. 創建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秒。

  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還提供了註解方式來觸發重試。

  1. 配置重試切麵:
@Configuration
@EnableRetry
public class RetryConfig {
    // 配置其他的Bean
}

代碼里,我們使用@Configuration註解將類標記為配置類,使用@EnableRetry註解啟用重試功能。

  1. 使用@Retryable註解標記需要重試的方法:
@Retryable(maxAttempts = 3)
public void request() {
    // 請求介面的代碼
}

我們使用@Retryable註解標記了request()方法,指定了最大重試次數為3次。

  1. 調用被標記的方法
@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也支持代碼顯式調用和註解配置調用。

通過代碼顯式調用

  1. 創建創建一個RetryRegistry對象:

    首先,需要創建一個RetryRegistry對象,用於管理Retry實例。可以使用RetryRegistry.ofDefaults()方法創建一個預設的RetryRegistry對象。

RetryRegistry retryRegistry = RetryRegistry.ofDefaults();
  1. 配置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異常。

  1. 使用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)來實現重試機制,可以提高系統的可靠性和穩定性。即使在服務中斷的情況下,重試任務也不會丟失,而是等待服務恢復後再次進行處理。

最佳實踐和註意事項

在請求重試的時候,我們也要註意一些關鍵點,以免因為重試,引發更多的問題:

  • 合理設置重試次數和重試間隔時間,避免頻繁地發送請求,同時也不要設置過大的重試次數,以免影響系統的性能和響應時間。
  • 考慮介面冪等性:如果請求是寫操作,而且下游的服務不保證請求的冪等性,那麼在重試時需要謹慎處理,可以通過查詢等冪等的方式進行重試
  • 在重試過程中,需要考慮併發的問題。如果多個線程同時進行重試,可能會導致請求重覆發送或請求順序混亂等問題。可以使用鎖或者分散式鎖來解決併發問題。
  • 在處理異常時,需要根據具體的異常類型來進行處理。有些異常是可以通過重試來解決的,例如網路超時、連接異常等;而有些異常則需要進行特殊的處理,例如資料庫異常、文件讀寫異常等。
  • 在使用重試機制時,需要註意不要陷入死迴圈。如果請求一直失敗,重試次數一直增加,可能會導致系統崩潰或者資源耗盡等問題。

參考:

https://mp.weixin.qq.com/s/IFfvVrfXYcp2oerA5WGALg


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 填表單是打工人經常面對的場景,作為一個前端,我經常開發一些PC端的頁面,它們主要由表單和表格構成,而輸入框又是表單里最常見的表單項。接下來就試著做一個簡單的小擴展,用於快速給表單里的輸入框填充值。 ...
  • C-07.單行函數 1.函數的理解 1.1 什麼是函數 函數在電腦語言中的使用貫穿始終,函數的作用是什麼呢?它可以把我們經常使用的代碼封裝起來,需要的時候直接調用即可。這樣即提高了代碼效率,又提高了可維護性。在SQL中我們也可以使用函數對檢索出的數據進行函數操作。使用這函數,可以極大地提高用戶對數 ...
  • 5 收集聯繫信息流程 為發送通知,需收集各種信息如移動設備令牌、email、phone和第三方通道信息。 用於存儲聯繫信息的簡化的資料庫表模式。它是個帶有電子郵件、電話、設備令牌和外部通道的單個NoSQL DynamoDB表。Contacts table schema: device_tokens ...
  • 二一、函數(四) 1、推斷函數模板返回類型 1)引:將以下函數改寫為一個函數模板 int ave(int a,int b) { return (a+b)/2; } int ave(float a,fint b) { return (a+b)/2; } double ave(int a,float b ...
  • 在過去的幾十年的職業生涯中,我觀察到許多同事在技術方面取得了顯著的進步和能力提升。然而,隨著時間的推移,他們似乎逐漸遇到了一個發展的瓶頸。儘管大家都渴望以最快的速度提升自己的技能水平,但他們忽視了一個關鍵的因素,那就是內功修煉。 是的,我相信大家都知道我們所說的內功心法指的是《設計模式》。接下來,我 ...
  • Qt 是一個跨平臺C++圖形界面開發庫,利用Qt可以快速開發跨平臺窗體應用程式,在Qt中我們可以通過拖拽的方式將不同組件放到指定的位置,實現圖形化開發極大的方便了開發效率,本章將重點介紹`QDateTime`日期與時間組件的常用方法及靈活運用。在Qt中,日期和時間的處理通常使用 `QDateTime... ...
  • 背景:供應商程式導出的文件是xls格式的,我需要使用Power Query將這些文件合併整理,但是目前沒有找到可以打卡xls文件的代碼,所以將xls文件轉化為xlsx文件後再使用Power Query進行處理。 思路: 1. 網上找到了將xls文件轉化為xlsx文件的代碼,將這個代碼定義為一個函數去 ...
  • ProgressBar(進度條)是在Qt中常用的用戶界面組件之一,用於顯示任務的完成進度。它通常以一個水平或垂直的條形圖形式展示,表示任務已完成的比例。進度條組件提供了一種直觀的方式來顯示任務的進度,讓用戶清晰地瞭解任務的完成情況。其還可根據需要在水平或垂直方向上顯示,以適應不同的界面佈局。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...