我是如何使用Spring Retry減少1000 行代碼

来源:https://www.cnblogs.com/waynaqua/archive/2023/08/22/17649196.html
-Advertisement-
Play Games

本文翻譯自國外論壇 medium,原文地址:https://levelup.gitconnected.com/how-i-deleted-more-than-1000-lines-of-code-using-spring-retry-9118de29060 > 使用 Spring Retry 重構代 ...


本文翻譯自國外論壇 medium,原文地址:https://levelup.gitconnected.com/how-i-deleted-more-than-1000-lines-of-code-using-spring-retry-9118de29060

使用 Spring Retry 重構代碼的綜合指南。

問題介紹

在我的日常工作中,我主要負責開發一個龐大的金融應用程式。當客戶發送請求時,我們使用他們的用戶 ID 從第三方服務獲取他們的帳戶信息,保存交易並更新緩存中的詳細信息。儘管整個流程看起來足夠簡單,但這些下游系統中的每一個都是不可靠的。我們必須在每一層上實現重試,並且我們必須以一種可以控制重試次數和每次重試之間的延遲的方式來實現,這樣我們就不會超載下游系統。由於我無法共用實際代碼,我會創建一個演示系統來做簡單表示:

由於我們必須在每一層上實現重試,因此我們必須編寫大量樣板代碼,這不僅容易出錯,而且難以維護。由於每個下游系統都有自己的重試要求,因此我們最終添加了越來越多的代碼,最終就像在現有垃圾之上添加垃圾一樣。隨著時間的推移,代碼變得非常脆弱,即使是很小的變化也會破壞整個系統。

推薦博主開源的 H5 商城項目waynboot-mall,這是一套全部開源的微商城項目,包含三個項目:運營後臺、H5 商城前臺和服務端介面。實現了商城所需的首頁展示、商品分類、商品詳情、商品 sku、分詞搜索、購物車、結算下單、支付寶/微信支付、收單評論以及完善的後臺管理等一系列功能。 技術上基於最新得 Springboot3.0、jdk17,整合了 MySql、Redis、RabbitMQ、ElasticSearch 等常用中間件。分模塊設計、簡潔易維護,歡迎大家點個 star、關註博主。

github 地址:https://github.com/wayn111/waynboot-mall

解決方案

為瞭解決這個問題我們決定使用 Spring Retry。

Spring Retry 項目地址:https://github.com/spring-projects/spring-retry

Spring Retry 是 Spring Batch 的一個子項目,它提供了一組註解和介面,我們可以使用它們向代碼添加重試邏輯。它提供了一種向代碼添加重試邏輯的聲明性方法。

作為本文的一部分,我們將瞭解如何使用 Spring Retry 重寫現有代碼,以及它如何幫助我將代碼庫減少 1000 行。在展示新代碼時,我將解釋每個代碼的註解和用例。

在研究重構的代碼之前,讓我們先瞭解一下在項目中設置 Spring 重試所涉及的步驟。

Let’s start hacking!

1. 設置 Spring 重試

將以下依賴項添加到我們的 pom.xml 文件中:

<dependency>
   <groupId>org.springframework.retry</groupId>
   <artifactId>spring-retry</artifactId>
   <version>2.0.0</version>
</dependency>
<dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-aspects</artifactId>
   <version>5.2.8.RELEASE</version>
</dependency>
  1. 在 spring 配置上啟用 Spring 重試,並使用以下註解:
@Configuration
@EnableRetry
public class ApplicationConfig { }

2. 重構代碼

既然我們已經設置了 Spring Retry,那麼讓我們開始重構代碼。

  1. 以下是一個查詢用戶全名的代碼示例,左邊是老代碼,右邊是使用了 Spring Retry 的新代碼。

使用 @Retryable 註解,我們通過 retryFor 屬性指定要重試的異常數組,使用 maxAttempts 屬性,可以指定要重試的次數。

  1. 具有指數退避的緩存重試

一下圖片是一個添加緩存的代碼示例中,我指定要在 JedisConnectionException 上重試,每次重試之間的延遲應為 1000 毫秒,並且延遲應呈指數增長。

使用 @Retryable 註解,我們可以使用重試退避 backoff 屬性,還可以指定每次重試之間的延遲 delay。

  1. 外部化重試配置

我們可以輕鬆地將重試配置外部化到屬性文件中。當我們想要重用配置並更改它們而無需重新部署應用程式時,這非常有用。就我而言,我創建了一個 retry.properties 文件並添加了以下屬性:

retry.maxAttempts=2

在我的 spring 配置中包含屬性文件:

// <<Other annotations>>
@PropertySource("classpath:retryConfig.properties")
public class ApplicationConfig { }

以下圖片是一個先獲取 MySql 連接,再查數據的例子,我再代碼中使用了該外部化配置屬性:

  1. 消除錯誤時的重覆操作,使用 RetryListenerSupport 重試

在前面的先獲取 MySql 連接,再查數據的例子中,我想獲取以下事件的指標:

  • 連接 MySql 資料庫時,發出指標
  • 連接 MySql 資料庫失敗時,發出指標
  • 當用盡所有重試次數時,發出指標

再 Spring Retry 中,我可以使用 RetryListenerSupport 將所有代碼添加到一個位置,而不是在連接到 Mysql 資料庫的所有代碼的每個重試塊中添加相同的代碼。

使用 RetryTemplate 上的 registerListener 方法註冊 RetryListenerSupport:

