通過自動化單元測試的形式守護系統架構

来源:https://www.cnblogs.com/Jcloud/archive/2022/09/19/16707188.html
-Advertisement-
Play Games

隨著需求開發迭代,代碼庫規模逐漸變大,新的團隊成員引入等諸多因素,系統起初制定的架構規則不可避免遭到破壞。不僅僅是破壞團隊的統一開發規範,更為重要的是隨著代碼庫規模逐漸增長,大大降低系統的可維護性、擴展性,增加評審複雜度和重構成本,也最終導致團隊生產力下降以及研發成本增長。 在敏捷開發環境下,系統... ...


1 背景

隨著需求開發迭代,代碼庫規模逐漸變大,新的團隊成員引入等諸多因素,系統起初制定的架構規則不可避免遭到破壞。不僅僅是破壞團隊的統一開發規範,更為重要的是隨著代碼庫規模逐漸增長,大大降低系統的可維護性、擴展性,增加評審複雜度和重構成本,也最終導致團隊生產力下降以及研發成本增長。

在敏捷開發環境下,系統通過迭代增量的交付價值,系統架構也是如此。團隊不可能在項目之初就建立完美的系統架構,系統架構應該隨著系統迭代不斷演進。

架構演進和架構腐化是看待架構的不同視角:架構腐化著眼於現狀,架構演進側重於未來

架構腐化不可避免,隨著時間流轉腐化現象必然發生。而我們需要做的是:通過某種方式及早發現和修正

2 為什麼選擇Archunit

我們需要通過引入一種機制或技術,降低或及早發現架構腐化現象的發生,保持統一的系統架構約束。

  • 支持架構規則自動化檢查
  • 輕量級,接入成本低
  • 結果及時反饋
  • 靈活擴展且擴展成本低

對於架構規則常見的驗證方式:代碼評審、代碼質量分析工具或平臺、Archunit

 

以下對常見的幾種方式進行優劣勢對比:

代碼評審:通過強流程式控制制代碼評審活動發生,增強代碼評審的強度和質量

優勢

  • 不需要引入額外的技術,沒有學習成本
  • 靈活:通過人工評審方式可以覆蓋架構約束更全面

劣勢

  • 非自動化方式執行,質量靠人工保證,人為因素存在較多不可控因素
  • 代碼評審範圍越廣,人力成本投入則越大
  • 代碼評審流程後置,不能及時反饋規則檢測結果

 

代碼質量分析工具:比如Sonar、Checkstyle等

優勢

  • 成熟的工具或平臺,內置開箱即用的規則
  • 三方工具支持,不影響代碼庫結構

劣勢

  • 缺少靈活性,架構規則約束支持程度有限,不能很好的解決架構層面規則約束
  • 強調代碼質量分析結果,不能有效處理強制規則約束
  • 定製規則有一定成本(因平臺擴展能力而異)

 

Archunit:通過單元測試形式對架構規則自動化檢查

優勢

  • 支持豐富的架構約束規則定製能力,例如分層依賴規則、包依賴規則、迴圈依賴、繼承關係約束等
  • 雖然以單測代碼方式體現,但不影響主業務開發,可以通過增量方式引入,逐步增強應用的架構約束能力
  • Archunit 提供的Java 流式API 易於理解,接入和使用成本低
  • 使用純Java單測框架以單元測試形式自動化執行,及時反饋單測結果

劣勢

  • 需要額外編寫單元測試代碼,增加了一部分工作量
  • 引入了新的類庫有一定學習成本

 

3 Archunit是什麼

ArchUnit是一款免費、簡單可擴展的類庫,它可以使用任何Java單元測試框架來檢查Java代碼的架構約束。基於Archunit我們可以自動化檢測:

  • 迴圈依賴
  • 包的包含關係
  • 類的依賴關係
  • 類和包的包含關係
  • 繼承關係
  • 註解

Archunit和代碼質量分析工具的關係如下圖所示,二者都可以對代碼進行分析,在功能覆蓋上存在一定交叉。

 

Archunit不能解決所有的架構屬性的約束自動化驗證,其主要側重於系統的演進性、可維護性、可測試性、可解釋性等,也可以對耦合度、命名規範等進行驗證。

 

4 引入Archunit

