架構師必備技能:如何畫好架構圖?

本文轉載自微信公眾號:阿里巴巴中間件

本文作者阿里巴巴技術專家三畫,分享了自己和團隊在畫好架構圖方面的理念和經(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ù)受眾的不同,傳遞的信息的不同淋袖,用圖準確地表達出來投放,最后的圖可能就是在這樣一些分類里。那么适贸,畫出的圖好不好的一個直接標準就是:受眾有沒有準確接收到想傳遞的信息灸芳。

明確這兩點之后,從受眾角度來說拜姿,一個好的架構圖是不需要解釋的烙样,它應該是自描述的,并且要具備一致性和足夠的準確性蕊肥,能夠與代碼相呼應谒获。

畫架構圖遇到的常見問題

  1. 方框代表什么?

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

  2. 虛線展东、實線什么意思赔硫?箭頭什么意思?顏色什么意思盐肃?

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

  3. 運行時與編譯時沖突权悟?層級沖突?

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

本文推薦的畫圖方法

C4 模型使用容器(應用程序、數(shù)據(jù)存儲耘成、微服務等)榔昔、組件和代碼來描述一個軟件系統(tǒng)的靜態(tài)結構。這幾種圖比較容易畫瘪菌,也給出了畫圖要點撒会,但最關鍵的是,我們認為控嗜,它明確指出了每種圖可能的受眾以及意義。

下面的案例來自C4官網(wǎng)骡显,然后加上了一些我們的理解疆栏,來看看如何更好的表達軟件架構

  1. 語境圖(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)的用戶和高層次的依賴饶米,梳理清楚了畫下來只需要幾分鐘時間桨啃。

  2. 容器圖(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)喜每,最好明確邊界。

  3. 組件圖(Component Diagram)

    組件圖是把某個容器進行展開雳攘,描述其內(nèi)部的模塊带兜。

    • 用途

      • 這個圖主要是給內(nèi)部開發(fā)人員看的,怎么去做代碼的組織和構建吨灭。其用途有:

      • 描述了系統(tǒng)由哪些組件/服務組成

      • 厘清了組件之間的關系和依賴

      • 為軟件開發(fā)如何分解交付提供了框架

  4. 類圖(Code/Class Diagram)

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

案例分享

下面是內(nèi)部的一個實時數(shù)據(jù)工具的架構圖无畔。作為一個應該自描述的架構圖啊楚,這里不多做解釋了。如果有看不明白的浑彰,那肯定是還畫的不夠好恭理。

畫好架構圖可能有許多方法論,本篇主要介紹了C4這種方法郭变,C4的理論也是不斷進化的颜价。但不論是哪種畫圖方法論,我們回到畫圖初衷诉濒,更好的交流周伦,我們在畫的過程中不必被條條框框所限制。簡而言之未荒,畫之前想好:畫圖給誰看专挪,看什么,怎么樣不解釋就看懂片排。

參考資料

C4官網(wǎng): https://c4model.com/

?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末寨腔,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子划纽,更是在濱河造成了極大的恐慌脆侮,老刑警劉巖锌畸,帶你破解...
    沈念sama閱讀 216,651評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件勇劣,死亡現(xiàn)場離奇詭異,居然都是意外死亡潭枣,警方通過查閱死者的電腦和手機比默,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,468評論 3 392
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來盆犁,“玉大人命咐,你說我怎么就攤上這事⌒乘辏” “怎么了醋奠?”我有些...
    開封第一講書人閱讀 162,931評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長伊佃。 經(jīng)常有香客問我窜司,道長,這世上最難降的妖魔是什么航揉? 我笑而不...
    開封第一講書人閱讀 58,218評論 1 292
  • 正文 為了忘掉前任塞祈,我火速辦了婚禮,結果婚禮上帅涂,老公的妹妹穿的比我還像新娘议薪。我一直安慰自己尤蛮,他們只是感情好,可當我...
    茶點故事閱讀 67,234評論 6 388
  • 文/花漫 我一把揭開白布斯议。 她就那樣靜靜地躺著产捞,像睡著了一般。 火紅的嫁衣襯著肌膚如雪捅位。 梳的紋絲不亂的頭發(fā)上轧葛,一...
    開封第一講書人閱讀 51,198評論 1 299
  • 那天,我揣著相機與錄音艇搀,去河邊找鬼尿扯。 笑死,一個胖子當著我的面吹牛焰雕,可吹牛的內(nèi)容都是我干的衷笋。 我是一名探鬼主播,決...
    沈念sama閱讀 40,084評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼矩屁,長吁一口氣:“原來是場噩夢啊……” “哼辟宗!你這毒婦竟也來了?” 一聲冷哼從身側響起吝秕,我...
    開封第一講書人閱讀 38,926評論 0 274
  • 序言:老撾萬榮一對情侶失蹤泊脐,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后烁峭,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體容客,經(jīng)...
    沈念sama閱讀 45,341評論 1 311
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,563評論 2 333
  • 正文 我和宋清朗相戀三年约郁,在試婚紗的時候發(fā)現(xiàn)自己被綠了缩挑。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,731評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡鬓梅,死狀恐怖供置,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情绽快,我是刑警寧澤芥丧,帶...
    沈念sama閱讀 35,430評論 5 343
  • 正文 年R本政府宣布,位于F島的核電站坊罢,受9級特大地震影響续担,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜艘绍,卻給世界環(huán)境...
    茶點故事閱讀 41,036評論 3 326
  • 文/蒙蒙 一赤拒、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦挎挖、人聲如沸这敬。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,676評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽崔涂。三九已至,卻和暖如春始衅,著一層夾襖步出監(jiān)牢的瞬間冷蚂,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,829評論 1 269
  • 我被黑心中介騙來泰國打工汛闸, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留蝙茶,地道東北人。 一個月前我還...
    沈念sama閱讀 47,743評論 2 368
  • 正文 我出身青樓诸老,卻偏偏與公主長得像隆夯,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子别伏,可洞房花燭夜當晚...
    茶點故事閱讀 44,629評論 2 354

推薦閱讀更多精彩內(nèi)容