[[312995]]

軟件架構(gòu)圖可能是一個非常有用的溝通工具，但很多團隊減少了圖表的創(chuàng)建，即使有創(chuàng)建圖表，也往往模糊不清。本文作者依據(jù)自己多年的軟件開發(fā)和與團隊合作的經(jīng)驗，提出了 C4 模型。C4 模型是由一系列分層的軟件架構(gòu)圖組成，這些架構(gòu)圖用于描述上下文、容器、組件和代碼。C4 模型的層次結(jié)構(gòu)提供了不同的抽象級別，每種抽象級別都與不同的受眾有關(guān)。同時，C4 模型也是向軟件開發(fā)團隊介紹輕量級建模的一種方式。

軟件架構(gòu)圖是一種非常好的表達方式，可以用它們來表達你將如何構(gòu)建一個軟件系統(tǒng)（預(yù)先設(shè)計）或者現(xiàn)有的軟件系統(tǒng)是如何工作的（回顧文檔、知識分享和學(xué)習(xí)）。

然而，你所看到的大多數(shù)軟件架構(gòu)圖很可能只是由混亂的框和線組成。敏捷軟件開發(fā)宣言 的一個副作用就是讓很多團隊停止或縮減了他們的圖表和文檔工作，包括使用 UML。

現(xiàn)在，這些團隊傾向于依靠他們在白板上繪制的臨時圖表，或者使用通用的圖表工具（如微軟的 Visio）。Ionut Balosin 在去年寫了一篇叫作“軟件架構(gòu)圖的藝術(shù)”的文章，他在文章中描述了一些常見問題，這些問題與不可理解的符號和不明確的語義有關(guān)。

含糊不清的軟件架構(gòu)圖容易導(dǎo)致誤解，這可能會拖慢一個優(yōu)秀團隊的前進步伐。在我們的行業(yè)中，我們真的應(yīng)該努力創(chuàng)建出更好的軟件架構(gòu)圖。多年來，我自己參與軟件開發(fā)，并與世界各地的團隊合作，基于這些經(jīng)驗，我建立了一個稱之為“C4 模型”的東西。C4 代表 上下文（Context）、容器（Container）、組件（Component） 和 代碼（Code）——一系列分層的圖表，可以用這些圖表來描述不同縮放級別的軟件架構(gòu)，每種圖表都適用于不同的受眾。可以將其視為代碼的谷歌地圖。

要為你的代碼創(chuàng)建地圖，首先需要一組通用的抽象來創(chuàng)建一種無處不在的語言，用來描述軟件系統(tǒng)的靜態(tài)結(jié)構(gòu)。C4 模型使用 容器（應(yīng)用程序、數(shù)據(jù)存儲、微服務(wù)等）、組件 和 代碼 來描述一個軟件系統(tǒng)的靜態(tài)結(jié)構(gòu)。它還考慮到使用軟件系統(tǒng)的人。

一、第 1 層：系統(tǒng)上下文

第 1 層是系統(tǒng)上下文圖，它顯示了你正在構(gòu)建的軟件系統(tǒng)，以及系統(tǒng)與用戶及其他軟件系統(tǒng)之間的關(guān)系。以下是一個系統(tǒng)上下文圖的示例，描述了一個互聯(lián)網(wǎng)銀行系統(tǒng)的系統(tǒng)上下文：

銀行的個人客戶使用互聯(lián)網(wǎng)銀行系統(tǒng)查看有關(guān)銀行賬戶的信息并進行支付。互聯(lián)網(wǎng)銀行系統(tǒng)使用銀行現(xiàn)有的大型機銀行系統(tǒng)來執(zhí)行此操作，并使用銀行現(xiàn)有的電子郵件系統(tǒng)向客戶發(fā)送電子郵件。圖中的顏色表示哪些軟件系統(tǒng)已經(jīng)存在（灰色）以及待構(gòu)建的系統(tǒng)（藍色）。

二、第 2 層：容器

第 2 層是一個容器圖，將軟件系統(tǒng)放大，顯示組成該軟件系統(tǒng)的容器（應(yīng)用程序、數(shù)據(jù)存儲、微服務(wù)等）。技術(shù)決策也是該圖的關(guān)鍵部分。以下是互聯(lián)網(wǎng)銀行系統(tǒng)的容器圖示例。它顯示了互聯(lián)網(wǎng)銀行系統(tǒng)（虛線框）由五個容器組成：服務(wù)器端 Web 應(yīng)用程序、客戶端單頁面應(yīng)用程序、移動應(yīng)用程序、服務(wù)器端 API 應(yīng)用程序和數(shù)據(jù)庫。

Web 應(yīng)用程序是一個 Java/Spring MVC Web 應(yīng)用程序，它僅提供靜態(tài)內(nèi)容（HTML、CSS 和 JavaScript），包括組成單頁應(yīng)用程序的內(nèi)容。單頁面應(yīng)用程序是一個運行在客戶網(wǎng)絡(luò)瀏覽器中的 Angular 應(yīng)用程序，提供所有的網(wǎng)上銀行功能。或者，客戶可以使用跨平臺 Xamarin 移動應(yīng)用程序訪問互聯(lián)網(wǎng)銀行的部分功能。單頁應(yīng)用程序和移動應(yīng)用程序都調(diào)用 JSON/HTTPS API，這是由服務(wù)器端運行的另一個 Java/Spring MVC 應(yīng)用程序提供的。API 應(yīng)用程序從數(shù)據(jù)庫中獲取用戶信息（關(guān)系數(shù)據(jù)庫模式）。API 應(yīng)用程序還使用專有的 XML/HTTPS 接口與現(xiàn)有的大型機銀行系統(tǒng)進行通信，以獲取有關(guān)銀行賬戶或交易的信息。如果需要向客戶發(fā)送電子郵件，API 應(yīng)用程序還會調(diào)用現(xiàn)有的電子郵件系統(tǒng)。

三、第 3 層：組件

第 3 層是組件圖，將單個容器放大，以顯示其中的組件。這些組件映射到代碼庫中的真實抽象（例如一組代碼）。下面是一個虛擬的網(wǎng)上銀行系統(tǒng)的組件圖示例，顯示了 API 應(yīng)用程序中的一些組件（而不是全部）。

兩個 Spring MVC REST 控制器為 JSON/HTTPS API 提供訪問點，每個控制器隨后使用其他組件訪問數(shù)據(jù)庫和大型機銀行系統(tǒng)中的數(shù)據(jù)。

四、第 4 層：代碼

最后，如果你確實想要，或者說有這個必要，可以放大個別組件，以顯示該組件的實現(xiàn)方式。以下是一個虛擬的網(wǎng)上銀行系統(tǒng)的 UML 類圖示例（部分），顯示了組成 MainframeBankingSystemFacade 組件的代碼元素（接口和類）。

它表明該組件由很多類組成，實現(xiàn)細節(jié)直接反映了代碼。我并不建議創(chuàng)建在這種詳細程度的圖表，有時候你可以直接從大多數(shù) IDE 中獲取它們。

五、符號

C4 模型沒有預(yù)定義任何特定的符號，你在這些示例圖中看到的是一個個簡單的符號，適用于白板、紙張、便簽、索引卡片和各種圖表工具。你也可以使用 UML 作為符號，并適當(dāng)使用包、組件和原型。無論你使用哪種符號，我都會建議讓每個元素都包含名稱、元素類型（即“人”、“軟件系統(tǒng)”，“容器”或“組件”）、技術(shù)選型（如果有的話），以及一些描述性文字。在圖表中包含如此多的文本可能看起來很不尋常，但這些附加文本有助于消除軟件架構(gòu)圖中通常會出現(xiàn)的不明確的表示。

即使符號對你來說是顯而易見的，仍然要確保為這些符號提供圖例。圖例中應(yīng)該包括顏色、形狀、首字母縮略詞、線條樣式、邊框、尺寸等。理想情況下，符號應(yīng)該在每個細節(jié)層次上保持一致。下面是前面顯示的容器圖的圖例。

最后，不要忘記了標(biāo)題，它應(yīng)該出現(xiàn)在每個圖表上，以明確地描述每個圖表的類型和范圍（例如，“網(wǎng)上銀行系統(tǒng)的系統(tǒng)上下文圖表”）。

六、更多信息

C4 模型是一種在不同抽象層次上交流軟件架構(gòu)的簡單方法，可以向不同的受眾講述不同的故事。這也是向軟件開發(fā)團隊介紹（通常是重新引入）嚴謹和輕量級建模的一種方式。有關(guān) C4 模型的更多信息，以及補充圖（運行時和部署）的示例、符號清單、常見問題解答、會議講座視頻和工具選項，請參閱 http://c4model.com/。

七、關(guān)于作者

Simon Brown 是一位專門從事軟件架構(gòu)的獨立顧問，也是“Software Architecture for Developers”（面向開發(fā)人員的軟件架構(gòu)、技術(shù)領(lǐng)導(dǎo)力和敏捷性平衡的指南）的作者。他還是 C4 軟件架構(gòu)模型的創(chuàng)建者，這是一種創(chuàng)建代碼映射的簡單方法。Simon 在國際軟件開發(fā)會議上經(jīng)常發(fā)表演講，并在世界各地旅行，以幫助組織可視化和記錄他們的軟件架構(gòu)。