阿里技術(shù)專家:一文教你高效畫(huà)出技術(shù)架構(gòu)圖

技術(shù)傳播的價(jià)值,不僅僅體現(xiàn)在通過(guò)商業(yè)化產(chǎn)品和開(kāi)源項(xiàng)目來(lái)縮短我們構(gòu)建應(yīng)用的路徑。加速業(yè)務(wù)的上線速率,也體現(xiàn)在優(yōu)秀工程師的工作效率提升、產(chǎn)品性能優(yōu)化和用戶體驗(yàn)改善等經(jīng)驗(yàn)方面的分享,以提高我們的專業(yè)能力。

接下來(lái),阿里巴巴技術(shù)專家三畫(huà),將分享自己和團(tuán)隊(duì)在畫(huà)好架構(gòu)圖方面的理念和經(jīng)驗(yàn),希望對(duì)你有所幫助。當(dāng)我們想用一張或幾張圖來(lái)描述我們的系統(tǒng)時(shí),是不是經(jīng)常遇到以下情況:

對(duì)著畫(huà)布無(wú)從下手、刪了又來(lái)?如何用一張圖描述我的系統(tǒng),并且讓產(chǎn)品、運(yùn)營(yíng)、開(kāi)發(fā)都能看明白?畫(huà)了一半的圖還不清楚受眾是誰(shuí)?畫(huà)出來(lái)的圖到底是產(chǎn)品圖功能圖還是技術(shù)圖又或是大雜燴?圖上的框框有點(diǎn)少是不是要找點(diǎn)兒框框加進(jìn)來(lái)?布局怎么畫(huà)都不滿意…

如果有同樣的困惑,本文將介紹一種畫(huà)圖的方法論,來(lái)讓架構(gòu)圖更清晰。

先厘清一些基礎(chǔ)概念

什么是架構(gòu)?

架構(gòu)就是對(duì)系統(tǒng)中的實(shí)體以及實(shí)體之間的關(guān)系所進(jìn)行的抽象描述,是一系列的決策。

架構(gòu)是結(jié)構(gòu)和愿景。系統(tǒng)架構(gòu)是概念的體現(xiàn),是對(duì)物/信息的功能與形式元素之間的對(duì)應(yīng)情況所做的分配,是對(duì)元素之間的關(guān)系以及元素同周邊環(huán)境之間的關(guān)系所做的定義。

做好架構(gòu)是個(gè)復(fù)雜的任務(wù),也是個(gè)很大的話題,本篇就不做深入了。有了架構(gòu)之后,就需要讓干系人理解、遵循相關(guān)決策。

什么是架構(gòu)圖?

系統(tǒng)架構(gòu)圖是為了抽象地表示軟件系統(tǒng)的整體輪廓和各個(gè)組件之間的相互關(guān)系和約束邊界,以及軟件系統(tǒng)的物理部署和軟件系統(tǒng)的演進(jìn)方向的整體視圖。

架構(gòu)圖的作用

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

那么,畫(huà)架構(gòu)圖是為了:

  • 解決溝通障礙

  • 達(dá)成共識(shí)

  • 減少歧義

架構(gòu)圖分類

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

場(chǎng)景視圖

場(chǎng)景視圖用于描述系統(tǒng)的參與者與功能用例間的關(guān)系,反映系統(tǒng)的最終需求和交互設(shè)計(jì),通常由用例圖表示。

圖片
邏輯視圖

邏輯視圖用于描述系統(tǒng)軟件功能拆解后的組件關(guān)系,組件約束和邊界,反映系統(tǒng)整體組成與系統(tǒng)如何構(gòu)建的過(guò)程,通常由 UML 的組件圖和類圖來(lái)表示。

圖片
物理視圖

物理視圖用于描述系統(tǒng)軟件到物理硬件的映射關(guān)系,反映出系統(tǒng)的組件是如何部署到一組可計(jì)算機(jī)器節(jié)點(diǎn)上,用于指導(dǎo)軟件系統(tǒng)的部署實(shí)施過(guò)程。

圖片
處理流程視圖

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

圖片
開(kāi)發(fā)視圖

開(kāi)發(fā)視圖用于描述系統(tǒng)的模塊劃分和組成,以及細(xì)化到內(nèi)部包的組成設(shè)計(jì),服務(wù)于開(kāi)發(fā)人員,反映系統(tǒng)開(kāi)發(fā)實(shí)施過(guò)程。

