如何在SpringBoot中優雅地重試調用第三方API?

来源:https://www.cnblogs.com/huangwentian/p/18039277
-Advertisement-
Play Games

1引言 在實際的應用中,我們經常需要調用第三方API來獲取數據或執行某些操作。然而,由於網路不穩定、第三方服務異常等原因,API調用可能會失敗。為了提高系統的穩定性和可靠性,我們通常會考慮實現重試機制。 本文將深入探討如何在Spring Boot項目中優雅地重試調用第三方API,並結合代碼示例,展示 ...


1引言

在實際的應用中,我們經常需要調用第三方API來獲取數據或執行某些操作。然而,由於網路不穩定、第三方服務異常等原因,API調用可能會失敗。為了提高系統的穩定性和可靠性,我們通常會考慮實現重試機制。

本文將深入探討如何在Spring Boot項目中優雅地重試調用第三方API,並結合代碼示例,展示具體實現方式。

2重試機制的必要性

第三方API調用可能面臨各種不可預測的問題,如網路超時、伺服器故障等。為了應對這些問題,引入重試機制可以幫助我們:

  • 提高系統的穩定性: 在面對臨時性故障時,通過重試機制可以減輕對系統的影響,確保服務的可用性。

  • 降低因故障而導致的用戶體驗差: 用戶可能無法感知到一次短暫的故障,而重試機制可以在不幹擾用戶操作的情況下自動修複問題。

3Spring Retry簡介

Spring Retry是Spring框架提供的一個模塊,它通過提供註解或編程方式的方式,幫助我們實現方法級別的重試機制。在Spring Boot中,可以很方便地集成並使用Spring Retry。

 

4Spring Boot中使用Spring Retry實現重試

4.1 添加依賴

首先,我們需要在pom.xml中添加Spring Retry的依賴:

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

4.2 配置重試策略

在Spring Boot中,我們可以使用@Retryable註解來標記希望重試的方法,並配置相應的重試策略。

4.2.1 代碼示例
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;

@Service
public class ThirdPartyService {

    @Retryable(
        value = { RestClientException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2)
    )
    public String callThirdPartyApi() {
        // 調用第三方API的邏輯
        // ...
    }
}

在上述示例中,@Retryable註解標記了callThirdPartyApi方法,指定了當發生RestClientException異常時進行重試。maxAttempts指定最大重試次數,backoff指定了重試間隔的初始延遲和延遲倍數。

4.3 降級處理

在實際應用中,除了重試,我們可能還希望在多次重試失敗後執行降級操作,以避免一直等待不確定的恢復時間。

4.3.1 代碼示例
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;

@Service
public class ThirdPartyService {

    @Retryable(
        value = { RestClientException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2)
    )
    public String callThirdPartyApi() {
        // 調用第三方API的邏輯
        // ...
    }

    @Recover
    public String fallback() {
        // 降級處理邏輯
        // ...
    }
}

在上述示例中,@Recover註解標記了fallback方法,當callThirdPartyApi方法的重試次數達到上限時,將執行fallback方法中的降級邏輯。

5非同步重試

有時候,我們可能希望在非同步任務中實現重試機制。Spring Retry同樣提供了非同步的支持。

5.1 非同步方法的重試

5.1.1 代碼示例
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;

@Service
public class AsyncThirdPartyService {

    @Async
    @Retryable(
        value = { RestClientException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2)
    )
    public CompletableFuture<String> callAsyncThirdPartyApi() {
        // 非同步調用第三方API的邏輯
        // ...
    }
}

在上述示例中,通過@Async註解表示callAsyncThirdPartyApi方法是非同步的,同時使用@Retryable配置了非同步方法的重試策略。

5.2 非同步方法的降級處理

5.2.1 代碼示例
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;

@Service
public class AsyncThirdPartyService {

    @Async
    @Retryable(
        value = { RestClientException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2)
    )
    public CompletableFuture<String> callAsyncThirdPartyApi() {
        // 非同步調用第三方API的邏輯
        // ...
    }

    @Recover
    public CompletableFuture<String> fallback() {
        // 非同步降級處理邏輯
        // ...
    }
}

在上述示例中,使用@Recover標記的fallback方法同樣支持非同步,以處理非同步方法的降級邏輯。

6異常分類與重試

在實際應用中,我們可能會遇到不同類型的異常,有些異常是可以通過重試來解決的,而有些異常則需要特殊處理。Spring Retry支持通過include和exclude屬性來指定要進行重試的異常類型和要排除的異常類型。

6.1 重試指定類型的異常

6.1.1 代碼示例
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;

@Service
public class ThirdPartyService {

    @Retryable(
        value = { RestClientException.class, TimeoutException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2)
    )
    public String callThirdPartyApi() {
        // 調用第三方API的邏輯
        // ...
    }
}

在上述示例中,callThirdPartyApi方法會在發生RestClientExceptionTimeoutException異常時進行重試。

6.2 排除指定類型的異常

6.2.1 代碼示例
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;

