同城售後系統退款業務重構心得

来源:https://www.cnblogs.com/Jcloud/archive/2023/11/02/17804699.html
-Advertisement-
Play Games

退款業務強耦合到售後系統中,並且業務代碼分散到各個業務層,嚴重缺乏系統的領域邊界和分層設計,重構後退款業務邏輯不強依賴售後核心業務邏輯,做到可以獨立部署。 ...


一、重構背景

1.1、退款

到家、小時購、天選退款有2套結構,代碼邏輯混亂;

其中小時購、天選部分售後單是和平生pop交互退款,部分是和售後中台交互退款;並且相容3套邏輯;

痛點:代碼繁重,缺乏合理性的設計,後續迭代開發以及維護成本高,同時增加了系統的風險和不穩定性

1.2、金額計算

到家、小時購兩套獨立的邏輯結構計算,在此基礎上針對退差和非退差又實現了2套邏輯;

針對商品件維度、商品行維度、售後單維度計算金額混亂,缺乏領域邊界分層設計

痛點:售後單維度、商品行維度、拆分件維度金額計算混亂,代碼缺乏層次結構;代碼易讀性維護成本、後續擴展性存在問題

1.3、售後逆向賬

售後單詳情介面、申訴單詳情介面,針對到家和小時購做了兩套邏輯;

其中售後單詳情介面針對小時購黑名單、小時購白名單、天選、到家退差、到家非退差做了5套邏輯處理;

並且這兩個介面都是實時從拆分獲取金額進行售後逆向拆分計算,可以直接從資料庫中進行取值賦值,不需要進行售後單維度的拆分計算;

痛點:代碼大量冗餘、改動成本高****、增加了系統的風險不穩定性

二、重構思路和方案

2.1、重構思路

什麼是重構呢?

名詞:對軟體內部結構的一種調整,目的是在不改變軟體觀察行為的的前提下提高其可理解性、降低其修改成本;

動詞:使用一系列手法,在不改變軟體可觀察行為的前提下,調整其結構

重構的目的是使系統或代碼更容易被理解、修改、迭代

重構秘訣:膽大心細

膽大(意味著有勇氣和決心去改變和改進現有的代碼。重構可能涉及對複雜的代碼結構進行修改,甚至可能需要重寫部分代碼。膽大的開發者願意麵對這些挑戰,相信通過改變可以帶來更好的結果)

心細(指的是在進行重構時保持細緻入微的思考和行動。這包括仔細分析代碼的結構和邏輯,理解代碼的功能和依賴關係,以及考慮每個重構步驟可能帶來的潛在影響。心細的開發者會在重構過程中小心翼翼地處理每個細節,以確保代碼的正確性和可維護性)

  1. 把握好重構時機:當我發現售後退款、金額計算等業務模塊代碼存在質量問題、可讀性差、可維護性差或存在壞味道時,並且在項目需求排期並不緊張的情況下,是進行重構的好時機;

  2. 前期梳理很重要,先找到痛點 ;不宜長線作戰,不宜和業務並行

  3. 明確出目標和價值:售後退款、金額計算重構後能提高開發效率、降低維護、開發成本等

  4. 確定重構的目標:首先要明確需要進行重構的代碼塊或功能,並明確重構的目標是什麼。例如,可能需要提高代碼的可讀性、可維護性或性能。

  5. 分析代碼壞味道:使用代碼靜態分析工具或手動檢查代碼,識別出可能存在的代碼壞味道;例如退款業務中存在1000多行的類、600多行的方法,過多的變數參數、諸多重覆代碼等代碼壞味道

  6. 選擇適當的重構技術:根據售後代碼壞味道的種類和重構的目標,選擇適當的重構技術。我採用的重構手法是:小規模重構-->大規模重構-->頂層設計模式;採用先小後大,從大到全的思路進行重構設計。小規模重構:提取方法、消除超大類或函數方法、提取類、重命名、合併重覆代碼等方法;大規模重構:採用的是分層、模塊化、解耦、抽象可復用性等手法;設計模式:退款業務採用策略模式+抽象工廠;金額計算業務採用策略模式+抽象工廠+責任鏈模式

  7. 編寫測試用例:在進行重構之前,編寫適當的測試用例來驗證重構後的代碼的正確性。測試用例應該覆蓋重構的代碼塊或功能的各種情況。

  8. 執行重構:根據選擇的重構技術,逐步修改代碼。確保每次修改後的代碼仍然通過之前編寫的測試用例。

  9. 運行測試用例:在每次重構之後,運行之前編寫的測試用例,確保重構後的代碼仍然正確。

  10. 重構後的代碼評估:評估重構後的代碼是否達到了預期的目標,例如是否提高了代碼的可讀性、可維護性或性能。

2.2、重構方案

2.2.1、重構前系統交互圖

2.2.2、重構後系統交互圖

退款業務強耦合到售後系統中,並且業務代碼分散到各個業務層,嚴重缺乏系統的領域邊界和分層設計,重構後退款業務邏輯不強依賴售後核心業務邏輯,做到可以獨立部署。

2.2.3、重構前金額計算流程圖

2.2.4、重構後金額計算流程圖

將2套金額計算業務邏輯利用設計模式將其合併為1套金額計算業務邏輯,打造防腐層

2.3、重構設計類圖

依據上述制定的設計方案流程圖,我進行了UML類圖的繪製,以下是關於金額計算業務模塊的類圖

2.3.1、抽象工廠+策略模式類圖

2.3.2、責任鏈模式類圖

三、系統穩定性保障

3.1、小步重構

將售後重構分成退款、金額計算、逆向賬三個步驟,併在每個步驟之後運行測試用例。這樣可以及時發現並修複引入的錯誤,避免錯誤在整個系統中蔓延