圖片

以上 5 種架構(gòu)視圖從不同角度表示一個(gè)軟件系統(tǒng)的不同特征,組合到一起作為架構(gòu)藍(lán)圖描述系統(tǒng)架構(gòu)。

怎樣的架構(gòu)圖是好的架構(gòu)圖

上面的分類是前人的經(jīng)驗(yàn)總結(jié),圖也是從網(wǎng)上摘來(lái)的,那么這些圖畫(huà)的好不好呢?是不是我們要依葫蘆畫(huà)瓢去畫(huà)這樣一些圖?

先不去管這些圖好不好,我們通過(guò)對(duì)這些圖的分類以及作用,思考了一下,總結(jié)下來(lái)。

我們認(rèn)為,在畫(huà)出一個(gè)好的架構(gòu)圖之前, 首先應(yīng)該要明確其受眾,再想清楚要給他們傳遞什么信息 。

所以,不要為了畫(huà)一個(gè)物理視圖去畫(huà)物理視圖,為了畫(huà)一個(gè)邏輯視圖去畫(huà)邏輯視圖,而應(yīng)該根據(jù)受眾的不同,傳遞的信息的不同,用圖準(zhǔn)確地表達(dá)出來(lái),最后的圖可能就是在這樣一些分類里。

那么,畫(huà)出的圖好不好的一個(gè)直接標(biāo)準(zhǔn)就是:受眾有沒(méi)有準(zhǔn)確接收到想傳遞的信息。

明確這兩點(diǎn)之后,從受眾角度來(lái)說(shuō),一個(gè)好的架構(gòu)圖是不需要解釋的,它應(yīng)該是自描述的,并且要具備一致性和足夠的準(zhǔn)確性,能夠與代碼相呼應(yīng)。

畫(huà)架構(gòu)圖遇到的常見(jiàn)問(wèn)題

方框代表什么?

圖片

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

虛線、實(shí)線什么意思?箭頭什么意思?顏色什么意思?

圖片

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

運(yùn)行時(shí)與編譯時(shí)沖突?層級(jí)沖突?

圖片

架構(gòu)是一項(xiàng)復(fù)雜的工作,只使用單個(gè)圖表來(lái)表示架構(gòu)很容易造成莫名其妙的語(yǔ)義混亂。

本文推薦的畫(huà)圖方法

圖片

C4 模型使用容器(應(yīng)用程序、數(shù)據(jù)存儲(chǔ)、微服務(wù)等)、組件和代碼來(lái)描述一個(gè)軟件系統(tǒng)的靜態(tài)結(jié)構(gòu)。

這幾種圖比較容易畫(huà),也給出了畫(huà)圖要點(diǎn),但最關(guān)鍵的是,我們認(rèn)為,它明確指出了每種圖可能的受眾以及意義。

下面的案例來(lái)自 C4 官網(wǎng),然后加上了一些我們的理解,來(lái)看看如何更好的表達(dá)軟件架構(gòu)。

語(yǔ)境圖(System Context Diagram)

圖片

這是一個(gè)想象的待建設(shè)的互聯(lián)網(wǎng)銀行系統(tǒng),它使用外部的大型機(jī)銀行系統(tǒng)存取客戶賬戶、交易信息,通過(guò)外部電郵系統(tǒng)給客戶發(fā)郵件。

可以看到,非常簡(jiǎn)單、清晰,相信不需要解釋,都看的明白,里面包含了需要建設(shè)的系統(tǒng)本身,系統(tǒng)的客戶,和這個(gè)系統(tǒng)有交互的周邊系統(tǒng)。

這樣一個(gè)簡(jiǎn)單的圖,可以告訴我們,要構(gòu)建的系統(tǒng)是什么;它的用戶是誰(shuí),誰(shuí)會(huì)用它,它要如何融入已有的 IT 環(huán)境。

這個(gè)圖的受眾可以是開(kāi)發(fā)團(tuán)隊(duì)的內(nèi)部人員、外部的技術(shù)或非技術(shù)人員。即:

  • 構(gòu)建的系統(tǒng)是什么

  • 誰(shuí)會(huì)用它

  • 如何融入已有的 IT 環(huán)境

