轉載:阿里大牛:如何畫出一圖勝千言的技術架構圖?

技術傳播的價值,不僅僅體現在通過商業化產品和開源項目來縮短我們構建應用的路徑。

加速業務的上線速率,也體現在優秀工程師的工作效率提升、產品性能優化和用戶體驗改善等經驗方面的分享,以提高我們的專業能力。

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

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

對著畫布無從下手、刪了又來?

如何用一張圖描述我的系統,并且讓產品、運營、開發都能看明白?

畫了一半的圖還不清楚受眾是誰?

畫出來的圖到底是產品圖功能圖還是技術圖又或是大雜燴?

圖上的框框有點少是不是要找點兒框框加進來?

布局怎么畫都不滿意…

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

先厘清一些基礎概念

什么是架構?

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

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

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

什么是架構圖?

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

架構圖的作用

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

那么,畫架構圖是為了:

解決溝通障礙

達成共識

減少歧義

架構圖分類

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

①場景視圖

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

②邏輯視圖

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

③物理視圖

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

④處理流程視圖

處理流程視圖用于描述系統軟件組件之間的通信時序,數據的輸入輸出,反映系統的功能流程與數據流程,通常由時序圖和流程圖表示。

⑤開發視圖

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

以上 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 地址:

Win:http://t.cn/EXAGBDW

Mac:http://t.cn/EXAqtxI

作者:三畫

簡介:阿里巴巴技術專家,梓敬、鵬升和余樂對此文亦有貢獻。三畫曾多年從事工作流引擎研發工作,現專注于高并發移動互聯網應用的架構和開發。

原地址:http://news.51cto.com/art/201904/595684.htm

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,646評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,595評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,560評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,035評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,814評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,224評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,301評論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,444評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,988評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,804評論 3 355
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,998評論 1 370
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,544評論 5 360
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,237評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,665評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,927評論 1 287
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,706評論 3 393
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,993評論 2 374

推薦閱讀更多精彩內容