@Configuration
public class ApplicationConfig {

  @Bean
  public RetryTemplate installTemplate() {
     RetryTemplate retryTemplate = new RetryTemplate();
     retryTemplate.registerListener(new DefaultListenerSupport());
     return retryTemplate;
  }
}

RetryListenerSupport 提供了三種方法,我們可以重寫它們來添加自定義邏輯:

  • onError — 當出現錯誤時調用此方法
  • close——當所有重試都用盡時調用該方法
  • open — 重試開始時調用該方法

現在讓我們看看重構後的代碼:

總結

在本文中,我們瞭解瞭如何使用 Spring Retry 來減少樣板代碼並使代碼更具可讀性和可維護性。通過 Spring Retry,相信你也能夠消除超過 1000 行代碼。

關註公眾號【waynblog】每周分享技術乾貨、開源項目、實戰經驗、高效開發工具等,您的關註將是我的更新動力!


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

-Advertisement-
Play Games
更多相關文章
  • 類載入器 虛擬機設計團隊把類載入階段中的“通過一個類的全限定名來獲取描述此類的二進位位元組流”這個動作放到Java虛擬機外部去實現,以便讓應用程式自己決定如何去獲取所需要的類。實現這個動作的代碼模塊稱為“類載入器”。 類載入器可以說是Java語言的一項創新,也是Java語言流行的重要原因之一,它最初是 ...
  • 1. 解釋下Python中的面向對象,以及面向對象的三大特點: 在Python中,面向對象編程(Object-Oriented Programming,簡稱OOP)是一種編程範式,它將數據和操作數據的方法組織在一起,形成對象。面向對象的編程主要圍繞著類(Class) 和對象(Object)展開,通過 ...
  • [TOC] # 本篇前瞻 學習完go語言基礎的專欄,我們究竟寫出怎麼樣的實用工具呢?我在github上開源的[ssh連接管理器](https://github.com/Breeze0806/ssh-mgr)就是一個比較好的樣例。 # 項目背景 這個項目的背景是之前我在上班時連接生產機器時只能使用“s ...
  • 本次安裝的推薦配置: CentOS 7 (迅雷種子 http://ftp.nara.wide.ad.jp/pub/Linux/centos/7.9.2009/isos/x86_64/CentOS-7-x86_64-DVD-2009.torrent) nginx 1.24.0 mysql 5.7.43 ...
  • 在當今的數字時代,大規模數據處理和分析已經成為了企業和組織中不可或缺的一部分。為了有效地處理和分析海量的數據,Hadoop生態系統應運而生。本文將深入探討Hadoop生態系統的工作原理,介紹其關鍵組件以及如何使用它來處理和分析大規模數據。 ## 什麼是Hadoop? Hadoop是一個開源的分散式計 ...
  • Infinispan 是一個基於分散式系統的記憶體數據存儲和緩存平臺,它的集群實現原理涉及到節點的發現和通信。在 Infinispan 中,集群是由多個節點組成的,每個節點都存儲著數據的一部分,並且通過通信來保持數據的一致性和可用性。 Infinispan 集群的實現原理主要包括以下幾個關鍵點: 1. ...
  • # 簡介 Spring Boot Admin(SBA)是一個針對spring-boot的actuator介面進行UI美化封裝的監控工具。它可以:在列表中瀏覽所有被監控spring-boot項目的基本信息,詳細的Health信息、記憶體信息、JVM信息、垃圾回收信息,還可以直接修改logger日誌的le ...
  • # 應用場景 * 用戶下單5分鐘後,給他發簡訊 * 用戶下單30分鐘後,如果用戶不付款就自動取消訂單 # kafka無死信隊列 kafka本身沒有這種延時隊列的機制,像rabbitmq有自己的死信隊列,當一些消息在一定時間不消費時會發到死信隊列,由死信隊列來處理它們,上面的兩個需求如果是rabbit ...
一周排行
    -Advertisement-
    Play Games
  • 示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後,項目結構如下所示: MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread] 特性用於需要與 COM 組件交互的應用程式,尤其是依賴單線程模型(如 Windows Forms 應用程式)的組件。在 STA 模式下,線程擁有自己的消息迴圈,這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • 在WinForm中使用全局異常捕獲處理 在WinForm應用程式中,全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理,可以有效地捕獲並處理未預見的異常,從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • 前言 給大家推薦一款開源的 Winform 控制項庫,可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫,同時也提供了工具類庫、擴展 ...
  • 說明 該文章是屬於OverallAuth2.0系列文章,每周更新一篇該系列文章(從0到1完成系統開發)。 該系統文章,我會儘量說的非常詳細,做到不管新手、老手都能看懂。 說明:OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友,請關註我吧(*^▽^*) ...
  • 一、下載安裝 1.下載git 必須先下載並安裝git,再TortoiseGit下載安裝 git安裝參考教程:https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit,Git客戶端,32/6 ...
  • 前言 在項目開發過程中,理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼,還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程:Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 一:背景 1. 講故事 前段時間有位朋友找到我,說他的窗體程式在客戶這邊出現了卡死,讓我幫忙看下怎麼回事?dump也生成了,既然有dump了那就上 windbg 分析吧。 二:WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死,入口門檻很低,後續往下分析就不一定了,不管怎麼說先用 !clrsta ...
  • 前言 人工智慧時代,人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API,工具不僅易於集成,還具備高效處理能力。 本文將介紹一款如何利用這些API,為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...