画出你的项目架构图

近期在工作之余阅读了一本架构方面的书籍,《软件架构》,由国际知名架构师Simon Brown编写,国内邓刚翻译。全书200多页,分为了68个章节,8个部分,每个章节一到两页,全书阅读下来并不会花太多时间。相比较一些软件架构方面的大厚本,此书比较适合作为一部架构方面的入门书籍,阅读完此书,可以对架构师这个职业角色有个清晰的认识。

全书的第四部分,介绍了关于软件可视化的一些方案,感觉非常实用。在日常的项目开发过程中,会面临团队合作,部门间合作等问题,不同个体之间的合作,自然避免不了要做技术上的沟通。在缺少文档的时候,一副可以提现各个模块之间联系的架构图可以很好地提现项目整体逻辑,提高技术沟通的有效性。书中有介绍一种C4的模型,具有很强的表达性和制作简洁等优势,本文将详细介绍这个模型。

C4模型将软件系统分成:系统、容器、组件和类。系统即软件系统,一般需给出其具体的使用环境和需要解决的需求,在其之下会有一系列的容器;容器是一个个单独的可执行文件,负责其固定的功能,在每个单独的容器会有一系列的组件来构成该容器;组件是应用程序中的功能模块,每个组件负责各自单独的功能,最后为了实现该组件的特定功能,会有一系列的类来实现这个组件。总体的结构示意图如下:


结构图

根据场景的不同,可以将C4模型中的四个部分对应为:语境图(Context)、容器图(Container)、组件图(Component)和类图(Code),这也是C4模型名字的由来。

语境图

系统语境图是绘制一个软件系统的开始。在一个方框的中间画出系统,系统周围画出一些与之交互的使用者和其他功能系统。

在语境图中,不必详细的展示每个细节,需要更加关注于人和软件系统的关系,而不是技术细节和实现原理。语境图应该是一种可以展示给非技术人员看的图。

范围:一整个软件系统

关键元素:范围内的软件系统
辅助元素:范围内的人和软件系统之间的联系

受众:每个人,包括技术和非技术人员,软件开发团队内的人和团队外的人


语境图

容器图

一旦你理解软件系统适用的IT环境,真正有益的下一步是关注于系统周边的容器图。一个容器可以是一个:服务器端的web应用、单页面的应用程序、桌面应用程序、移动端APP、数据库方案、文件系统等等。基本特征是,容器是一个独立的可运行程序或者可部署单元。

容器图展示的软件的高层次组织结构,同时也展示了主要技术的选择和容器之间的交互。这是一种简单的高层技术选型的图,但对软件开发人员很有用。

范围:单独的软件系统

主要元素:软件系统内的各个容器
辅助元素:和容器相关的人和软件系统之间的联系

受众:软件系统开发团队相关的技术人员,包括了:架构师、开发者和技术支持人员

注意:该图不需要介绍部署场景、集群、复制和故障转移等等


容器图

组件图

组件图展示的是一个容器内部是如何组织各个组件的,一个组件即容器内部的一个功能和技术实现细节。

范围:单个容器

主要元素:容器范围内的各个组件
辅助元素:容器、和组件相关的人和软件系统的联系

受众:架构师和开发者


组件图

类图

类图是单个组件的实现代码组织,可以用类似UML图、整体关系图来表示。

这是一种可选的图,通常情况下可以用IDE和UML模型工具自动生成,你应该思考的是需要暴露类的那些属性和接口来表示这个组件的功能。类图不推荐制作,除非组件的功能逻辑相当复杂。

范围:单个组件

主要元素:组件范围内的代码元素,如:类、接口、对象、函数、基础表格等等。

受众:架构师和开发者


类图

总结

C4模型主要通过“抽象first”的方式来绘制架构图,通过基于上层的抽象反应出软件系统的结构,同时也体现了开发者对于软件系统的思考,这种基于子集的抽象和分层的方式使C4模型非常容易学习和使用。

在软件项目需要与拟出一份技术文稿的时候,可以先试试将软件系统绘制成一个个架构图,来梳理其结构。

参考资料

C4模型官网

程序员必读之软件架构

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,072评论 25 707
  • 窥探者 文/左艺 一 春天 是你撩拨出来的 正如你撩拨了一朵 端坐莲蓬的仙女 风 撩拨了健壮的山 雨在荆棘里挣扎 ...
    小骨木兰花阅读 645评论 1 8
  • 综览 安全散列算法secure hash algorithm ,是一个密码散列函数家族 是fips认证的五种安全散...
    一曲广陵散阅读 1,467评论 0 1
  • 成长,对努力想要抓住青春尾巴的女性来说,是一个充满矛盾的词,一方面,我们渴望成长,另一方面,也惶恐时间飞逝。...
    小妞育儿阅读 402评论 3 7