4.1 開始就是如此簡單

使用Archunit編寫架構規則約束非常簡單,其提供了便捷的流式API,可以快速的構建規則。

示例1:RULE.01 所有的枚舉類必須以Enum為尾碼

 

示例2:對應用分層進行約束校驗

 

在IDE下執行Archiunit單元測試結果示意如下圖所示:

 

4.2 如何組織架構規則

架構規則組織可以從多個維度,比如:

下圖左側所示:基於邏輯分類對規則進行分組

下圖右側所示:基於職能分類對規則進行分組

 

4.3 團隊如何規範化

團隊是否要引入Archunit本身也是一項架構決策,建議採用文檔化形式對該決策進行記錄,記錄形式參考 《 輕量級架構決策記錄機制 》

如果團隊想要引入Archunit,從流程化和規範化視角可以基於準備-試點-優化-推廣的模式進行實施:

 

實施準備:

  • 從規範復用的角度考慮,團隊需要定義統一的開發規範,包括但不限於編碼規範、異常規範、命名規範、依賴規範等等,併在團隊內達成一致。建議採用統一的、文檔化的形式進行記錄(比如,線上表格系統)。對於每條開發規則建議增加比如 “正例”、“反例”、“規則描述”、“規則詳細說明”、“是否可自動實現” 等維度描述信息
  • 基於Archunit實現通用架構約束以便在不同項目間進行復用

應用試點:在產品線內部選定一個試點應用

復盤優化:基於試點效果進行復盤,基於團隊成員反饋進行架構規則優化、已有規則的修改及廢棄等等

推廣普及:基於試點的一些實踐在其它應用或業務線進行推廣普及

對於遺留系統已經形成了特定的規則(有可能是已經發生腐化),由於業務系統的持續迭代,在單個迭代完全大規模重構已有系統的可能性不大。所以,建議採增量方式,在迭代研發資源可接受的範圍內,逐步引入並豐富架構規則,並對破壞規則的應用代碼進行重構。

5 結語

Archunit不能做什麼:

  • 處理文件
  • 測試所有架構屬性
  • 只支持JVM語言
  • SOURCE註解
  • 需要導入大量代碼,加入CICD流水線後的時長影響
  • 不能保證自身的維護性

Archunit對架構約束的自動化檢測極有價值,且具有較低的接入和定製化成本,強烈建議團隊引入試點。引入Archunit進行架構約束自動化檢查後,將對以下方面產生影響:

  • 有助於降低系統架構腐化,提升系統可維護性
  • 新類庫引入有一定的學習成本
  • 代碼評審活動增加一項活動:執行架構約束單元測試
  • 開發成員日常開發中需要持續執行並關註架構約束單測結果,並確保測試通過

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

