架构图即代码：GitHub星标41.9k的Diagrams，用Python解放你的画图生产力

复制代码

Diagrams：用Python代码绘制专业系统架构图的开源神器

在程序员的世界里，系统架构图是沟通设计的通用语言，而用代码生成图表，正成为提升文档可维护性和团队协作效率的新范式。Diagrams项目正是这一理念的杰出实践。

作为程序员或系统架构师，你是否曾为绘制和更新复杂的系统架构图而感到头疼？传统的拖拽式绘图工具虽然直观，但难以进行版本控制、复用和自动化，一旦架构稍有变动，往往需要手动重调。来自韩国开发者Mingrammer的开源项目 Diagrams 完美地解决了这个痛点。它让你能够使用纯Python代码来定义和生成精美的云系统架构图 ，将图表纳入代码仓库统一管理。该项目在GitHub上已获得超过 41.8k 的星标，成为了"图表即代码"领域最受欢迎的工具之一。

项目简介："图表即代码"的优雅实践

Diagrams是一个Python库，它的核心目标是为开发者和架构师提供一种通过编程来绘制系统架构原型的现代方法。其设计哲学是：架构图应该像代码一样，易于编写、版本控制和迭代。

你无需打开任何图形界面软件，只需在Python脚本中导入相应的组件（如AWS EC2实例、GCP数据库、Kubernetes Pod等），用直观的操作符（>>, <<, -）定义它们之间的关系，然后运行脚本即可生成一张高质量的PNG或SVG图片。这种方法特别适合在敏捷开发中快速迭代架构设计，并确保文档与代码实现同步更新。

核心功能亮点

广泛的云服务与技术支持

Diagrams内置了丰富的图标库，涵盖了主流云服务商和技术栈，让你能够绘制几乎任何现代系统的架构：

公有云：全面支持AWS、Google Cloud Platform (GCP)、Microsoft Azure、阿里云（Alibaba Cloud）、Oracle Cloud等。
私有化与编排：支持Kubernetes、OpenStack、Elastic Stack等。
通用组件：提供了服务器、数据库、网络、安全等通用技术图标。这种广泛的支持使得Diagrams能够灵活地绘制跨多云或混合云的复杂架构。

简洁直观的编程模型

只需掌握三个核心概念，即可上手绘制：

Diagram ：代表整个图表，通过with Diagram(...)上下文管理器来创建。
Node：代表架构中的任何一个组件（如一台服务器、一个数据库）。
Cluster ：代表一个集群或分组，可以将多个节点组织在一起，直观地展示逻辑边界。节点之间的关系使用简洁的Python操作符定义，例如 组件A >> 组件B 表示数据流或依赖关系从A指向B。

自动化与集成友好

由于图表由代码生成，它可以轻松地集成到自动化流程中：

版本控制 ：.py文件可以直接用Git管理，架构的每次变更都有清晰的代码历史。
CI/CD集成：可以在持续集成/持续部署流程中自动生成或更新架构图，确保文档永不滞后。
批量生成：可以编写脚本，根据不同环境或配置快速生成一组架构图。

安装与快速上手

安装步骤

Diagrams依赖于Graphviz进行图形渲染，因此需要两步安装：

安装Graphviz：
- macOS ：brew install graphviz
- Ubuntu/Debian ：sudo apt install graphviz
- Windows：从Graphviz官网下载安装包并确保将bin目录添加到系统PATH。
安装Diagrams库：
复制代码
```
pip install diagrams
```

你的第一张架构图

以下是一个创建简单Web服务架构的示例，包含负载均衡器、Web服务器和数据库：

复制代码

from diagrams import Diagram
from diagrams.aws.compute import EC2
from diagrams.aws.database import RDS
from diagrams.aws.network import ELB

# 使用Diagram上下文，指定图表名称和输出设置
with Diagram("Simple Web Service", show=False, direction="LR"):
    # 定义节点
    lb = ELB("Load Balancer")
    web = EC2("Web Server")
    db = RDS("Database")

    # 使用 >> 操作符定义连接关系：负载均衡器指向Web服务器，再指向数据库
    lb >> web >> db

将上述代码保存为 web_service.py 并运行，即可在同目录下生成一张名为 simple_web_service.png 的架构图。

进阶示例：绘制微服务架构

Diagrams可以轻松描绘更复杂的结构，例如包含分组和多个服务的微服务架构：

复制代码

from diagrams import Diagram, Cluster
from diagrams.aws.compute import ECS
from diagrams.aws.database import RDS
from diagrams.aws.network import ELB

with Diagram("Microservices with DB Cluster", show=False):
    # 外部组件
    dns = ELB("Gateway")
    web = ECS("Frontend")

    # 使用Cluster定义一个名为"DB Cluster"的分组
    with Cluster("DB Cluster"):
        # 分组内的主从数据库结构
        db_master = RDS("Primary")
        db_slaves = [RDS("Replica1"), RDS("Replica2")]
        db_master - db_slaves  # 使用"-"表示无方向连接

    # 定义分组内外的连接关系
    dns >> web >> db_master

这段代码会生成一张逻辑层次分明的架构图，清晰地展示了服务分组和主从关系。

技术优势与生态对比

对比维度	Diagrams (图表即代码)	传统拖拽绘图工具 (如Visio, Draw.io)
版本控制	完美支持，图表以`.py`文件存储，可进行diff和merge	困难，二进制或XML文件难以追踪具体变更
可维护性	高，架构变更只需修改代码，复用性强	低，每次更新需手动调整，易出错
自动化能力	强，可集成到CI/CD、文档流水线	无，完全依赖手动操作
学习曲线	对程序员友好，需学习简单API	对非技术人员友好，但精细调整耗时
协作效率	基于代码评审，变更意图清晰	基于图片评审，易产生误解
适用场景	快速迭代的技术架构、需要与代码同步的文档	一次性汇报、非技术性草图、需要高度自由美工的图表

除了上述优势，Diagrams的社区生态也在不断壮大。例如，有开发者因其最初不支持阿里云图标而直接阅读源码，并向项目提交了完整的阿里云资源支持，这本身就是对项目优秀架构和开放性的最佳证明。

应用场景与最佳实践

典型应用场景

系统设计与评审：在技术方案设计阶段，快速绘制和分享架构原型。
项目文档：将生成架构图的脚本放入项目仓库，作为实时更新的活文档。
运维手册：为运维团队提供清晰、准确的基础设施拓扑图。
技术分享与汇报：生成高质量的插图，用于技术演讲或报告材料。

使用建议

从简单开始：先用几个核心组件绘制主干架构，再逐步细化。
善用Cluster：合理使用Cluster对组件进行分组，能使复杂架构图变得清晰易读。
保持代码简洁：将复杂的架构分解为多个子图或函数，提高代码可读性。
团队规范：在团队内统一图标风格（如统一使用AWS图标集）和绘图约定。

总结

Diagrams成功地将"图表即代码"的理念付诸实践，为技术团队提供了一种更高效、更工程化的架构图管理方式。它不仅仅是一个绘图工具，更是一种提升研发运维协同、保证文档时效性的优秀工作范式。

尽管它在绝对自由的图形设计上不如专业绘图软件灵活，但对于需要频繁更新、强调准确性和自动化的技术架构图而言，Diagrams无疑是当前最佳的选择之一。随着云原生和微服务的普及，这种用代码定义基础设施和架构的方式，正变得越来越重要。尝试将Diagrams引入你的下一个项目，体验用代码生成图形的独特魅力吧。

项目地址：https://github.com/mingrammer/diagrams