測(cè)試架構(gòu)師必備 -- 如何畫(huà)好架構(gòu)圖
技術(shù)傳播的價(jià)值，不僅僅體現(xiàn)在通過(guò)商業(yè)化產(chǎn)品和開(kāi)源項(xiàng)目來(lái)縮短我們構(gòu)建應(yīng)用的路徑，加速業(yè)務(wù)的上線(xiàn)速率，也體現(xiàn)在優(yōu)秀工程師在工作效率提升、產(chǎn)品性能優(yōu)化和用戶(hù)體驗(yàn)改善等經(jīng)驗(yàn)方面的分享，以提高我們的專(zhuān)業(yè)能力。
當(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à)都不滿(mǎn)意……
如果有同樣的困惑，本文將介紹一種畫(huà)圖的方法論，來(lái)讓架構(gòu)圖更清晰。
先厘清一些基礎(chǔ)概念
1、什么是架構(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è)很大的話(huà)題，本篇就不做深入了。有了架構(gòu)之后，就需要讓干系人理解、遵循相關(guān)決策。
2、什么是架構(gòu)圖
系統(tǒng)架構(gòu)圖是為了抽象的表示軟件系統(tǒng)的整體輪廓和各個(gè)組件之間的相互關(guān)系和約束邊界，以及軟件系統(tǒng)的物理部署和軟件系統(tǒng)的演進(jìn)方向的整體視圖。
3、架構(gòu)圖的作用
一圖勝千言。要讓干系人理解、遵循架構(gòu)決策，就需要把架構(gòu)信息傳遞出去。架構(gòu)圖就是一個(gè)很好的載體。那么，畫(huà)架構(gòu)圖是為了：
解決溝通障礙
達(dá)成共識(shí)
減少歧義
4、架構(gòu)圖分類(lèi)
搜集了很多資料，分類(lèi)有很多，有一種比較流行的是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)圖來(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)圖
上面的分類(lèi)是前人的經(jīng)驗(yàn)總結(jié)，圖也是從網(wǎng)上摘來(lái)的，那么這些圖畫(huà)的好不好呢？是不是我們要依葫蘆畫(huà)瓢去畫(huà)這樣一些圖？
先不去管這些圖好不好，我們通過(guò)對(duì)這些圖的分類(lèi)以及作用，思考了一下，總結(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)，最后的圖可能就是在這樣一些分類(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)題
1、方框代表什么？
為什么適用方框而不是圓形，它有什么特殊的含義嗎？隨意使用方框或者其它形狀可能會(huì)引起混淆。
2、虛線(xiàn)、實(shí)線(xiàn)什么意思？箭頭什么意思？顏色什么意思？
隨意使用線(xiàn)條或者箭頭可能會(huì)引起誤會(huì)。
3、運(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)
1、語(yǔ)境圖(System Context Diagram)
這是一個(gè)想象的待建設(shè)的互聯(lián)網(wǎng)銀行系統(tǒng)，它使用外部的大型機(jī)銀行系統(tǒng)存取客戶(hù)賬戶(hù)、交易信息，通過(guò)外部電郵系統(tǒng)給客戶(hù)發(fā)郵件。可以看到，非常簡(jiǎn)單、清晰，相信不需要解釋?zhuān)伎吹拿靼祝锩姘诵枰ㄔO(shè)的系統(tǒng)本身，系統(tǒng)的客戶(hù)，和這個(gè)系統(tǒng)有交互的周邊系統(tǒng)。
用途
這樣一個(gè)簡(jiǎn)單的圖，可以告訴我們，要構(gòu)建的系統(tǒng)是什么；它的用戶(hù)是誰(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)，周?chē)怯脩?hù)和其它與之相互作用的系統(tǒng)。這個(gè)圖的關(guān)鍵就是梳理清楚待建設(shè)系統(tǒng)的用戶(hù)和高層次的依賴(lài)，梳理清楚了畫(huà)下來(lái)只需要幾分鐘時(shí)間。
2、容器圖(Container Diagram)
容器圖是把語(yǔ)境圖里待建設(shè)的系統(tǒng)做了一個(gè)展開(kāi)。
上圖中，除了用戶(hù)和外圍系統(tǒng)，要建設(shè)的系統(tǒng)包括一個(gè)基于javaspring 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àn)上寫(xiě)明了。
看這張圖的時(shí)候，不會(huì)去關(guān)注到圖中是直角方框還是圓角方框，不會(huì)關(guān)注是實(shí)線(xiàn)箭頭還是虛線(xiàn)箭頭，甚至箭頭的指向也沒(méi)有引起太多注意。
我們有許多的畫(huà)圖方式，都對(duì)框、線(xiàn)的含義做了定義，這就需要畫(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)部可能包括名稱(chēng)、技術(shù)選擇、職責(zé)，以及這些框圖之間的交互，如果涉及外部系統(tǒng)，最好明確邊界。
3、組件圖(Component Diagram)
組件圖是把某個(gè)容器進(jìn)行展開(kāi)，描述其內(nèi)部的模塊。
用途
這個(gè)圖主要是給內(nèi)部開(kāi)發(fā)人員看的，怎么去做代碼的組織和構(gòu)建。其用途有：
描述了系統(tǒng)由哪些組件/服務(wù)組成
厘清了組件之間的關(guān)系和依賴(lài)
為軟件開(kāi)發(fā)如何分解交付提供了框架
4、類(lèi)圖(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í)看，看什么，怎么樣不解釋就看懂。
參考資料：
C4官網(wǎng)：
https://c4model.com/
為什么需要軟件架構(gòu)圖：
https://www.infoq.cn/article/GhprrUlOYyOqS8*FR1pH
書(shū)籍：《程序員必讀之軟件架構(gòu)》