@Service
public class ThirdPartyService {

    @Retryable(
        value = { RestClientException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2),
        exclude = { TimeoutException.class }
    )
    public String callThirdPartyApi() {
        // 調用第三方API的邏輯
        // ...
    }
}

在上述示例中,callThirdPartyApi方法會在發生RestClientException異常時進行重試,但排除了TimeoutException異常。

7拓展:使用斷路器實現熔斷機制

除了重試機制外,熔斷機制也是一種常見的容錯處理手段。Hystrix是一款流行的斷路器實現庫,可以與Spring Boot集成,用於實現熔斷機制。

7.1 添加依賴

在pom.xml中添加Hystrix的依賴:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>

7.2 配置啟用Hystrix

在Spring Boot的主類上添加@EnableHystrix註解:

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

7.3 使用Hystrix實現熔斷

7.3.1 代碼示例
import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;

@Service
public class ThirdPartyService {

    @HystrixCommand(fallbackMethod = "fallback")
    public String callThirdPartyApi() {
        // 調用第三方API的邏輯
        // ...
    }

    public String fallback() {
        // 熔斷時的降級邏輯
        // ...
    }
}

在上述示例中,通過@HystrixCommand註解標記了callThirdPartyApi方法,指定了熔斷時執行的降級方法fallback。

8性能分析與測試

在引入重試機制後,我們需要對系統的性能進行全面的測試和分析,以確保重試機制的引入不會影響系統的整體性能。可以通過壓力測試工具模擬高併發的情況,觀察系統在異常情況下的表現。

9總結

在Spring Boot項目中,通過集成Spring Retry模塊,我們可以優雅地實現對第三方API調用的重試機制。通過@Retryable註解,我們能夠很方便地在方法級別上添加重試策略。

同時,非同步方法和異常類型的支持使得我們能夠更靈活地應對不同的業務場景。此外,我們還介紹了通過斷路器(Hystrix)實現熔斷機制的拓展方式。

在實際應用中,需要根據業務場景和需求綜合考慮重試機制和熔斷機制的使用。通過這些容錯處理手段,我們能夠提高系統的穩定性和可靠性,保障服務的正常運行。


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

-Advertisement-
Play Games
更多相關文章
  • 線程安全 線程安全是多線程或多進程編程中的一個概念,在擁有共用數據的多條線程並行執行的程式中,線程安全的代碼會通過同步機制保證各個線程都可以正常且正確的執行,不會出現數據污染等意外情況。 線程安全的問題最主要還是由線程切換導致的,比如一個房間(進程)中有10顆糖(資源),除此之外還有3個小人(1個主 ...
  • 1.標準庫參考:shutil.rmtree。 根據設計,rmtree在包含只讀文件的文件夾樹上失敗。如果要刪除文件夾,不管它是否包含只讀文件,請使用 import shutil shutil.rmtree('/folder_name', ignore_errors=True) 2.從os.walk( ...
  • 在原文上有刪減,原文鏈接Rust 的面向對象特性。 目錄面向對象語言的特征對象包含數據和行為封裝隱藏了實現細節繼承,作為類型系統與代碼共用顧及不同類型值的 trait 對象定義通用行為的 trait實現 traittrait 對象執行動態分發麵向對象設計模式的實現定義 Post 並新建一個草案狀態的 ...
  • 一、測試運行python項目 1.1 Flask項目 說明1:當我們直接用編譯器運行Flask項目的時候,會有一個提示:意思就是:這是開發環境的伺服器,不能用於生產環境的部署,請使用WSGI的伺服器替換 1.2 Django項目 說明2:當我們直接用編譯器運行Django項目的時候,同樣有個提示,這 ...
  • 前置知識 首先給出堆的定義: 堆是一顆樹,滿足堆的性質,即: 對於一個節點,它的權值大於(或小於)它的各個兒子的權值 有這個性質,顯然 堆的根節點權值是整個堆中最大或最小的 由此可分為小根堆和大根堆 二叉堆 最常見的堆就是二叉堆 二叉堆是一顆滿足堆的性質的完全二叉樹 顯然,二叉堆的子樹也是二叉堆 接 ...
  • mysql在windows下配置root用戶遠程訪問 1,管理員打開CMD 2,cd到mysql的bin cd C:\Program Files\MySQL\MySQL Server 8.0\bin 3,登錄mysql mysql -u root -p 4,執行sql查看當前用戶 use mysql ...
  • 異常 本來 springboot 配置 mysql 配置正常,後來新加入了其他數據源,發現報錯: org.apache.ibatis.binding.BindingException: Invalid bound statement (not found) 解決方案 多數據源配置下,解決 org.a ...
  • std::borrow::ToOwned是Rust標準庫中的一個特征,用於從借用的數據中創建一個具有所有權的副本。它的作用和Clone是一樣的,但是相比Clone,它支持泛型;也就是說我們可以將一個類型T“Clone”為另一個類型U。這對處理一些特殊的類型來說很有用。 ToOwned的簽名 ToOw ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...