百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

架构师必备,5个用代码生成技术文档图表的开源工具

ccwgpt 2025-03-06 13:10 131 浏览 0 评论

作为开发人员,日常工作中难免会遇到一些需要画图的时候,特别是在写一些接口文档的时候,画一些流程图或者时序图是很重要的。但我们使用的大部分画图工具,都以独特的二进制文件存储,缺点不利于团队协作和分享,导致跟随代码的相关思维图不能更好地被管理,甚至无法与代码保持及时更新迭代,所以软件工程师们更希望通过像代码一样来管理图形化思维。目前越来越流行的一个概念是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)也正在展现出越来越多的优势。希望这些工具可以帮助到作为架构师的你,更好的、更高效的去带领团队完成工作。

相关推荐

ForkJoinPool的了解与使用(fork-join)

ForkJoinPool是一个强大的Java类,用于处理计算密集型任务。使用ForkJoinPool分解计算密集型任务并并行执行它们以获得更好的Java应用程序性能。它的工作原理是将任务分解为更小的子...

Netty 时间轮源码解析(时间轮java实现)

定时任务在中间件和业务系统中有很多应用,比如:注册中心中定期上报状态的心跳机制。RPC框架中定期扫描请求列表移除超时请求。延迟队列提交未来时间的任务。业务系统每日凌晨跑批处理或报表任务。Java原...

Autodesk基于Mesos的通用事件系统架构

【编者按】本文由AutodeskCloud软件架构师OlivierPaugam撰写,解释了如何集合Mesos、Kafka、RabbitMQ、Akka、Splunk、Librato、EC2等基础设施...

全局视角看技术-Java多线程演进史

作者:京东科技文涛全文较长共6468字,语言通俗易懂,是一篇具有大纲性质的关于多线程的梳理,作者从历史演进的角度讲了多线程相关知识体系,让你知其然知其所以然。前言2022年09月22日,JDK19发...

为什么应该使用Dapr来构建事件驱动的微服务?

微服务架构从本质上来说是分布式的。构建微服务总是会遇到极具挑战性的问题,比如说弹性服务调用、分布式事务处理、按需扩容以及严格一次(exactly-once)的消息处理。将微服务放在Kubernet...

WEB前端开发学习流程(web前端开发简明教程)

相对web后端开发来说,web前端开发对大部分初学编程者比较友好,而且入门门槛低,就业范围广。是大部分转行学IT的一个首选方向。web前端开发工程师,主要进行网站浏览器的开发、优化、布局的工作。在了解...

《s24z 编程指南》大纲(AI 提示词)

由于AIGC的迅速发展,本教程《s24z编程指南》,尝试用如下方法:准备《编程指南》的大纲,按章节划分,每小节由相关知识点和文字组成。每次将一小部分文本,以提示词的形式,送入Kimi或Ch...

有哪些常用的Python后端开发框架?

以下为你介绍一些常用的Python后端开发框架,包含各自的特点、适用场景与示例代码:Flask特点:轻量级、灵活,核心代码简洁,几乎不强制开发者使用特定的工具和库,开发者可按需添加扩展。适用场景...

数学分析的结构(数学分析的结构方法)

一、基础结构层实数系统与集合论数学分析的根基建立在实数连续之上,通过集合论(如公理化集合论)定义数学对象的抽象结构。例如,实数集的完备性公理是数学分析区别于其他数学分支的关键特征。此外,点集拓扑学(如...

新手在学习Web前端时需要学习的内容汇总

Web前端开发因为入行门槛低,是很多人转行IT开发行业的首选,但想要成为一名合格的Web前端开发工程师同样要具备过硬的专业技能,而且想要学成后高薪快速的就业,过硬的技术是基本条件。那么,新手小白学习W...

基于 Kotlin KMP 实现 HarmonyOS 与 Android 双平台 SDK 开发实践

背景随着鸿蒙平台的进一步发展,大家的态度也逐渐从观望转向实际投入,越来越多的公司开始考虑将自家应用迁移到鸿蒙平台。但是这一过程并非想象中的那么简单,尤其对于已经存在很多年的大型项目来说,直接投入大量人...

爱奇艺 App 中台技术实践(爱奇艺 app 中台技术实践在哪)

本文来自爱奇艺研究员在ArchSummit全球架构师峰会上的演讲整理,将为大家分享爱奇艺打造移动中台的过程。爱奇艺移动中台的建设过程可分为组件解耦、组件定制化和平台化,未来会利用平台发现、沉淀和复...

软件开发|同样的功能需求,为什么有的软件公司报价高?有的低?

最近有个朋友问我:同样的功能需求,为什么有的公司报价高?有的公司报价低?其实,有很多创业的朋友,在寻找技术开发公司的时候,经常会遇到这个困惑,一样的功能需求,不同的公司有不同的报价,有的差别还很大,那...

零基础要怎么学习Web前端?Web前端学习路径分享

Web前端因为薪资高、入行门槛低,成为很多人转行进入IT行业的首选。对于零基础的人来说,学习之前一定要想清楚为什么而学习Web前端,给自己一个清晰的定位,摆正心态。如果还不清楚学习路线,可以参考千锋武...

MICROCHIP/微芯 KSZ9031RNXIA 以太网芯片

特征o适用于IEEE802.3应用的单片10/100/1000Mbps以太网收发器oGMII/MII标准接口,3.3V/2.5V/1.8V容错I/Oo自动协商以自动选择最高链路连接速度(10/10...

取消回复欢迎 发表评论: