如何畫出一張優秀的架構圖

語言: CN / TW / HK

技術傳播的價值,不僅僅體現在通過商業化產品和開源專案來縮短我們構建應用的路徑。加速業務的上線速率,也體現在優秀工程師的工作效率提升、產品效能優化和使用者體驗改善等經驗方面的分享,以提高我們的專業能力。

接下來,阿里巴巴技術專家三畫,將分享自己和團隊在畫好架構圖方面的理念和經驗,希望對你有所幫助。

當我們想用一張或幾張圖來描述我們的系統時,是不是經常遇到以下情況:

  • 對著畫布無從下手、刪了又來
  • 如何用一張圖描述我的系統,並且讓產品、運營、開發都能看明白
  • 畫了一半的圖還不清楚受眾是誰
  • 畫出來的圖到底是產品圖功能圖還是技術圖又或是大雜燴
  • 圖上的框框有點少是不是要找點兒框框加進來
  • 佈局怎麼畫都不滿意……

如果有同樣的困惑,本文將介紹一種畫圖的方法論,來讓架構圖更清晰。

先釐清一些基礎概念

什麼是架構?

架構就是對系統中的實體以及實體之間的關係所進行的抽象描述,是一系列的決策。

架構是結構和願景。系統架構是概念的體現,是對物/資訊的功能與形式元素之間的對應情況所做的分配,是對元素之間的關係以及元素同周邊環境之間的關係所做的定義。

做好架構是個複雜的任務,也是個很大的話題,本篇就不做深入了。有了架構之後,就需要讓干係人理解、遵循相關決策。

什麼是架構圖?

系統架構圖是為了抽象地表示軟體系統的整體輪廓和各個元件之間的相互關係和約束邊界,以及軟體系統的物理部署和軟體系統的演進方向的整體檢視。

架構圖的作用

一圖勝千言。要讓干係人理解、遵循架構決策,就需要把架構資訊傳遞出去。架構圖就是一個很好的載體。

那麼,畫架構圖是為了:

  • 解決溝通障礙
  • 達成共識
  • 減少歧義

架構圖分類

蒐集了很多資料,分類有很多,有一種比較流行的是 4+1 檢視,分別為場景檢視、邏輯檢視、物理檢視、處理流程檢視和開發檢視。

1.、場景檢視

場景檢視用於描述系統的參與者與功能用例間的關係,反映系統的最終需求和互動設計,通常由用例圖表示。

2、邏輯檢視

邏輯檢視用於描述系統軟體功能拆解後的元件關係,元件約束和邊界,反映系統整體組成與系統如何構建的過程,通常由 UML 的元件圖和類圖來表示。

3、物理檢視

物理檢視用於描述系統軟體到物理硬體的對映關係,反映出系統的元件是如何部署到一組可計算機器節點上,用於指導軟體系統的部署實施過程。

4、處理流程檢視

處理流程檢視用於描述系統軟體元件之間的通訊時序,資料的輸入輸出,反映系統的功能流程與資料流程,通常由時序圖和流程圖表示。

5、開發檢視

開發檢視用於描述系統的模組劃分和組成,以及細化到內部包的組成設計,服務於開發人員,反映系統開發實施過程。

以上 5 種架構檢視從不同角度表示一個軟體系統的不同特徵,組合到一起作為架構藍圖描述系統架構。

怎樣的架構圖是好的架構圖

上面的分類是前人的經驗總結,圖也是從網上摘來的,那麼這些圖畫的好不好呢?是不是我們要依葫蘆畫瓢去畫這樣一些圖?

先不去管這些圖好不好,我們通過對這些圖的分類以及作用,思考了一下,總結下來。

我們認為,在畫出一個好的架構圖之前, 首先應該要明確其受眾,再想清楚要給他們傳遞什麼資訊。

所以,不要為了畫一個物理檢視去畫物理檢視,為了畫一個邏輯檢視去畫邏輯檢視,而應該根據受眾的不同,傳遞的資訊的不同,用圖準確地表達出來,最後的圖可能就是在這樣一些分類裡。

那麼,畫出的圖好不好的一個直接標準就是:受眾有沒有準確接收到想傳遞的資訊。

明確這兩點之後,從受眾角度來說,一個好的架構圖是不需要解釋的,它應該是自描述的,並且要具備一致性和足夠的準確性,能夠與程式碼相呼應。

畫架構圖遇到的常見問題

方框代表什麼?

為什麼適用方框而不是圓形,它有什麼特殊的含義嗎?隨意使用方框或者其他形狀可能會引起混淆。

