画出一个好的架构图之前， 首先应该要明确其受众，再想清楚要给他们传递什么信息 ，所以，不要为了画一个物理视图去画物理视图，为了画一个逻辑视图去画逻辑视图，而应该根据受众的不同，传递的信息的不同，用图准确地表达出来，最后的图可能就是在这样一些分类里。那么，画出的图好不好的一个直接标准就是：受众有没有准确接收到想传递的信息。

明确这两点之后，从受众角度来说，一个好的架构图是不需要解释的，它应该是自描述的，并且要具备一致性和足够的准确性，能够与代码相呼应。

架构图的主要目的应该是促进协作、增强沟通、提供愿景和指导。

在墙上绘制一两个高级架构图并在会议（站会等）期间使用它们。作为一名架构师，你应该让它们可见，变得有价值，并作为项目文化的一部分。不要将它们隐藏起来或放在利益相关者不易接触到的地方。

C4 模型使用容器（应用程序、数据存储、微服务等）、组件和代码来描述一个软件系统的静态结构。

1、语境图(System Context Diagram)

image

这是一个想象的待建设的互联网银行系统，它使用外部的大型机银行系统存取客户账户、交易信息，通过外部电邮系统给客户发邮件。可以看到，非常简单、清晰，相信不需要解释，都看的明白，里面包含了需要建设的系统本身，系统的客户，和这个系统有交互的周边系统。

★ 用途

这样一个简单的图，可以告诉我们，要构建的系统是什么；它的用户是谁，谁会用它，它要如何融入已有的IT环境。这个图的受众可以是开发团队的内部人员、外部的技术或非技术人员。即：

• 构建的系统是什么

• 谁会用它

• 如何融入已有的IT环境

★ 怎么画

中间是自己的系统，周围是用户和其它与之相互作用的系统。这个图的关键就是梳理清楚待建设系统的用户和高层次的依赖，梳理清楚了画下来只需要几分钟时间。

2、容器图(Container Diagram)

容器图是把语境图里待建设的系统做了一个展开。

image

上图中，除了用户和外围系统，要建设的系统包括一个基于java\spring mvc的web应用提供系统的功能入口，基于xamarin架构的手机app提供手机端的功能入口，一个基于java的api应用提供服务，一个mysql数据库用于存储，各个应用之间的交互都在箭头线上写明了。

看这张图的时候，不会去关注到图中是直角方框还是圆角方框，不会关注是实线箭头还是虚线箭头，甚至箭头的指向也没有引起太多注意。

我们有许多的画图方式，都对框、线的含义做了定义，这就需要画图的人和看图的人都清晰的理解这些定义，才能读全图里的信息，而现实是，这往往是非常高的一个要求，所以，很多图只能看个大概的含义。

★ 用途

这个图的受众可以是团队内部或外部的开发人员，也可以是运维人员。用途可以罗列为：

• 展现了软件系统的整体形态

• 体现了高层次的技术决策

• 系统中的职责是如何分布的，容器间的是如何交互的

• 告诉开发者在哪里写代码

★ 怎么画

用一个框图来表示，内部可能包括名称、技术选择、职责，以及这些框图之间的交互，如果涉及外部系统，最好明确边界。

3、组件图(Component Diagram)

image

组件图是把某个容器进行展开，描述其内部的模块。

★ 用途

这个图主要是给内部开发人员看的，怎么去做代码的组织和构建。其用途有：

• 描述了系统由哪些组件/服务组成

• 厘清了组件之间的关系和依赖

• 为软件开发如何分解交付提供了框架

4、类图(Code/Class Diagram)

image

这个图很显然是给技术人员看的，比较常见，就不详细介绍了。

案例分享

下面是内部的一个实时数据工具的架构图。作为一个应该自描述的架构图，这里不多做解释了。如果有看不明白的，那肯定是还画的不够好。

image

画好架构图可能有许多方法论，本篇主要介绍了C4这种方法，C4的理论也是不断进化的。但不论是哪种画图方法论，我们回到画图初衷，更好的交流，我们在画的过程中不必被条条框框所限制。简而言之，画之前想好：画图给谁看，看什么，怎么样不解释就看懂。

C4的工具

在挑选了众多工具之后，发现C4-PlantUML比较适合，当然功能最强大的还是C4 model官网推荐的第一个工具structurizr，但是是商业版本的。C4-PlantUML是可以用文本描述图形和图形关系，但是不足之处是支持的图并不是很全，不支持动态图和部署图。所有图形符号使用方框标示的，直观性要差一些。

安装

下载java并安装，Path里面也要有java的路径
下载graphviz并安装
下载visual studio code安装

配置graphviz的环境

找到本地graphviz的安装路径的bin目录，我的是D:\Program Files (x86)\Graphviz2.38\bin，然后配置系统变量GRAPHVIZ_DOT的值为D:\Program Files (x86)\Graphviz2.38\bin\dot.exe 就成功了

安装vscode插件

打开vscode
运行 VS Code Quick Open (Ctrl+P)
输入ext install plantuml

图形示例

作者：saidev
链接：https://www.jianshu.com/p/e7709737317a
来源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。