作为开发人员，日常工作中难免会遇到一些需要画图的时候，特别是在写一些接口文档的时候，画一些流程图或者时序图是很重要的。但我们使用的大部分画图工具，都以独特的二进制文件存储，缺点不利于团队协作和分享，导致跟随代码的相关思维图不能更好地被管理，甚至无法与代码保持及时更新迭代，所以软件工程师们更希望通过像代码一样来管理图形化思维。目前越来越流行的一个概念是diagrams as code（DAC），也就是图表即代码。

就目前来说，通过DAC实现代码化的图表有以下的优势：

• 易于编辑（文本编辑器即可修改）
• 版本管理（借助版本管理软件git）
• 动态更新（可以通过代码来实时更新）

今天就来介绍5个架构师必备的diagrams as code工具，让你的日常工作效率倍增。

mermaid

Mermaid 是一个基于 Markdown 语法的绘图工具，通过简洁的语法，可以轻松绘制多种图表，让工作更高效、学习更有趣。 Mermaid 支持了大量的常见图表类型，比如流程图、时序图、类图、状态图、实体关系图、甘特图、C4图、思维导图等。

Mermaid 诞生的主要目的是让文档的更新能够及时跟上开发进度。绘图和编写文档花费了开发者宝贵的开发时间，而且随着业务的变更，它很快就会过期。 但是如果缺少了图表或文档，对于生产力和团队新人的业务学习都会产生巨大的阻碍。Mermaid 通过允许用户创建便于修改的图表来解决这一难题，它也可以作为生产脚本（或其他代码）的一部分。

下面是一些可以使用 Mermaid 创建的图表示例。

流程图

flowchart LR
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]

时序图

sequenceDiagram
Alice->>John: Hello John, how are you?
loop HealthCheck
    John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!

diagrams

diagrams 主要是一款云系统架构图的绘制工具，它的理念是 diagrams as code。

diagrams 让您可以用 Python 代码绘制云系统架构。它的诞生是为了在没有任何设计工具的情况下对新的系统架构设计进行原型设计。您还可以描述或可视化现有的系统架构。目前，Diagrams 支持的主要提供商包括：AWS、Azure、GCP、Kubernetes、Alibaba Cloud等Oracle Cloud...它还支持On-Premise节点、SaaS以及主要Programming框架和语言。

你还可以通过使用版本控制，比如git，来持续管理你的云上系统架构。说到云架构图这个事，这真是我的专业领域，其实diagrams生成的效果并不是太好，有很多产品效果上都比它要好看。但是diagrams有几点优势吧：

• 开源：这样它既是免费的，又可以按自己需要做扩展。
• DAC：虽然我个人觉得目前还是噱头偏大，但这个思路是好的
• 支持广泛：支持的云还是挺多的，国内当然还是少。

PlantUML

PlantUML是一款开源的UML图绘制工具，支持通过文本来生成图形，使用起来非常高效。可以支持时序图、类图、对象图、活动图、思维导图等图形的绘制。

下面使用PlantUML来绘制一张流程图，可以实时预览，速度也很快！

PlantUML还提供了VScode插件，可以直接安装使用，非常的方便。

structurizr

Structurizr 建立在“diagrams as code”的基础上，允许您使用各种渲染工具从单个模型创建多个软件架构图，它最主打的是C4模型的架构图。。可以导出PlantUML，C4-PlantUML，Mermaid，DOT，WebSequenceDiagrams，Ilograph格式。最适合想要将 C4 模型与 DSL 一起使用并将其签入源代码管理的技术人员。

Structurizr 工具有多个版本，涵盖不同的使用场景。

Structurizr 在开源上也是比较完善的一个，它的组下开源了相关的一系列工具，包括java的、CLI、lite版和例子等。

terrastruct-d2

terrastruct的d2是一种图表脚本语言，可将文本转换为图表。适合想要使用自动布局功能在代码中创建灵活图表的开发人员。

terrastruct提供了在线的playground，可以直接在线来编辑和生成图表。

当然terrastruct也提供了多种使用模式，包括了VScode、vim的插件，CLI工具，Obsidian插件等。下面是使用cli模式，来生成一个架构图的示例，可以看到随着代码的编写，会逐渐生成出 图表。

总结

当今大多数图表工具都是设计工具，而不是开发工具。他们为您提供空白画布和拖放工具栏，就像 Figma 或 Photoshop 上看到的那样，并将其预期的工作流程视为设计过程。工程师不是视觉设计师，缺乏可视化设计能力不应妨碍有价值文档的创建。并且设计和开发的割裂也会产生很多的过程摩擦。

Hashicorp 引入 Terraform 让工程师以代码形式编写基础设施的结构，也就是IAC。现在架构设计方面的DAC（diagrams as code）也正在展现出越来越多的优势。希望这些工具可以帮助到作为架构师的你，更好的、更高效的去带领团队完成工作。