-Advertisement-
Play Games
更多相關文章
  • 這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 一、axios簡介 axios是什麼? Axios 是一個基於 promise 的 HTTP 庫,可以用在瀏覽器和 node.js 中。 axios有什麼特性?(不得不說面試被問到幾次) 從瀏覽器中創建 XMLHttpRequests 從 ...
  • 前端學科面試寶典 蔡威 [電子郵件地址] HTML5、CSS3...................................................................................................................... ...
  • 筆者最近在看 你不知道的JavaScript上捲,裡面關於 this 的講解個人覺得非常精彩。JavaScript 中的 this 算是一個核心的概念,有一些同學會對其有點模糊和小恐懼,究其原因,現在對 this 討論的文章很多,讓我們覺得 this 無規律可尋,就像一個幽靈一樣 如果你還沒弄懂 t ...
  • 在面向對象的程式設計中,模塊之間交互採用介面編程,通常情況下調用方不需要知道被調用方的內部實現細節,因為一旦涉及到了具體實現,如果需要換一種實現就需要修改代碼,這違反了程式設計的"開閉原則"。所以我們一般有兩種選擇:一種是使用API(Application Programming Interface ...
  • 我的設計模式之旅。本節學習了適配器模式。從程式調用第三方庫時遇到的問題著手,思考如何讓兩個不關聯的類一起工作。並嘗試使用C#運用適配器模式解決方釘與圓孔問題。 ...
  • 上個月我寫的一篇文章《關於技術能力的思考和總結》引起了大家的關註,好多讀者的評論“以寫代想、以想促真、以講驗真”,大家的感受很深刻,基於上次的文章,這篇文章我其實更想跟大家聊聊一些常用的思考方法,思考問題的方式對了,往往可以幫助大家少走彎路。 ...
  • 現在的很多程式應用,基本上都是需要多端覆蓋,因此基於一個Web API的後端介面,來構建多端應用,如微信、H5、APP、WInForm、BS的Web管理端等都是常見的應用。本篇隨筆概括性的介紹基於HBuilderX+UniApp+ThorUI的手機端前端開發處理,總結一下開發工具的設置,以及常見的H... ...
  • 前言 秒殺請求在高度集中在某一個時間點。這樣一來,就會導致一 個特別高的流量峰值,它對資源的消耗是瞬時的 。能夠搶到商品的人數是有限的,也就是說10人和1000人發 起請求的結果都是一樣的。也就是說真正開始下單時,秒殺請求並不是越多越好。 一、秒殺中的削峰 猶豫伺服器的處理資源是恆定的,用或者不用它 ...
一周排行
    -Advertisement-
    Play Games
  • 1.1 關於C# C#只是一種簡單安全的新型面向對象語言,繼承了C的語法風格和C++的面向對象特性,不再提供對指針類型的支持(因此程式不可隨便訪問記憶體地址空間)、不再支持多重繼承; C#的誕生意義是生成面向.NET Framework環境的代碼,身為編程語言的一種,它作為開發工具而存在,本身並不是. ...
  • 往一張產品圖片上,加兩個小標簽,Demo實現最好的效果 素材例圖與最終效果如下: 具體實現的代碼如下: 添加引用: using System.Drawing; using System.Drawing.Drawing2D; 註意:如果添加命名空間沒效果,加一下Nuget包 System.Drawin ...
  • 前置要求:有百度賬號,實名認證以及開發者認證,創建應用並獲取到關鍵憑證:Appid、Appkey、Secretkeyk和Signkey 平臺上入門十分清楚,直接對著逐步操作即可,個人開發者審核也很快 百度網盤開放平臺地址如下:https://pan.baidu.com/union/doc/nksg0 ...
  • 使用方法 安裝 Maven <dependency> <groupId>com.github.yulichang</groupId> <artifactId>mybatis-plus-join</artifactId> <version>1.2.4</version> </dependency> G ...
  • 數字常量 int: 一般的整數, long: 長整型,2.x版本需在數字後加 “L” 或 “l” ,表示長整型 如 100000000L; python3.x 版本後不分長整型,統一為int,不可加 “L” 或 “l” float: 浮點數,1.0 也為浮點數,float 可強制轉換為 int,取整 ...
  • if __name__ == "__main__" 也就是說執行當前文件,不調用模塊的時候__name__=__main__ 調用模塊的時候,測試如下: 1、新建 test01.py 文件測試代碼如下 print("這條消息來自test01") def func(): print('hello, w ...
  • 一.scoket基本介紹 1.scoket簡介(以下是來自chatgpt回答) 1)Socket(套接字)是電腦網路中用於描述主機之間通信的一種機制。它定義了一種標準的介面, 使得應用程式可以利用網路傳輸層提供的服務(如TCP或UDP)進行通信。 2)Socket的作用是在網路應用程式之間提供數據 ...
  • 一、函數的定義 可以分為以下兩種: 1、函數聲明和函數定義分離 這種方法將函數聲明和函數定義分開,通常在頭文件中先聲明函數原型,然後在源文件中實現函數定義。 例如,頭文件 example.h 中聲明瞭一個函數 add: #ifndef EXAMPLE_H #define EXAMPLE_H int ...
  • 一 回顧trait使用 https://blog.csdn.net/bushuwei/article/details/103514174發現之前本人說明很模糊,自己居然不知道為什麼其實這裡的$c,就是class B再次回顧邏輯 二 分析 self和static區別說的沒毛病 Trait基類use t ...
  • 一、延遲計算 RDD 代表的是分散式數據形態,因此,RDD 到 RDD 之間的轉換,本質上是數據形態上的轉換(Transformations) 在 RDD 的編程模型中,一共有兩種運算元,Transformations 類運算元和 Actions 類運算元。開發者需要使用 Transformations ...