合格的架构图应该是什么样子的

结构图是什么

要回答合格的架构图应该是什么样子的,这样一个问题。我们首先应该知道架构图是什么。  

“架构图”中的“图”,我们好理解,一种图形化的方式,来表达/展示架构。

“架构图”是什么的问题则转化为“架构”是什么?架构的定义有很多。下面是其中一个。

Architecture is about the important stuff. Whatever that is.

--- Ralph Johnson

这样的定义似乎过于宽泛,但也让我们看到架构中所关注的是软件系统中重要的元素。那么架构图就是软件系统中重要元素间关系的抽象表达。其他一些架构图的概念也印证了这一点。

系统架构图,是为了抽象地表示软件系统的整体轮廓和各个组件之间的相互关系和约束边界,以及软件系统的物理部署和软件系统的演进方向的整体视图。

合格架构图需要具备什么

这样的定义,已经说明了架构的是什么,它的作用也不言而喻:便于干系人理解系统架构,减少分歧,统一认识。

为了探究什么是合格的架构图,让我们看一下,市面上常见的架构图。


一张不是很好的架构图(https://www.infoq.cn/article/crafting-architectural-diagrams/)


看过之后,我大致了解了系统架构,但又有一些疑问?

* 直线和虚线各代表什么?红线和绿线的区别是进出方向不同,为什么其他线没有颜色?

* Logic使用了Hibernate连接数据库,数据库使用了MySQL,他们的关系是通过位置来表达的。那Monitoring Service在Database下面,是表达了什么?

* 架构图中的方框表示组件,圆柱形表示中间件,Monitoring Service是一个服务为什么用白板的形状表示?

* 这张架构图,给开发看还能理解。如果给客户或者测试看,他们能否理解?或者是否需要了解系统的每个细枝末节?

一张架构图能够让人产生这么多疑问,没有起到统一认识和减少分歧作用,那它无疑不是一张合格的架构图。但通过这张图,也让我们发现一张合格的架构图,起码需要避免以上问题。

它至少需要具备:

统一的结构外观,需要在形状,边框,大小,颜色,线条等方面保持一致

简明的表达元素间关系,需要使用线条表示各个元素之间的关系,必要时在线条进行解释说明

多维度展示,应对不同的角色,在不同维度展示架构

认识到合格架构图的标准,那团队就可以把标准固化,形成规范保持下去,产出合格的架构图。

C4 Model

但我们知道项目是不断演进的,人员和文档也需要不断的更迭,长久下来这样的规则是否能够坚守下去?考虑到时间的推移和人的不可靠性,我们需要一个工具,来帮助团队固化标准,保证架构图的一致性和可追溯性。

C4 model(https://c4model.com/)正是这样的一个工具。

其中4个C中分别代表System Context diagram,Container Diagram,Component Diagram和Code Diagram。4个图的抽象粒度依次减小,从系统在整个IT环境中的位置到某个组件代码层级细节依次展示,适用于不同角色,不同维度理解系统。

不同层级适用于不同角色(https://c4model.com/)

Level 1: System Context diagram

System Context diagram,在最大的维度解释系统在整个IT系统里所处的位置,把系统置于图中间,周围是用户,以及其与其交互的第三方系统。在这个粒度上,需要关注的是用户以及第三方系统的交互;无需关注细节,具体的细节可以通过缩放查看其它粒度的图。它的作用是表达:系统的用户是谁,与哪些第三方系统交互,交互的方式是什么。

Level 2: Container diagram

Container diagram,在更细的粒度上解释系统。进一步剖析,展示内部结构,更适用于技术人员使用。其中一个容器,可以是一个后端服务,一个手机App/小程序,或者一个单页应用。它的作用是展示出系统技术选型,以及容器间和容器与其他的系统的具体交互。

Level 3: Component diagram

Component diagram,展示一个容器的具体组成和它们之间的联系。用来解释一个容器内部,组件的数量,构成方式,应用的技术和职责,以及组件间的交互。

Level 4: Code diagram

Code diagram展示一个组件的实现细节,通常使用UML类图表示,且自动生成。

C4 model也提供了其他类型的图,如System Landscape diagram,Deployment diagram等,可通过https://c4model.com/了解。

VS Code 中也提供了插件(https://github.com/qjebbs/vscode-plantuml)帮助绘制C4 model。以代码的形式动态生成C4 model,也可以通过git支持版本管理。如此一来,团队的架构图就保证了:一致性,可维护性,自解释性。

在这里https://github.com/RicardoNiepel/C4-PlantUML,你也可以获得C4 model的参考代码。

参考资料

https://c4model.com/

https://www.infoq.cn/article/crafting-architectural-diagrams

https://www.jiqizhixin.com/articles/2019-04-11-22

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,287评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,346评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,277评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,132评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,147评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,106评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,019评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,862评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,301评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,521评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,682评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,405评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,996评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,651评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,803评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,674评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,563评论 2 352

推荐阅读更多精彩内容