程式設計師必備技能——如何畫好架構圖

2020-12-11 酷扯兒

本文轉載自【微信公眾號:java進階架構師,ID:java_jiagoushi】經微信公眾號授權轉載,如需轉載與原文作者聯繫

技術傳播的價值,不僅僅體現在通過商業化產品和開源項目來縮短我們構建應用的路徑,加速業務的上線速率,也體現在優秀工程師在工作效率提升、產品性能優化和用戶體驗改善等經驗方面的分享,以提高我們的專業能力。

本文作者阿里巴巴技術專家三畫,分享了自己和團隊在畫好架構圖方面的理念和經驗,首發於阿里內部技術分享平臺,阿里巴巴中間件授權轉載,梓敬、鵬升和餘樂對此文亦有貢獻。

當我們想用一張或幾張圖來描述我們的系統時,是不是經常遇到以下情況:

對著畫布無從下手、刪了又來?用一張圖描述我的系統,並且讓產品、運營、開發都能看明白?畫了一半的圖還不清楚受眾是誰?畫出來的圖到底是產品圖功能圖還是技術圖又或是大雜燴?圖上的框框有點少是不是要找點兒框框加進來?布局怎麼畫都不滿意……

如果有同樣的困惑,本文將介紹一種畫圖的方法論,來讓架構圖更清晰。

先釐清一些基礎概念

1、什麼是架構

架構就是對系統中的實體以及實體之間的關系所進行的抽象描述,是一系列的決策。

架構是結構和願景。

系統架構是概念的體現,是對物/信息的功能與形式元素之間的對應情況所做的分配,是對元素之間的關係以及元素同周邊環境之間的關系所做的定義。

做好架構是個複雜的任務,也是個很大的話題,本篇就不做深入了。有了架構之後,就需要讓干係人理解、遵循相關決策。

2、什麼是架構圖

系統架構圖是為了抽象的表示軟體系統的整體輪廓和各個組件之間的相互關係和約束邊界,以及軟體系統的物理部署和軟體系統的演進方向的整體視圖。

3、架構圖的作用

一圖勝千言。要讓干係人理解、遵循架構決策,就需要把架構信息傳遞出去。架構圖就是一個很好的載體。那麼,畫架構圖是為了:

解決溝通障礙達成共識減少歧義

4、架構圖分類

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

場景視圖場景視圖用於描述系統的參與者與功能用例間的關係,反映系統的最終需求和互動設計,通常由用例圖表示。

邏輯視圖邏輯視圖用於描述系統軟體功能拆解後的組件關係,組件約束和邊界,反映系統整體組成與系 統如何構建的過程,通常由UML的組件圖和類圖來表示。

物理視圖物理視圖用於描述系統軟體到物理硬體的映射關係,反映出系統的組件是如何部署到一組可 計算機器節點上,用於指導軟體系統的部署實施過程。

處理流程視圖處理流程視圖用於描述系統軟體組件之間的通信時序,數據的輸入輸出,反映系統的功能流程 與數據流程,通常由時序圖和流程圖表示。

開發視圖開發視圖用於描述系統的模塊劃分和組成,以及細化到內部包的組成設計,服務於開發人員,反映系統開發實施過程。

以上 5 種架構視圖從不同角度表示一個軟體系統的不同特徵,組合到一起作為架構藍圖描述系統架構。

怎樣的架構圖是好的架構圖

上面的分類是前人的經驗總結,圖也是從網上摘來的,那麼這些圖畫的好不好呢?是不是我們要依葫蘆畫瓢去畫這樣一些圖?

先不去管這些圖好不好,我們通過對這些圖的分類以及作用,思考了一下,總結下來,我們認為,在畫出一個好的架構圖之前, 首先應該要明確其受眾,再想清楚要給他們傳遞什麼信息 ,所以,不要為了畫一個物理視圖去畫物理視圖,為了畫一個邏輯視圖去畫邏輯視圖,而應該根據受眾的不同,傳遞的信息的不同,用圖準確地表達出來,最後的圖可能就是在這樣一些分類裡。那麼,畫出的圖好不好的一個直接標準就是:受眾有沒有準確接收到想傳遞的信息。

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

畫架構圖遇到的常見問題

1、方框代表什麼?

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