怎么畫(huà)?中間是自己的系統(tǒng),周圍是用戶和其他與之相互作用的系統(tǒng)。這個(gè)圖的關(guān)鍵就是梳理清楚待建設(shè)系統(tǒng)的用戶和高層次的依賴,梳理清楚了畫(huà)下來(lái)只需要幾分鐘時(shí)間。

容器圖(Container Diagram)

容器圖是把語(yǔ)境圖里待建設(shè)的系統(tǒng)做了一個(gè)展開(kāi)。

圖片

上圖中,除了用戶和外圍系統(tǒng),要建設(shè)的系統(tǒng)包括一個(gè)基于 Java\Spring MVC的 Web 應(yīng)用提供系統(tǒng)的功能入口,基于 Xamarin 架構(gòu)的手機(jī) App 提供手機(jī)端的功能入口,一個(gè)基于 Java 的 API 應(yīng)用提供服務(wù),一個(gè) MySQL 數(shù)據(jù)庫(kù)用于存儲(chǔ),各個(gè)應(yīng)用之間的交互都在箭頭線上寫(xiě)明了。

看這張圖的時(shí)候,不會(huì)去關(guān)注到圖中是直角方框還是圓角方框,不會(huì)關(guān)注是實(shí)線箭頭還是虛線箭頭,甚至箭頭的指向也沒(méi)有引起太多注意。

我們有許多的畫(huà)圖方式,都對(duì)框、線的含義做了定義,這就需要畫(huà)圖的人和看圖的人都清晰的理解這些定義,才能讀全圖里的信息。

而現(xiàn)實(shí)是,這往往是非常高的一個(gè)要求,所以,很多圖只能看個(gè)大概的含義。

這個(gè)圖的受眾可以是團(tuán)隊(duì)內(nèi)部或外部的開(kāi)發(fā)人員,也可以是運(yùn)維人員。用途可以羅列為:

  • 展現(xiàn)了軟件系統(tǒng)的整體形態(tài)。

  • 體現(xiàn)了高層次的技術(shù)決策。

  • 系統(tǒng)中的職責(zé)是如何分布的,容器間是如何交互的。

  • 告訴開(kāi)發(fā)者在哪里寫(xiě)代碼。

怎么畫(huà)?用一個(gè)框圖來(lái)表示,內(nèi)部可能包括名稱、技術(shù)選擇、職責(zé),以及這些框圖之間的交互,如果涉及外部系統(tǒng),最好明確邊界。

組件圖(Component Diagram)

圖片

組件圖是把某個(gè)容器進(jìn)行展開(kāi),描述其內(nèi)部的模塊。

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

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

  • 厘清了組件之間的關(guān)系和依賴

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

類圖(Code/Class Diagram)

圖片

這個(gè)圖很顯然是給技術(shù)人員看的,比較常見(jiàn),就不詳細(xì)介紹了。

案例分享

下面是內(nèi)部的一個(gè)實(shí)時(shí)數(shù)據(jù)工具的架構(gòu)圖。作為一個(gè)應(yīng)該自描述的架構(gòu)圖,這里不多做解釋了。如果有看不明白的,那肯定是還畫(huà)的不夠好。

圖片

畫(huà)好架構(gòu)圖可能有許多方法論,本篇主要介紹了 C4 這種方法,C4 的理論也是不斷進(jìn)化的。

但不論是哪種畫(huà)圖方法論,我們回到畫(huà)圖初衷,是為了更好的交流,我們?cè)诋?huà)的過(guò)程中不必被條條框框所限制。簡(jiǎn)而言之,畫(huà)之前想好:畫(huà)圖給誰(shuí)看,看什么,怎么樣不解釋就看懂。

畫(huà)圖的工具有:

  • Keynote

  • Xmind

  • EdrawMax

  • Visio

  • OmniGraffle

  • Process On

文中物理視圖 Download 地址:

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,527評(píng)論 6 544
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,687評(píng)論 3 429
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說(shuō)我怎么就攤上這事?!?“怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 178,640評(píng)論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 63,957評(píng)論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 72,682評(píng)論 6 413
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 56,011評(píng)論 1 329
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,009評(píng)論 3 449
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 43,183評(píng)論 0 290
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,714評(píng)論 1 336
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 41,435評(píng)論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,665評(píng)論 1 374
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,148評(píng)論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,838評(píng)論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 35,251評(píng)論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 36,588評(píng)論 1 295
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 52,379評(píng)論 3 400
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,627評(píng)論 2 380

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