來自公眾號:阿里技術
導讀:技術傳播的價值,不僅僅體現(xiàn)在通過商業(yè)化產(chǎn)品和開源項目來縮短我們構(gòu)建應用的路徑仙蛉,加速業(yè)務的上線速率,也體現(xiàn)在優(yōu)秀工程師在工作效率提升挪凑、產(chǎn)品性能優(yōu)化和用戶體驗改善等經(jīng)驗方面的分享孕索,以提高我們的專業(yè)能力躏碳。
接下來,阿里巴巴技術專家三畫菇绵,將分享自己和團隊在畫好架構(gòu)圖方面的理念和經(jīng)驗肄渗,希望對你有所幫助。
當我們想用一張或幾張圖來描述我們的系統(tǒng)時翎嫡,是不是經(jīng)常遇到以下情況:
對著畫布無從下手永乌、刪了又來?
如何用一張圖描述我的系統(tǒng)圈驼,并且讓產(chǎn)品望几、運營、開發(fā)都能看明白橄抹?
畫了一半的圖還不清楚受眾是誰楼誓?
畫出來的圖到底是產(chǎn)品圖功能圖還是技術圖又或是大雜燴?
圖上的框框有點少是不是要找點兒框框加進來芬沉?
布局怎么畫都不滿意……
如果有同樣的困惑阁猜,本文將介紹一種畫圖的方法論,來讓架構(gòu)圖更清晰黄刚。
先厘清一些基礎概念
1民效、什么是架構(gòu)涛救?
架構(gòu)就是對系統(tǒng)中的實體以及實體之間的關系所進行的抽象描述业扒,是一系列的決策章鲤。
架構(gòu)是結(jié)構(gòu)和愿景皱蹦。
系統(tǒng)架構(gòu)是概念的體現(xiàn)凤粗,是對物/信息的功能與形式元素之間的對應情況所做的分配捶索,是對元素之間的關系以及元素同周邊環(huán)境之間的關系所做的定義酝润。
做好架構(gòu)是個復雜的任務,也是個很大的話題脐供,本篇就不做深入了仅孩。有了架構(gòu)之后公浪,就需要讓干系人理解预柒、遵循相關決策宜鸯。
2锯梁、什么是架構(gòu)圖陌凳?
系統(tǒng)架構(gòu)圖是為了抽象地表示軟件系統(tǒng)的整體輪廓和各個組件之間的相互關系和約束邊界,以及軟件系統(tǒng)的物理部署和軟件系統(tǒng)的演進方向的整體視圖蕊肥。
3壁却、架構(gòu)圖的作用
一圖勝千言。要讓干系人理解推盛、遵循架構(gòu)決策瘪菌,就需要把架構(gòu)信息傳遞出去师妙。架構(gòu)圖就是一個很好的載體屹培。那么,畫架構(gòu)圖是為了:
解決溝通障礙
達成共識
減少歧義
4壁顶、架構(gòu)圖分類
搜集了很多資料若专,分類有很多蝴猪,有一種比較流行的是4+1視圖,分別為場景視圖嚎莉、邏輯視圖沛豌、物理視圖跳芳、處理流程視圖和開發(fā)視圖飞盆。
★ 場景視圖
場景視圖用于描述系統(tǒng)的參與者與功能用例間的關系吓歇,反映系統(tǒng)的最終需求和交互設計,通常由用例圖表示丧慈。
★ 邏輯視圖
邏輯視圖用于描述系統(tǒng)軟件功能拆解后的組件關系簇搅,組件約束和邊界,反映系統(tǒng)整體組成與系統(tǒng)如何構(gòu)建的過程肠仪,通常由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 種架構(gòu)視圖從不同角度表示一個軟件系統(tǒng)的不同特征,組合到一起作為架構(gòu)藍圖描述系統(tǒng)架構(gòu)。
怎樣的架構(gòu)圖是好的架構(gòu)圖
上面的分類是前人的經(jīng)驗總結(jié)金刁,圖也是從網(wǎng)上摘來的斯议,那么這些圖畫的好不好呢?是不是我們要依葫蘆畫瓢去畫這樣一些圖?
先不去管這些圖好不好衷笋,我們通過對這些圖的分類以及作用,思考了一下烁峭,總結(jié)下來鬓梅,我們認為芥丧,在畫出一個好的架構(gòu)圖之前活孩, 首先應該要明確其受眾,再想清楚要給他們傳遞什么信息 蕉朵,所以汛闸,不要為了畫一個物理視圖去畫物理視圖钳恕,為了畫一個邏輯視圖去畫邏輯視圖厘肮,而應該根據(jù)受眾的不同巩检,傳遞的信息的不同,用圖準確地表達出來提揍,最后的圖可能就是在這樣一些分類里浙垫。那么,畫出的圖好不好的一個直接標準就是:受眾有沒有準確接收到想傳遞的信息。
明確這兩點之后,從受眾角度來說,一個好的架構(gòu)圖是不需要解釋的,它應該是自描述的,并且要具備一致性和足夠的準確性忍坷,能夠與代碼相呼應。
畫架構(gòu)圖遇到的常見問題
1适秩、方框代表什么骤公?
為什么適用方框而不是圓形倍奢,它有什么特殊的含義嗎?隨意使用方框或者其它形狀可能會引起混淆碉碉。
2贴届、虛線元潘、實線什么意思返咱?箭頭什么意思评姨?顏色什么意思?
隨意使用線條或者箭頭可能會引起誤會敲才。
3敏储、運行時與編譯時沖突?層級沖突?
架構(gòu)是一項復雜的工作刊头,只使用單個圖表來表示架構(gòu)很容易造成莫名其妙的語義混亂。
本文推薦的畫圖方法
C4 模型使用容器(應用程序被碗、數(shù)據(jù)存儲焚志、微服務等)壶谒、組件和代碼來描述一個軟件系統(tǒng)的靜態(tài)結(jié)構(gòu)挑社。這幾種圖比較容易畫阱当,也給出了畫圖要點弊添,但最關鍵的是免钻,我們認為,它明確指出了每種圖可能的受眾以及意義。
下面的案例來自C4官網(wǎng),然后加上了一些我們的理解,來看看如何更好的表達軟件架構(gòu)
1、語境圖(System Context Diagram)
這是一個想象的待建設的互聯(lián)網(wǎng)銀行系統(tǒng)这弧,它使用外部的大型機銀行系統(tǒng)存取客戶賬戶、交易信息,通過外部電郵系統(tǒng)給客戶發(fā)郵件。可以看到,非常簡單堡掏、清晰,相信不需要解釋,都看的明白玷坠,里面包含了需要建設的系統(tǒng)本身秕重,系統(tǒng)的客戶服鹅,和這個系統(tǒng)有交互的周邊系統(tǒng)仗哨。
★ 用途
這樣一個簡單的圖,可以告訴我們,要構(gòu)建的系統(tǒng)是什么;它的用戶是誰,誰會用它涝涤,它要如何融入已有的IT環(huán)境类嗤。這個圖的受眾可以是開發(fā)團隊的內(nèi)部人員精偿、外部的技術或非技術人員。即:
構(gòu)建的系統(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架構(gòu)的手機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ā)人員看的紊服,怎么去做代碼的組織和構(gòu)建。其用途有:
描述了系統(tǒng)由哪些組件/服務組成
厘清了組件之間的關系和依賴
為軟件開發(fā)如何分解交付提供了框架
4、類圖(Code/Class Diagram)
這個圖很顯然是給技術人員看的煎饼,比較常見吆玖,就不詳細介紹了马篮。
案例分享
下面是內(nèi)部的一個實時數(shù)據(jù)工具的架構(gòu)圖浑测。作為一個應該自描述的架構(gòu)圖,這里不多做解釋了掷匠。如果有看不明白的岖圈,那肯定是還畫的不夠好蜂科。
畫好架構(gòu)圖可能有許多方法論短条,本篇主要介紹了C4這種方法茸时,C4的理論也是不斷進化的鸠儿。但不論是哪種畫圖方法論进每,我們回到畫圖初衷,更好的交流嘱兼,我們在畫的過程中不必被條條框框所限制芹壕。簡而言之接奈,畫之前想好:畫圖給誰看,看什么睁壁,怎么樣不解釋就看懂互捌。
作者簡介:三畫秕噪,阿里巴巴技術專家,梓敬遂填、鵬升和余樂對此文亦有貢獻城菊。三畫曾多年從事工作流引擎研發(fā)工作碉克,現(xiàn)專注于高并發(fā)移動互聯(lián)網(wǎng)應用的架構(gòu)和開發(fā),和本文貢獻者均來自阿里巴巴零售通部門客税。目前零售通大量招Java開發(fā),歡迎有志之士投簡歷到 lst-wireless@alibaba-inc.com更耻,和我們一起共建智能分銷網(wǎng)絡测垛,讓百萬小店擁抱DT時代。
參考資料:
C4官網(wǎng):https://c4model.com/
為什么需要軟件架構(gòu)圖:
https://www.infoq.cn/article/GhprrUlOYyOqS8*FR1pH
書籍:《程序員必讀之軟件架構(gòu)》