3.2、逐步驗證

在每個重構步驟之後,進行系統的逐步驗證。分批次進行上線灰度,灰度配置絕對隔離,不能復用。確保系統的各個部分在重構過程中都能正常運行,並與其他部分協調良好。

3.3、監控和性能測試

在重構完成後,進行系統的監控和性能測試,確保重構沒有引入性能問題或影響系統的穩定性。如果發現問題,及時進行修複和優化。

3.4、團隊代碼審查和測試

在進行重構時,與團隊成員進行合作,併進行代碼審查。多個人的視角和經驗可以幫助發現潛在的問題,並提供改進的建議;針對重構代碼進行深度解刨,能更有效地保障重構的安全性。

重構業務及時通知測試人員,使測試人員能夠評估到測試點,更加完善測試用例

3.5、灰度步驟

3.5.1、bcp持續比對校驗

3.5.2、按照商家灰度

依據售後單量 小->中->大 的順序逐步進行灰度切量,觀察其退款、金額計算等售後單數據是否異常

四、重構成果

  1. 降低開發、維護成本

  2. 提升代碼質量、系統穩定性

  3. 系統擴展性和靈活性的加強;

  4. 系統應用、業務邊界定位更加清晰

  5. 統一和規範售後核心業務脈絡,降低業務學習成本,提升開發效率

  6. 提升自己的技術能力、代碼質量意識、問題解決能力、團隊合作和溝通能力;經典著作《重構》這本書中有這麼一段話:

一開始,我所做的重構都停留在細枝末節上。隨著代碼趨向簡潔,我發現自己可以看到一些設計層面的東西了,這些是我以前理解不到的,如果沒有重構,我達不到這種高度

五、code show

5.1、重構前金額計算

到家售後單金額計算service方法

京東售後單金額計算service方法

一個大的金額計算class類就有1000多行代碼,每個方法中都有幾百行代碼,以下是到家售後單金額計算部分代碼

5.2、重構後金額計算

到家和京東售後單金額計算用同一個介面才承接業務實現,並且使用策略+抽象工廠模式實現到家、小時購、天選業務的金額計算

策略模式獲取金額拆分結果集

金額計算核心方法只有4步驟

其中金額計算的核心則採用的是責任鏈業務進行計算

在件維度、sku維度針對不同的業務又採用了責任鏈模式進行金額計算

六、參考文獻

代碼的壞味道: https://www.qinglite.cn/doc/87036476d565d55f9

《重構改善既有代碼的設計》:[美]MartinFowler

《敏捷軟體開發》:[美]RobertC.Martin

作者:京東零售 高凱

來源:京東雲開發者社區 轉載請註明來源


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

-Advertisement-
Play Games
更多相關文章
  • 除了用作緩存與主資料庫之外,Redis還能夠提供大量其他的底層技術用於解決業務問題,包括實時分析驅動決策、高性能、關鍵數據的故障轉移和高速的數字支付等。 ...
  • Redis 是一款記憶體資料庫,Redis Enterprise 在其基礎上增加了一整套涉及管理、自動化、彈性擴展以及安全等方面的功能,使其更適合企業級的應用場景。能夠為應用程式和資料庫提供更大的價值,更快地將應用程式推向市場,從數字渠道獲得更多收入,減少 DevOps 的工作量。 ...
  • 正常情況下,我們按照下麵的步驟操作即可進入Android的開發者模式(大部分安卓手機進入的方式都類似): 打開手機的設置,點擊最下麵的關於手機。 點擊這裡的“HarmonyOS版本”。連續點擊多次(我的手機是7次),然後會彈出需要輸入密碼解屏。解鎖之後屏幕上會提示“您正處於開發者模式!”。 返回到上 ...
  • 這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 效果演示 橫版 豎版 思路分析 可以看到文字是一段一段的並且獨占一行,使用段落標簽p表示一行 一段文字內,字是一個一個顯示的,所以這裡每一個字都用一個span標簽裝起來 每一個字都是從透明到不透明的過渡效果,使用css3的過渡屬性tran ...
  • vue3.0父級組件調用子組件方法 場景:在頁面開發過程中,我經常涉及到不同組件之間的元素和方法的調用。就此記錄在vue3.0項目,也是我開發的開源項目中的實現方式。 父級組件調用子級 1.應用場景 以下以我的代碼實現為例:在左側菜單中,通過點擊新建會話,在會話列表中新建一個會話框。 其中:會話列表 ...
  • 前言 之前業務系統中驗證碼一直是由後端返回base64與一個驗證碼的字元串來實現的,想了下,前端其實可以直接canvas實現,減輕伺服器壓力。 實現 子組件,允許自定義圖片尺寸(預設尺寸為100 * 40)與驗證碼刷新時間(預設時間為60秒)。同時暴露繪製驗證碼方法drawPic(),允許父組件直接 ...
  • 公眾號「古時的風箏」,專註於後端技術,尤其是 Java 及周邊生態。 個人博客:www.moonkite.cn 大家好,我是風箏 最近這兩天,在前端圈最火的圖片莫過於下麵這張了。 這是一段 React 代碼,就算你完全沒用過 React 也沒關係,一眼看過去就能看到其中最敏感的一句代碼,就是那句 S ...
  • 1、什麼是for迴圈 在JavaScript中,for迴圈是一種常用的控制流語句,用於重覆執行一段代碼指定的次數。 for (迴圈變數初始化表達式; 迴圈條件表達式; 更新迴圈變數表達式) { 迴圈體} 初始化表達式:只在迴圈開始時執行一次,通常用於初始化迴圈控制變數。 條件表達式:每次迴圈開始前都 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...