如何在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方法會在發生RestClientException或TimeoutException異常時進行重試。

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
更多相關文章
  • python中5種線程鎖
    線程安全 線程安全是多線程或多進程編程中的一個概念，在擁有共用數據的多條線程並行執行的程式中，線程安全的代碼會通過同步機制保證各個線程都可以正常且正確的執行，不會出現數據污染等意外情況。 線程安全的問題最主要還是由線程切換導致的，比如一個房間（進程）中有10顆糖（資源），除此之外還有3個小人（1個主 ...
  • Python如何遞歸刪除空文件夾
    1.標準庫參考：shutil.rmtree。 根據設計，rmtree在包含只讀文件的文件夾樹上失敗。如果要刪除文件夾，不管它是否包含只讀文件，請使用 import shutil shutil.rmtree('/folder_name', ignore_errors=True) 2.從os.walk( ...
  • Rust 的面向對象特性
    在原文上有刪減，原文鏈接Rust 的面向對象特性。 目錄面向對象語言的特征對象包含數據和行為封裝隱藏了實現細節繼承，作為類型系統與代碼共用顧及不同類型值的 trait 對象定義通用行為的 trait實現 traittrait 對象執行動態分發麵向對象設計模式的實現定義 Post 並新建一個草案狀態的 ...
  • python部署項目為什麼要用Nginx和uWSGI
    一、測試運行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 ...
  • 多數據源 ibatis.binding.BindingException Invalid bound statement
    異常 本來 springboot 配置 mysql 配置正常，後來新加入了其他數據源，發現報錯： org.apache.ibatis.binding.BindingException: Invalid bound statement (not found) 解決方案 多數據源配置下，解決 org.a ...
  • 掌握字元與字元串：C語言中的神奇函數解析(二）
    std::borrow::ToOwned是Rust標準庫中的一個特征，用於從借用的數據中創建一個具有所有權的副本。它的作用和Clone是一樣的，但是相比Clone，它支持泛型；也就是說我們可以將一個類型T“Clone”為另一個類型U。這對處理一些特殊的類型來說很有用。 ToOwned的簽名 ToOw ...
一周排行
    -Advertisement-
    Play Games
  • （開源）都進來！簡單易懂、功能強大的許可權+可視化流程管理系統
    1、預覽地址：http://139.155.137.144:9012 2、qq群:801913255 一、前言 隨著網路的發展，企業對於信息系統數據的保密工作愈發重視，不同身份、角色對於數據的訪問許可權都應該大相徑庭。 列如 1、不同登錄人員對一個數據列表的可見度是不一樣的，如數據列、數據行、數據按鈕 ...
  • 設計模式-C#實現簡單工廠模式
    前言 上一篇文章寫瞭如何使用RabbitMQ做個簡單的發送郵件項目，然後評論也是比較多，也是準備去學習一下如何確保RabbitMQ的消息可靠性，但是由於時間原因，先來說說設計模式中的簡單工廠模式吧！ 在瞭解簡單工廠模式之前，我們要知道C#是一款面向對象的高級程式語言。它有3大特性，封裝、繼承、多態。 ...
  • Nodify學習 一：介紹與使用
    Nodify學習 一：介紹與使用 - 可樂_加冰 - 博客園 (cnblogs.com) Nodify學習 二：添加節點 - 可樂_加冰 - 博客園 (cnblogs.com) 介紹 Nodify是一個WPF基於節點的編輯器控制項，其中包含一系列節點、連接和連接器組件，旨在簡化構建基於節點的工具的過程 ...
  • 使用C#/.NET解析Wiki百科數據實現獲取歷史上的今天
    創建一個webapi項目做測試使用。 創建新控制器，搭建一個基礎框架，包括獲取當天日期、wiki的請求地址等 創建一個Http請求幫助類以及方法，用於獲取指定URL的信息 使用http請求訪問指定url，先運行一下，看看返回的內容。內容如圖右邊所示，實際上是一個Json數據。我們主要解析 大事記 部 ...
  • .NET科普：.NET簡史、.NET Standard以及C#和.NET Framework之間的關係
    最近在不少自媒體上看到有關.NET與C#的資訊與評價，感覺大家對.NET與C#還是不太瞭解，尤其是對2016年6月發佈的跨平臺.NET Core 1.0，更是知之甚少。在考慮一番之後，還是決定寫點東西總結一下，也回顧一下.NET的發展歷史。 首先，你沒看錯，.NET是跨平臺的，可以在Windows、 ...
  • Nodify學習 二：添加節點
    Nodify學習 一：介紹與使用 - 可樂_加冰 - 博客園 (cnblogs.com) Nodify學習 二：添加節點 - 可樂_加冰 - 博客園 (cnblogs.com) 添加節點（nodes） 通過上一篇我們已經創建好了編輯器實例現在我們為編輯器添加一個節點 添加model和viewmode ...
  • 論如何直接用EF Core實現創建更新時間、用戶審計，自動化樂觀併發、軟刪除和樹形查詢（上）
    前言 資料庫併發，數據審計和軟刪除一直是數據持久化方面的經典問題。早些時候，這些工作需要手寫複雜的SQL或者通過存儲過程和觸發器實現。手寫複雜SQL對軟體可維護性構成了相當大的挑戰，隨著SQL字數的變多，用到的嵌套和複雜語法增加，可讀性和可維護性的難度是幾何級暴漲。因此如何在實現功能的同時控制這些S ...
  • C# 使用模式匹配的好處,因為好用所以推薦~
    類型檢查和轉換：當你需要檢查對象是否為特定類型，並且希望在同一時間內將其轉換為那個類型時，模式匹配提供了一種更簡潔的方式來完成這一任務，避免了使用傳統的as和is操作符後還需要進行額外的null檢查。 複雜條件邏輯：在處理複雜的條件邏輯時，特別是涉及到多個條件和類型的情況下，使用模式匹配可以使代碼更 ...
  • 推薦一種批量判斷文件是否存在的快速辦法
    在日常開發中，我們經常需要和文件打交道，特別是桌面開發，有時候就會需要載入大批量的文件，而且可能還會存在部分文件缺失的情況，那麼如何才能快速的判斷文件是否存在呢？如果處理不當的，且文件數量比較多的時候，可能會造成卡頓等情況，進而影響程式的使用體驗。今天就以一個簡單的小例子，簡述兩種不同的判斷文件是否... ...
  • 論如何直接用EF Core實現創建更新時間、用戶審計，自動化樂觀併發、軟刪除和樹形查詢（中）
    前言 資料庫併發，數據審計和軟刪除一直是數據持久化方面的經典問題。早些時候，這些工作需要手寫複雜的SQL或者通過存儲過程和觸發器實現。手寫複雜SQL對軟體可維護性構成了相當大的挑戰，隨著SQL字數的變多，用到的嵌套和複雜語法增加，可讀性和可維護性的難度是幾何級暴漲。因此如何在實現功能的同時控制這些S ...
所有分類