本文轉載自微信公眾號:阿里巴巴中間件
本文作者阿里巴巴技術專家三畫,分享了自己和團隊在畫好架構圖方面的理念和經(jīng)驗,首發(fā)于阿里內(nèi)部技術分享平臺赦拘,阿里巴巴中間件授權轉載,梓敬芬沉、鵬升和余樂對此文亦有貢獻躺同。
當我們想用一張或幾張圖來描述我們的系統(tǒng)時,是不是經(jīng)常遇到以下情況:
對著畫布無從下手丸逸、刪了又來蹋艺?
用一張圖描述我的系統(tǒng),并且讓產(chǎn)品黄刚、運營捎谨、開發(fā)都能看明白?
畫了一半的圖還不清楚受眾是誰憔维?
畫出來的圖到底是產(chǎn)品圖功能圖還是技術圖又或是大雜燴涛救?
圖上的框框有點少是不是要找點兒框框加進來?
布局怎么畫都不滿意……
如果有同樣的困惑业扒,本文將介紹一種畫圖的方法論检吆,來讓架構圖更清晰。
先理清一些基礎概念
什么是架構?
架構就是對系統(tǒng)中的實體以及實體之間的關系所進行的抽象描述程储,是一系列的決策蹭沛。
架構是結構和愿景臂寝。
系統(tǒng)架構是概念的體現(xiàn),是對物/信息的功能與形式元素之間的對應情況所做的分配摊灭,是對元素之間的關系以及元素同周邊環(huán)境之間的關系所做的定義交煞。
做好架構是個復雜的任務,也是個很大的話題斟或,本篇就不做深入了。有了架構之后集嵌,就需要讓干系人理解萝挤、遵循相關決策。
什么是架構圖
系統(tǒng)架構圖是為了抽象的表示軟件系統(tǒng)的整體輪廓和各個組件之間的相互關系和約束邊界根欧,以及軟件系統(tǒng)的物理部署和軟件系統(tǒng)的演進方向的整體視圖怜珍。
架構圖的作用
一圖勝千言。要讓干系人理解凤粗、遵循架構決策酥泛,就需要把架構信息傳遞出去。架構圖就是一個很好的載體嫌拣。那么柔袁,畫架構圖是為了:
解決溝通障礙
達成共識
減少歧義
架構圖分類
搜集了很多資料,分類有很多异逐,有一種比較流行的是4+1視圖捶索,分別為場景視圖、邏輯視圖灰瞻、物理視圖腥例、處理流程視圖和開發(fā)視圖。
-
場景視圖
場景視圖用于描述系統(tǒng)的參與者與功能用例間的關系酝润,反映系統(tǒng)的最終需求和交互設計燎竖,通常由用例圖表示。
-
邏輯視圖
邏輯視圖用于描述系統(tǒng)軟件功能拆解后的組件關系要销,組件約束和邊界构回,反映系統(tǒng)整體組成與系 統(tǒng)如何構建的過程,通常由UML的組件圖和類圖來表示。
-
物理視圖
物理視圖用于描述系統(tǒng)軟件到物理硬件的映射關系疏咐,反映出系統(tǒng)的組件是如何部署到一組可 計算機器節(jié)點上捐凭,用于指導軟件系統(tǒng)的部署實施過程。
-
處理流程視圖
處理流程視圖用于描述系統(tǒng)軟件組件之間的通信時序凳鬓,數(shù)據(jù)的輸入輸出茁肠,反映系統(tǒng)的功能流程 與數(shù)據(jù)流程,通常由時序圖和流程圖表示。
-
開發(fā)視圖
開發(fā)視圖用于描述系統(tǒng)的模塊劃分和組成缩举,以及細化到內(nèi)部包的組成設計垦梆,服務于開發(fā)人員匹颤,反映系統(tǒng)開發(fā)實施過程。
以上 5 種架構視圖從不同角度表示一個軟件系統(tǒng)的不同特征托猩,組合到一起作為架構藍圖描述系統(tǒng)架構印蓖。
怎樣的架構圖是好的架構圖
上面的分類是前人的經(jīng)驗總結,圖也是從網(wǎng)上摘來的京腥,那么這些圖畫的好不好呢赦肃?是不是我們要依葫蘆畫瓢去畫這樣一些圖?
先不去管這些圖好不好公浪,我們通過對這些圖的分類以及作用他宛,思考了一下,總結下來欠气,我們認為厅各,在畫出一個好的架構圖之前, 首先應該要明確其受眾预柒,再想清楚要給他們傳遞什么信息 队塘,所以,不要為了畫一個物理視圖去畫物理視圖宜鸯,為了畫一個邏輯視圖去畫邏輯視圖憔古,而應該根據(jù)受眾的不同,傳遞的信息的不同淋袖,用圖準確地表達出來投放,最后的圖可能就是在這樣一些分類里。那么适贸,畫出的圖好不好的一個直接標準就是:受眾有沒有準確接收到想傳遞的信息灸芳。
明確這兩點之后,從受眾角度來說拜姿,一個好的架構圖是不需要解釋的烙样,它應該是自描述的,并且要具備一致性和足夠的準確性蕊肥,能夠與代碼相呼應谒获。
畫架構圖遇到的常見問題
-
方框代表什么?
為什么適用方框而不是圓形壁却,它有什么特殊的含義嗎批狱?隨意使用方框或者其它形狀可能會引起混淆。
-
虛線展东、實線什么意思赔硫?箭頭什么意思?顏色什么意思盐肃?
隨意使用線條或者箭頭可能會引起誤會爪膊。
-
運行時與編譯時沖突权悟?層級沖突?
架構是一項復雜的工作推盛,只使用單個圖表來表示架構很容易造成莫名其妙的語義混亂峦阁。
本文推薦的畫圖方法
C4 模型使用容器(應用程序、數(shù)據(jù)存儲耘成、微服務等)榔昔、組件和代碼來描述一個軟件系統(tǒng)的靜態(tài)結構。這幾種圖比較容易畫瘪菌,也給出了畫圖要點撒会,但最關鍵的是,我們認為控嗜,它明確指出了每種圖可能的受眾以及意義。
下面的案例來自C4官網(wǎng)骡显,然后加上了一些我們的理解疆栏,來看看如何更好的表達軟件架構
-
語境圖(System Context Diagram)
這是一個想象的待建設的互聯(lián)網(wǎng)銀行系統(tǒng),它使用外部的大型機銀行系統(tǒng)存取客戶賬戶惫谤、交易信息壁顶,通過外部電郵系統(tǒng)給客戶發(fā)郵件×锿幔可以看到若专,非常簡單、清晰蝴猪,相信不需要解釋调衰,都看的明白,里面包含了需要建設的系統(tǒng)本身自阱,系統(tǒng)的客戶嚎莉,和這個系統(tǒng)有交互的周邊系統(tǒng)。
-
用途
這樣一個簡單的圖沛豌,可以告訴我們趋箩,要構建的系統(tǒng)是什么;它的用戶是誰加派,誰會用它叫确,它要如何融入已有的IT環(huán)境。這個圖的受眾可以是開發(fā)團隊的內(nèi)部人員芍锦、外部的技術或非技術人員竹勉。即:
構建的系統(tǒng)是什么
誰會用它
如何融入已有的IT環(huán)境
-
怎么畫
中間是自己的系統(tǒng),周圍是用戶和其它與之相互作用的系統(tǒng)娄琉。這個圖的關鍵就是梳理清楚待建設系統(tǒng)的用戶和高層次的依賴饶米,梳理清楚了畫下來只需要幾分鐘時間桨啃。
-
-
容器圖(Container Diagram)
容器圖是把語境圖里待建設的系統(tǒng)做了一個展開。
上圖中檬输,除了用戶和外圍系統(tǒng)照瘾,要建設的系統(tǒng)包括一個基于java\spring mvc的web應用提供系統(tǒng)的功能入口,基于xamarin架構的手機app提供手機端的功能入口丧慈,一個基于java的api應用提供服務析命,一個mysql數(shù)據(jù)庫用于存儲,
各個應用之間的交互都在箭頭線上寫明了逃默。
看這張圖的時候鹃愤,不會去關注到圖中是直角方框還是圓角方框,不會關注是實線箭頭還是虛線箭頭完域,甚至箭頭的指向也沒有引起太多注意软吐。
我們有許多的畫圖方式,都對框吟税、線的含義做了定義凹耙,這就需要畫圖的人和看圖的人都清晰的理解這些定義,才能讀全圖里的信息肠仪,而現(xiàn)實是肖抱,這往往是非常高的一個要求,所以异旧,很多圖只能看個大概的含義意述。
-
用途
這個圖的受眾可以是團隊內(nèi)部或外部的開發(fā)人員,也可以是運維人員吮蛹。用途可以羅列為:
展現(xiàn)了軟件系統(tǒng)的整體形態(tài)
體現(xiàn)了高層次的技術決策
系統(tǒng)中的職責是如何分布的荤崇,容器間的是如何交互的
告訴開發(fā)者在哪里寫代碼
-
怎么畫
用一個框圖來表示,內(nèi)部可能包括名稱潮针、技術選擇天试、職責,以及這些框圖之間的交互然低,如果涉及外部系統(tǒng)喜每,最好明確邊界。
-
-
組件圖(Component Diagram)
組件圖是把某個容器進行展開雳攘,描述其內(nèi)部的模塊带兜。
-
用途
這個圖主要是給內(nèi)部開發(fā)人員看的,怎么去做代碼的組織和構建吨灭。其用途有:
描述了系統(tǒng)由哪些組件/服務組成
厘清了組件之間的關系和依賴
為軟件開發(fā)如何分解交付提供了框架
-
-
類圖(Code/Class Diagram)
這個圖很顯然是給技術人員看的刚照,比較常見,就不詳細介紹了喧兄。
案例分享
下面是內(nèi)部的一個實時數(shù)據(jù)工具的架構圖无畔。作為一個應該自描述的架構圖啊楚,這里不多做解釋了。如果有看不明白的浑彰,那肯定是還畫的不夠好恭理。
畫好架構圖可能有許多方法論,本篇主要介紹了C4這種方法郭变,C4的理論也是不斷進化的颜价。但不論是哪種畫圖方法論,我們回到畫圖初衷诉濒,更好的交流周伦,我們在畫的過程中不必被條條框框所限制。簡而言之未荒,畫之前想好:畫圖給誰看专挪,看什么,怎么樣不解釋就看懂片排。
參考資料
C4官網(wǎng): https://c4model.com/