2、虛線、實線什麼意思?箭頭什麼意思?顏色什麼意思?

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

3、運行時與編譯時衝突?層級衝突?

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

本文推薦的畫圖方法

C4 模型使用容器(應用程式、數據存儲、微服務等)、組件和代碼來描述一個軟體系統的靜態結構。這幾種圖比較容易畫,也給出了畫圖要點,但最關鍵的是,我們認為,它明確指出了每種圖可能的受眾以及意義。

下面的案例來自C4官網,然後加上了一些我們的理解,來看看如何更好的表達軟體架構

1、語境圖(System Context Diagram)

這是一個想像的待建設的網際網路銀行系統,它使用外部的大型機銀行系統存取客戶帳戶、交易信息,通過外部電郵系統給客戶發郵件。可以看到,非常簡單、清晰,相信不需要解釋,都看的明白,裡面包含了需要建設的系統本身,系統的客戶,和這個系統有交互的周邊系統。

用途

這樣一個簡單的圖,可以告訴我們,要構建的系統是什麼;它的用戶是誰,誰會用它,它要如何融入已有的IT環境。這個圖的受眾可以是開發團隊的內部人員、外部的技術或非技術人員。即:

構建的系統是什麼誰會用它如何融入已有的IT環境

怎麼畫

中間是自己的系統,周圍是用戶和其它與之相互作用的系統。這個圖的關鍵就是梳理清楚待建設系統的用戶和高層次的依賴,梳理清楚了畫下來只需要幾分鐘時間。

2、容器圖(Container Diagram)

容器圖是把語境圖裡待建設的系統做了一個展開。

上圖中,除了用戶和外圍系統,要建設的系統包括一個基於java\spring mvc的web應用提供系統的功能入口,基於xamarin架構的手機app提供手機端的功能入口,一個基於java的api應用提供服務,一個mysql資料庫用於存儲,

各個應用之間的交互都在箭頭線上寫明了。

看這張圖的時候,不會去關注到圖中是直角方框還是圓角方框,不會關注是實線箭頭還是虛線箭頭,甚至箭頭的指向也沒有引起太多注意。

我們有許多的畫圖方式,都對框、線的含義做了定義,這就需要畫圖的人和看圖的人都清晰的理解這些定義,才能讀全圖裡的信息,而現實是,這往往是非常高的一個要求,所以,很多圖只能看個大概的含義。

用途

這個圖的受眾可以是團隊內部或外部的開發人員,也可以是運維人員。用途可以羅列為:

展現了軟體系統的整體形態體現了高層次的技術決策系統中的職責是如何分布的,容器間的是如何交互的告訴開發者在哪裡寫代碼

怎麼畫

用一個框圖來表示,內部可能包括名稱、技術選擇、職責,以及這些框圖之間的交互,如果涉及外部系統,最好明確邊界。

3、組件圖(Component Diagram)

組件圖是把某個容器進行展開,描述其內部的模塊。

用途

這個圖主要是給內部開發人員看的,怎麼去做代碼的組織和構建。其用途有:

描述了系統由哪些組件/服務組成釐清了組件之間的關係和依賴為軟體開發如何分解交付提供了框架

4、類圖(Code/Class Diagram)

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

案例分享

下面是內部的一個實時數據工具的架構圖。作為一個應該自描述的架構圖,這裡不多做解釋了。如果有看不明白的,那肯定是還畫的不夠好。

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

