如何在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
  • 海康網路相機封裝庫分享
    最近做項目過程中，使用到了海康相機，官方只提供了C/C++的SDK，沒有搜尋到一個合適的封裝了的C#庫，故自己動手，簡單的封裝了一下，方便大家也方便自己使用和二次開發 ...
  • .NET 8 中利用 MediatR 實現高效消息傳遞
    前言 MediatR 是 .NET 下的一個實現消息傳遞的庫，輕量級、簡潔高效，用於實現進程內的消息傳遞機制。它基於中介者設計模式，支持請求/響應、命令、查詢、通知和事件等多種消息傳遞模式。通過泛型支持，MediatR 可以智能地調度不同類型的消息，非常適合用於領域事件處理。 在本文中，將通過一個簡 ...
  • .NET 7 + Vue 許可權管理系統 小白快速上手
    前言 今天給大家推薦一個超實用的開源項目《.NET 7 + Vue 許可權管理系統 小白快速上手》，DncZeus的願景就是做一個.NET 領域小白也能上手的簡易、通用的後臺許可權管理模板系統基礎框架。 不管你是技術小白還是技術大佬或者是不懂前端Vue 的新手，這個項目可以快速上手讓我們從0到1，搭建自 ...
  • CH01_WPF概述
    第1章：WPF概述 本章目標 瞭解Windows圖形演化 瞭解WPF高級API 瞭解解析度無關性概念 瞭解WPF體繫結構 瞭解WPF 4.5 WPF概述 ​ 歡迎使用 Windows Presentation Foundation (WPF) 桌面指南，這是一個與解析度無關的 UI 框架，使用基於矢 ...
  • .NET輔助角色服務入門簡介
    在日常開發中，並不是所有的功能都是用戶可見的，還在一些背後默默支持的程式，這些程式通常以服務的形式出現，統稱為輔助角色服務。今天以一個簡單的小例子，簡述基於.NET開發輔助角色服務的相關內容，僅供學習分享使用，如有不足之處，還請指正。 ...
  • CH03_佈局
    第3章：佈局 本章目標 理解佈局的原則 理解佈局的過程 理解佈局的容器 掌握各類佈局容器的運用 理解 WPF 中的佈局 WPF 佈局原則 ​ WPF 視窗只能包含單個元素。為在WPF 視窗中放置多個元素並創建更貼近實用的用戶男面，需要在視窗上放置一個容器，然後在這個容器中添加其他元素。造成這一限制的 ...
  • .NET 輕量化定時任務調度 FreeScheduler
    前言 在平時項目開發中，定時任務調度是一項重要的功能，廣泛應用於後臺作業、計劃任務和自動化腳本等模塊。 FreeScheduler 是一款輕量級且功能強大的定時任務調度庫，它支持臨時的延時任務和重覆迴圈任務（可持久化），能夠按秒、每天/每周/每月固定時間或自定義間隔執行（CRON 表達式）。 此外 ...
  • .NET8 Blazor 從入門到精通：（二）組件
    目錄Blazor 組件基礎路由導航參數組件參數路由參數生命周期事件狀態更改組件事件 Blazor 組件 基礎 新建一個項目命名為 MyComponents ，項目模板的交互類型選 Auto ，其它保持預設選項： 客戶端組件 (Auto/WebAssembly): 最終解決方案裡面會有兩個項目：伺服器 ...
  • WPF 怎麼把checkbox改成開關樣式
    先看一下效果吧： isChecked = false 的時候的效果 isChecked = true 的時候的效果 然後我們來實現一下這個效果吧 第一步：創建一個空的wpf項目； 第二步：在項目裡面添加一個checkbox <Grid> <CheckBox HorizontalAlignment=" ...
  • C# 使用特性的方式封裝報文
    在編寫上位機軟體時，需要經常處理命令拼接與其他設備進行通信，通常對不同的命令封裝成不同的方法，擴展稍許麻煩。 本次擬以特性方式實現，以兼顧維護性與擴展性。 思想： 一種命令對應一個類，其類中的各個屬性對應各個命令段，通過特性的方式，實現其在這包數據命令中的位置、大端或小端及其轉換為對應的目標類型； ...
所有分類