虛線、實線什麼意思?箭頭什麼意思?顏色什麼意思?

隨意使用線條或者箭頭可能會引起誤會。

執行時與編譯時衝突?層級衝突?

架構是一項複雜的工作,只使用單個圖表來表示架構很容易造成莫名其妙的語義混亂。

本文推薦的畫圖方法

C4 模型使用容器(應用程式、資料儲存、微服務等)、元件和程式碼來描述一個軟體系統的靜態結構。

這幾種圖比較容易畫,也給出了畫圖要點,但最關鍵的是,我們認為,它明確指出了每種圖可能的受眾以及意義。

下面的案例來自 C4 官網,然後加上了一些我們的理解,來看看如何更好的表達軟體架構。

語境圖(System Context Diagram)

這是一個想象的待建設的網際網路銀行系統,它使用外部的大型機銀行系統存取客戶賬戶、交易資訊,通過外部電郵系統給客戶發郵件。

可以看到,非常簡單、清晰,相信不需要解釋,都看的明白,裡面包含了需要建設的系統本身,系統的客戶,和這個系統有互動的周邊系統。

這樣一個簡單的圖,可以告訴我們,要構建的系統是什麼;它的使用者是誰,誰會用它,它要如何融入已有的 IT 環境。

這個圖的受眾可以是開發團隊的內部人員、外部的技術或非技術人員。即:

  • 構建的系統是什麼
  • 誰會用它
  • 如何融入已有的 IT 環境

怎麼畫?中間是自己的系統,周圍是使用者和其他與之相互作用的系統。這個圖的關鍵就是梳理清楚待建設系統的使用者和高層次的依賴,梳理清楚了畫下來只需要幾分鐘時間。

容器圖(Container Diagram)

容器圖是把語境圖裡待建設的系統做了一個展開。

上圖中,除了使用者和外圍系統,要建設的系統包括一個基於 Java\Spring MVC的 Web 應用提供系統的功能入口,基於 Xamarin 架構的手機 App 提供手機端的功能入口,一個基於 Java 的 API 應用提供服務,一個 MySQL 資料庫用於儲存,各個應用之間的互動都在箭頭線上寫明瞭。

看這張圖的時候,不會去關注到圖中是直角方框還是圓角方框,不會關注是實線箭頭還是虛線箭頭,甚至箭頭的指向也沒有引起太多注意。

我們有許多的畫圖方式,都對框、線的含義做了定義,這就需要畫圖的人和看圖的人都清晰的理解這些定義,才能讀全圖裡的資訊。

而現實是,這往往是非常高的一個要求,所以,很多圖只能看個大概的含義。

這個圖的受眾可以是團隊內部或外部的開發人員,也可以是運維人員。用途可以羅列為:

  • 展現了軟體系統的整體形態。
  • 體現了高層次的技術決策。
  • 系統中的職責是如何分佈的,容器間是如何互動的。
  • 告訴開發者在哪裡寫程式碼。

怎麼畫?用一個框圖來表示,內部可能包括名稱、技術選擇、職責,以及這些框圖之間的互動,如果涉及外部系統,最好明確邊界。

元件圖(Component Diagram)

元件圖是把某個容器進行展開,描述其內部的模組。

這個圖主要是給內部開發人員看的,怎麼去做程式碼的組織和構建。其用途有:

  • 描述了系統由哪些元件/服務組成
  • 釐清了元件之間的關係和依賴
  • 為軟體開發如何分解交付提供了框架

類圖(Code/Class Diagram)

這個圖很顯然是給技術人員看的,比較常見,就不詳細介紹了。

案例分享

下面是內部的一個實時資料工具的架構圖。作為一個應該自描述的架構圖,這裡不多做解釋了。如果有看不明白的,那肯定是還畫的不夠好。

畫好架構圖可能有許多方法論,本篇主要介紹了 C4 這種方法,C4 的理論也是不斷進化的。

但不論是哪種畫圖方法論,我們回到畫圖初衷,是為了更好的交流,我們在畫的過程中不必被條條框框所限制。簡而言之,畫之前想好:畫圖給誰看,看什麼,怎麼樣不解釋就看懂。

畫圖的工具有:

  • Keynote
  • Xmind
  • EdrawMax
  • Visio
  • OmniGraffle
  • Process On
  • ……

文中物理檢視 Download 地址:

作者介紹:三畫,曾多年從事工作流引擎研發工作,現專注於高併發移動網際網路應用的架構和開發。阿里巴巴技術專家,梓敬、鵬升和餘樂對此文亦有貢獻。

原文連結: https://www.easemob.com/news/2767