相關焦點

  • 如何畫好一張架構圖?
    為什麼要畫架構圖?如何畫?有哪些方法?本文從架構的定義說起,分享阿里文娛高級技術專家簫逸關於畫架構圖多年的經驗總結,並對抽象這一概念進行了深入地討論。較長,同學們可收藏後再看。文末福利:架構師成長秘籍。什麼是架構圖?如何畫好一張架構圖,要做好這件事情首先要回答的就是什麼是架構圖。
  • 工作兩三年了,整不明白架構圖都畫啥?
    四、陪你畫個架構圖五、總結六、系列推薦一、前言很多程式設計師畫架構圖頭疼,不知道畫什麼、怎麼畫!分享、評審、述職、答辯,只要你在程式設計師這個行業,就幾乎離不開要畫圖。而我們畫的架構圖、流程圖、結構圖、功能圖、邏輯圖等,都需要好看、好懂、好用、好搞,因為:這就像君子在追求漂亮姑娘一樣,好看就想主動撩一下、有品行和共同的三觀很快讓你開口說我懂你、接下來就是交付質量和實施速度了,那也是水到渠成的事。
  • 產品經理需了解的架構圖/結構圖知識
    功能結構圖功能結構圖就是按照功能的從屬關係畫成的圖表,在該圖表中的每一個框都稱為一個功能模塊。功能模塊可以根據具體情況分得大一點或小一點,分解的最小功能模塊可以是一個程序中的每個處理過程,而較大的功能模塊則可能是完成某一個任務的一組程序。
  • 都說代碼注釋是程式設計師必備技能,但是你這注釋也太奇葩了吧!
    都說代碼注釋是程式設計師必備技能,但是你這注釋也太奇葩了吧! 程式設計師個個身手不凡,經常會見到一些神級般的操作,比如評論區爆笑、社區神評、前無古人的回覆需求等等,再比如今天分享的關於代碼注釋,真的是大開眼界。
  • 如何畫架構圖?
    畫架構圖分四步走: 第一,搞清楚要畫的架構圖的類型; 第二,確認架構圖中的關鍵要素(比如產品、技術、服務); 第三,梳理關鍵要素之間的關聯:包含、支撐、同級並列等; 第四,輸出關聯關係清晰的架構圖。
  • 自學的程式設計師如何找到好工作?
    我感覺自己缺乏很多有用的技能,來幫助我在人才市場上推銷自己(比如資料庫的工作原理,以及我應該使用哪些工具),我很好奇其他人是如何學習這些東西的。我打算去大學拿一個軟體開發的學位,但我開始感到有點沮喪,覺得讀大學的目的就是為了工作。現在有哪些我應該上的課程,或者應該做的事情嗎?
  • 2020軟體工程師必備的11項技能
    其中程式語言包括C++、Java,必需的計算機概念包括數據結構、算法和計算機網絡概念,工具包括Git、Docker、Kubernetes和容器,雲計算概念和平臺包括AWS、GCP、Microsoft Azure,常青樹技能包括SQL和UNIX,編輯器包括Eclipse、Visual Studio,文本編輯器包括VIM和NotePad++等。
  • 聊聊幾個程式設計師經常用的作圖軟體
    程式設計師除了要寫代碼之外還經常需要畫一些圖,這其中包括流程圖、軟體架構圖和一些說明文檔的插圖等等。目前大家用得比較多的可能是微軟的Visio、IBM的Rose或者億圖等軟體。這些軟體的功能確實非常強大,也完全夠我們使用了,但是需要收費的。
  • 如何畫出一份優秀的產品架構圖?
    在本文中,筆者也向大家介紹一下畫產品架構圖的流程以及關鍵點,希望對你有所啟發。一、什麼是產品架構圖產品架構圖是產品經理用來表達自己產品設計機制的一張概念圖:它將可視化的具象產品功能,抽象成信息化、模塊化、層次清晰的架構,並通過不同分層的交互關係、功能模塊的組合、數據和信息的流轉,來傳遞產品的業務流程、商業模式和設計思路。
  • 程式設計師成長分為哪幾個階段?需要掌握哪些技能?
    技能:我們知道如何團隊協作、如何使用項目管理工具、項目版本如何控制、我們寫的代碼如何測試如何在線上運行等等,積累了一定的開發經驗,也對代碼有了一定深入的認識,是一個比較純粹的Coder的階段。這個階段一般是程式設計師開始工作之後,他們需要在不同的項目中掌握進階技能,並逐漸確立自己的專長,程式設計師在職級上升的過程中要掌握一些專業技能,程式設計師會有意識自己學習。
  • 面試感悟:3年工作經驗java程式設計師應有的技能
    我們知道如何團隊協作、如何使用項目管理工具、項目版本如何控制、我們寫的代碼如何測試如何在線上運行等等,積累了一定的開發經驗,也對代碼有了一定深入的認識,是一個比較純粹的Coder的階段第二階段:五年五年又是區分程式設計師的第二個門檻。
  • 一名3年工作經驗的Java程式設計師應該具備哪些技能
    一名3年工作經驗的Java程式設計師應該具備的技能,這可能是Java程式設計師們比較關心的內容。1、基本語法這包括static、final、transient等關鍵字的作用,foreach循環的原理等等。6、數據結構和算法分析數據結構和算法分析,對於一名程式設計師來說,會比不會好而且在工作中能派上用場。數組、鍊表是基礎,棧和隊列深入一些但也不難,樹挺重要的,比較 重要的樹AVL樹、紅黑樹,可以不了解它們的具體實現,但是要知道什麼是二叉查找樹、什麼是平衡樹,AVL樹和紅黑樹的區別。
  • 阿里大牛:如何畫出一圖勝千言的技術架構圖?
    接下來,阿里巴巴技術專家三畫,將分享自己和團隊在畫好架構圖方面的理念和經驗,希望對你有所幫助。 當我們想用一張或幾張圖來描述我們的系統時,是不是經常遇到以下情況: 對著畫布無從下手、刪了又來? 如何用一張圖描述我的系統,並且讓產品、運營、開發都能看明白?
  • 程式設計師必備的50個快捷鍵,提升效率必備!
    每天工作都和電腦打交道,所以掌握一些常用的電腦快捷鍵很重要,尤其是程式設計師,工作上效率,質量,速度少一個都不行。而使用快捷鍵能讓他們在工作時更高效,更速度!下面就和大家分享50個程式設計師必備電腦快捷鍵,幫你提升工作效率100倍!
  • Android程式設計師未來十年的發展前景如何?
    只能說只要有網際網路存在,程式設計師依然是個高薪熱門行業。只要跟隨著時代的腳步,學習新的知識。程式設計師是不可能會消失的,或者說不可能會沒錢賺的。我們經常可以聽到很多人說,程式設計師是一個吃青春飯的行當。因為大多數人認為這是一個需要高強度腦力勞動的工種,而30歲、40歲,甚至50歲的程式設計師身體機能逐漸弱化,家庭瑣事纏身,已經不能再進行這樣高強度的工作了。
  • 為了做好PPT中的架構圖,我幾乎翻遍了國內外所有網際網路網站
    大家好,我是粒子!最近終於想起了公眾號密碼,跑來更新了。今天就來說說,「解決方案架構圖」。等等,先停止你的想像,這裡所說的架構圖並不是常見的「組織結構圖」,而是這種的。相比常見的公司組織結構圖,它更具有專業性與複雜性。
  • (面試感悟)一名3年工作經驗的程式設計師應該具備的技能
    我們知道如何團隊協作、如何使用項目管理工具、項目版本如何控制、我們寫的代碼如何測試如何在線上運行等等,積累了一定的開發經驗,也對代碼有了一定深入的認識,是一個比較純粹的Coder的階段第二階段—-五年五年又是區分程式設計師的第二個門檻。
  • 程式設計師是否需要刻意學習英語?
    而且一般理科好的同學, 通常英語都是要命的拉分(當然也有例外, 超級學霸除外)。今天我想就程式設計師到底需不需要學習英語來跟大家討論討論。作為程式設計師來說卻有不得不學英語的理由。首先,技術書籍。國外的編程技術還是要領先國內好多年的,所以學會閱讀英文技術書也是很重要的。開發文檔。通常我們學習一門語言或者一個框架的時候,最快最直接的方式是看官方文檔,大部分的框架都是來自於國外開發和開源,所以閱讀英文文檔也是至關重要的,它的單詞量真的就是四級的單詞量或者更簡單,所以逼自己去看英文文檔,對自己技術的提升和英文水平的提升都有很大的幫助。
  • 程式設計師必備的app推薦:提升技術,面試,記錄總結的平臺
    發現有趣app,專注分享高質量、有趣、有用的APP。
  • 程式設計師必備6款工具
    都說程式設計師的電腦上有各種各樣的軟體工具、編輯器、插件等等,不同崗位的程式設計師使用的工具也不同,今天小編就給大家分享6款程式設計師必備的工具軟體,看看是不是你們常用的!二、 oh-my-zsh命令行是程式設計師的最愛,所以這款替代bash工具必須得拿出來,雖然我們自帶的bash shell功能也很好了。