如何在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
  • 不廢話,直接代碼 private Stack<Action> actionStack = new Stack<Action>(); private void SetCellValues() { var worksheet = Globals.ThisAddIn.Application.ActiveS ...
  • OpenAPI 規範是用於描述 HTTP API 的標準。該標準允許開發人員定義 API 的形狀,這些 API 可以插入到客戶端生成器、伺服器生成器、測試工具、文檔等中。儘管該標準具有普遍性和普遍性,但 ASP.NET Core 在框架內預設不提供對 OpenAPI 的支持。 當前 ASP.NET ...
  • @DateTimeFormat 和 @JsonFormat 是 Spring 和 Jackson 中用於處理日期時間格式的註解,它們有不同的作用: @DateTimeFormat @DateTimeFormat 是 Spring 框架提供的註解,用於指定字元串如何轉換為日期時間類型,以及如何格式化日 ...
  • 一、背景說明 1.1 效果演示 用python開發的爬蟲採集軟體,可自動抓取抖音評論數據,並且含二級評論! 為什麼有了源碼還開發界面軟體呢?方便不懂編程代碼的小白用戶使用,無需安裝python、無需懂代碼,雙擊打開即用! 軟體界面截圖: 爬取結果截圖: 以上。 1.2 演示視頻 軟體運行演示視頻:見 ...
  • SpringBoot筆記 SpringBoot文檔 官網: https://spring.io/projects/spring-boot 學習文檔: https://docs.spring.io/spring-boot/docs/current/reference/html/ 線上API: http ...
  • 作為後端工程師,多數情況都是給別人提供介面,寫的好不好使你得重視起來。 最近我手頭一些活,需要和外部公司對接,我們需要提供一個介面文檔,這樣可以節省雙方時間、也可以防止後續扯皮。這是就要考驗我的介面是否規範化。 1. 介面名稱清晰、明確 顧名思義,介面是做什麼的,是否準確、清晰?讓使用這一眼就能知道 ...
  • 本文介紹基於Python語言,遍歷文件夾並從中找到文件名稱符合我們需求的多個.txt格式文本文件,並從上述每一個文本文件中,找到我們需要的指定數據,最後得到所有文本文件中我們需要的數據的合集的方法~ ...
  • Java JUC&多線程 基礎完整版 目錄Java JUC&多線程 基礎完整版1、 多線程的第一種啟動方式之繼承Thread類2、多線程的第二種啟動方式之實現Runnable介面3、多線程的第三種實現方式之實現Callable介面4、多線的常用成員方法5、線程的優先順序6、守護線程7、線程的讓出8、線 ...
  • 實時識別關鍵詞是一種能夠將搜索結果提升至新的高度的API介面。它可以幫助我們更有效地分析文本,並提取出關鍵詞,以便進行進一步的處理和分析。 該介面是挖數據平臺提供的,有三種模式:精確模式、全模式和搜索引擎模式。不同的模式在分詞的方式上有所不同,適用於不同的場景。 首先是精確模式。這種模式會儘量將句子 ...
  • 1 為啥要折騰搭建一個專屬圖床? 技術大佬寫博客都用 md 格式,要在多平臺發佈,圖片就得有外鏈 後續如博客遷移,國內博客網站如掘金,簡書,語雀等都做了防盜鏈,圖片無法遷移 2 為啥選擇CloudFlare R2 跳轉:https://dash.cloudflare.com/ 有白嫖額度 免費 CD ...