【Mermaid】从零开始:手把手教你用代码绘制专业流程图

只为媛动心

1. 为什么选择Mermaid画流程图?

第一次接触Mermaid是在写技术文档时,需要插入流程图但不想打开笨重的绘图软件。当时用Word画流程图,调整一个箭头位置就要重排整个版面,效率低到让人崩溃。直到发现用代码就能生成专业流程图的神器——Mermaid,我的工作效率直接翻倍。

Mermaid本质上是一种基于文本的图表生成工具,只需要编写简单的代码就能自动生成流程图、时序图、甘特图等。相比传统绘图方式有三大优势:

  • 版本控制友好:代码可以像普通文本一样用Git管理,再也不用担心"流程图_V3_最终版_final.docx"这种文件混乱
  • 修改成本极低:调整图形位置只需改几行代码,不用重新拖动几十个图形框
  • 跨平台兼容:任何支持Markdown的编辑器都能渲染,VS Code、Typora、GitHub等平台原生支持

我特别喜欢用它来画技术方案流程图,比如去年设计一个智能家居控制逻辑时,前后修改了20多个版本,全靠Mermaid的代码化特性才能高效迭代。下面这张是最终版的控制流程:

mermaid复制graph TD
    A[用户语音指令] --> B{指令类型?}
    B -->|灯光控制| C[调取房间灯光状态]
    B -->|电器控制| D[验证设备在线状态]
    C --> E[执行亮度调节]
    D --> F[发送红外控制信号]

2. 5分钟快速上手基础语法

刚开始学Mermaid时,我也被那些箭头符号搞晕过。其实核心语法就5个要素,记住就能画大多数流程图:

2.1 图形声明

流程图以graph关键字开头,方向标识符决定布局:

  • TD/TopDown:从上到下(最常用)
  • LR/LeftRight:从左到右
  • BT/BottomTop:从下到上
  • RL/RightLeft:从右到左
mermaid复制graph LR
    A[从左到右布局] --> B[节点B]

2.2 节点类型

  • 方形节点:[文本]
  • 圆角矩形:(文本)
  • 圆形:((文本))
  • 菱形:{文本}(用于判断分支)
mermaid复制graph TD
    A[方形] --> B(圆角)
    B --> C((圆形))
    C --> D{菱形?}

2.3 连接线样式

  • 实线箭头:-->
  • 虚线箭头:-.->
  • 无箭头线:---
  • 带文字箭头:-- 文字 -->
mermaid复制graph TD
    A -- 实线 --> B
    A -. 虚线 .-> C
    A -- 无箭头 --- D

2.4 分支与合并

用菱形节点配合条件箭头实现分支逻辑。这是我踩过坑的地方——箭头文本要写在竖线之间:

mermaid复制graph TD
    A{条件判断} -->|是| B[执行操作]
    A -->|否| C[其他操作]
    B --> D[结束]
    C --> D

2.5 子图(Subgraph)

subgraph包裹一组相关节点,特别适合处理复杂流程中的模块划分:

mermaid复制graph TD
    subgraph 初始化模块
        A[加载配置] --> B[建立连接]
    end
    subgraph 处理模块
        C[接收数据] --> D[解析内容]
    end
    B --> C

3. 实战:绘制一个完整项目流程图

去年给团队做技术培训时,我用Mermaid画过一个微服务调用流程图,现在把关键步骤拆解给你看:

3.1 定义整体结构

先确定流程方向和主要模块。建议先用注释规划框架:

mermaid复制graph TD
    %% 用户端流程
    %% 服务间调用
    %% 数据库操作

3.2 绘制用户登录流程

添加具体节点和连线,注意用不同形状区分操作类型:

mermaid复制graph TD
    A[用户打开APP] --> B{已登录?}
    B -->|否| C[显示登录界面]
    C --> D[输入账号密码]
    D --> E[调用Auth服务]
    E --> F{验证通过?}
    F -->|是| G[进入主页]
    F -->|否| H[提示错误信息]
    H --> C

3.3 添加服务间交互

用子图表示微服务,虚线箭头表示网络请求:

mermaid复制graph TD
    subgraph 客户端
        A[用户请求] --> B[API Gateway]
    end
    subgraph 微服务集群
        B -.-> C[Auth服务]
        B -.-> D[Order服务]
        C --> E[(用户数据库)]
    end

3.4 加入异常处理

完善的流程图应该包含错误路径,这是我经常忽略的部分:

mermaid复制graph TD
    A[发起支付] --> B[调用支付网关]
    B --> C{响应成功?}
    C -->|是| D[更新订单状态]
    C -->|否| E[记录失败日志]
    E --> F{重试次数<3?}
    F -->|是| B
    F -->|否| G[通知人工处理]

4. 高级技巧与避坑指南

用了两年Mermaid后,我整理出这些实用技巧能让你少走弯路:

4.1 样式自定义

通过CSS类名修改节点样式,先在style中定义类,再用class指定节点:

mermaid复制graph TD
    style A fill:#f9f,stroke:#333
    style B fill:#bbf,stroke:#f66
    A[重要节点] --> B[警告节点]
    class A importantNode
    class B warningNode

4.2 使用注释

%%添加注释,不会被渲染。复杂流程图一定要写注释,三个月后回头看会感谢自己:

mermaid复制graph LR
    %% 数据预处理流程
    A[原始数据] --> B[数据清洗]
    %% 特征工程部分
    B --> C[特征提取]

4.3 常见报错解决

  • 方向标识符错误:检查是否漏写TD/LR等方向声明
  • 节点格式不闭合:确保所有方括号/圆括号成对出现
  • 特殊字符转义:文本中含[]等符号时用双引号包裹"文本[带括号]"

4.4 效率工具推荐

  • VS Code插件:Mermaid Preview实时渲染
  • 在线编辑器:mermaid.live 快速验证语法
  • 导出工具:mermaid-cli 批量生成图片文件
bash复制# 用npm安装命令行工具
npm install -g @mermaid-js/mermaid-cli
# 将mmd文件转为png
mmdc -i input.mmd -o output.png

刚开始可能会觉得代码画图不如拖拽方便,但坚持用一周后,你会发现修改流程图就像改代码一样自然。最近我在设计一个新系统架构图,前后修改了15版,全靠Mermaid的代码化特性才能高效迭代。记住所有复杂流程图都是从graph TD这两个单词开始的,现在就去新建一个.md文件试试吧!

内容推荐

【USB协议解析】深入剖析Get Descriptor:从请求格式到描述符家族
本文深入解析USB协议中的Get Descriptor请求,从请求格式到描述符家族,详细介绍了设备描述符、配置描述符等关键数据结构及其在设备枚举中的作用。通过实际案例和调试技巧,帮助开发者理解描述符的重要性,提升USB设备兼容性和开发效率。
SAP ABAP 动态控制选择屏幕必输逻辑的实战技巧
本文深入探讨了SAP ABAP中动态控制选择屏幕必输逻辑的实战技巧,重点解析了screen-required属性的灵活应用与OBLIGATORY标记的局限性。通过实际案例展示了如何实现条件触发式校验和字段组联动控制,提升用户体验的同时确保数据完整性,并提供了企业级解决方案的设计思路与性能优化建议。
Win10+VS2019配置vcpkg:从安装到项目集成的完整指南
本文详细介绍了在Win10系统下使用VS2019配置vcpkg的完整流程,从基础安装到项目集成,涵盖环境准备、库管理、VS2019项目集成及高级技巧。vcpkg作为微软推出的C++包管理工具,能大幅简化第三方库的安装与配置,提升开发效率。
RobotStudio 自定义工具坐标系的构建与实战
本文详细介绍了在RobotStudio中构建自定义工具坐标系的完整流程与实战技巧。针对机器人编程中的工具坐标校准难题,提供从模型预处理、坐标系重建到精度验证的系统解决方案,特别适用于激光切割、焊接等工业场景,帮助工程师解决轨迹偏差等常见问题。
ADAS功能开发与测试工程师必看:CNCAP2021主动安全新规下的仿真与实车测试避坑指南
本文深入解析CNCAP2021主动安全新规对ADAS开发的影响,提供从仿真环境搭建到实车测试的实战指南。重点探讨AEB夜间测试、BSD横向距离控制等高难度场景的解决方案,分享传感器融合、光照模拟等关键技术,并介绍高效的开发验证闭环体系构建方法,助力工程师规避测试陷阱。
智能车竞赛卡丁快跑组:如何用英飞凌IM68A130A硅麦实现精准语音控制(附实战代码)
本文详细介绍了在智能车竞赛卡丁快跑组中,如何利用英飞凌IM68A130A硅麦克风实现精准语音控制的技术方案。从硬件架构设计、信号预处理到特征提取与命令识别,提供了完整的实战代码和调试技巧,帮助参赛团队快速掌握人车交互核心技术,提升比赛表现。
避坑指南:STM32编码器模式配置中,__HAL_TIM_GET_COUNTER返回值处理的3个常见错误
本文深入解析STM32编码器模式配置中`__HAL_TIM_GET_COUNTER`返回值处理的三大常见错误,包括CNT寄存器溢出、类型转换陷阱及四倍频模式下的精度问题。通过硬件原理分析和实战代码示例,帮助开发者避开定时器配置中的深坑,实现精准的编码器数据采集。
国密SM2证书实战:从OpenSSL生成到深度解析验证
本文详细介绍了国密SM2证书的生成与验证全流程,包括使用OpenSSL创建根证书、签发终端证书以及深度解析验证方法。通过实战案例和常见问题排查指南,帮助开发者掌握SM2证书的核心技术,提升安全性和运算效率,适用于金融、电商等高安全需求场景。
PCB设计进阶:AD规则设置实战指南——从电气间距、布线宽度到铺铜连接
本文详细解析了PCB设计中的AD规则设置实战技巧,涵盖电气间距、布线宽度和铺铜连接三大核心要素。通过具体案例和参数设置指南,帮助工程师规避常见设计陷阱,提升电路板可靠性和性能。特别针对多层板设计、大电流路径和敏感信号处理提供了专业解决方案,是PCB设计进阶的实用手册。
当STP遇到堆叠和M-LAG:现代数据中心网络中的生成树该怎么配?(以华为CE系列为例)
本文探讨了在现代数据中心网络中,传统生成树协议(STP)与堆叠(iStack)和跨设备链路聚合(M-LAG)技术的协同配置策略,特别以华为CE系列交换机为例。文章分析了STP在新架构中的角色转变,提供了堆叠和M-LAG环境下的STP配置要点,并介绍了多生成树(MSTP)的进阶实践,帮助网络工程师优化数据中心网络的高可用性和性能。
高德地图定位SDK报错getLocation:fail [geolocation:7]KEY错误的5种排查方法(附详细步骤)
本文详细解析高德地图定位SDK报错getLocation:fail [geolocation:7]KEY错误的5种排查方法,包括SHA1值匹配、包名一致性验证、API Key配置等关键步骤,帮助开发者快速解决定位功能失效问题。
无人机/机器人实战:基于VINS-Mono的VIO紧耦合方案部署与调参避坑指南
本文详细解析了基于VINS-Mono的VIO紧耦合方案在无人机与移动机器人中的实战部署与调参技巧。从硬件选型、传感器标定到系统优化,全面覆盖SLAM技术中的关键环节,特别针对IMU与视觉传感器的融合问题提供实用解决方案,帮助开发者规避常见陷阱,提升系统稳定性和定位精度。
Spring RestTemplate调用泛型接口,别再为Map<String, String>发愁了
本文详细解析了Spring RestTemplate调用泛型接口时遇到的Map<String, String>反序列化问题,并介绍了使用ParameterizedTypeReference的解决方案。通过实战示例和原理剖析,帮助开发者正确处理复杂泛型响应,提升微服务间通信的效率和安全性。
在Mac M1/M2上跑ARM虚拟机:用QEMU+libvirt搭建CentOS 8开发环境(保姆级避坑指南)
本文详细介绍了如何在Mac M1/M2上使用QEMU和libvirt搭建ARM架构的CentOS 8开发环境,涵盖从工具链配置、镜像获取到网络设置的全流程。针对ARM虚拟化的特殊需求,提供了保姆级避坑指南,帮助开发者高效构建稳定的开发环境。
Camunda条件事件避坑指南:从数据库表act_ru_event_subscr看事件订阅与触发机制
本文深入解析Camunda条件事件(Conditional Events)的订阅与触发机制,通过act_ru_event_subscr表追踪生产环境中的典型故障,包括流程版本升级、变量名大小写敏感、条件表达式性能等问题,并提供调试技巧与架构设计最佳实践,帮助开发者有效避坑。
从软件工程师视角:手把手调试TWS耳机ANC(附BES芯片实测避坑指南)
本文从软件工程师视角详细解析了TWS耳机ANC调试的全过程,包括声学参数理解、BES芯片实战调试及典型故障排查。通过实际案例和代码示例,帮助开发者快速掌握ANC调试技巧,提升TWS耳机的降噪性能。特别适合蓝牙耳机开发者和嵌入式工程师参考。
微信小程序头像临时路径转Base64持久化存储方案(Node.js后端实现)
本文详细介绍了微信小程序中头像临时路径转Base64持久化存储的完整解决方案,特别针对Node.js后端实现。通过分析临时路径的痛点,提供前端Base64转换与后端存储的最佳实践,包括MySQL和MongoDB两种数据库方案,并给出性能优化建议,帮助开发者有效解决微信小程序头像存储难题。
告别CAN总线!手把手教你用TSN Box和TSN Tools搭建车载以太网测试环境(附避坑指南)
本文详细介绍了如何从传统CAN总线迁移到TSN车载以太网的测试环境搭建全攻略,包括TSN Box的选型配置、软件栈部署、测试场景构建及性能优化。特别针对ADAS和无人驾驶系统的高带宽、低延迟需求,提供了实用的避坑指南和实战技巧,帮助工程师快速掌握TSN测试技术。
PCI Express物理层信号完整性探秘:从CEM规范到实战测试
本文深入探讨了PCI Express物理层信号完整性的核心挑战与解决方案,重点解析了CEM规范中的关键电气特性参数。通过实战案例和测试指南,详细介绍了插入损耗、回波损耗和串扰等关键指标的测量方法,并提供了高速信号完整性测试的进阶技巧,帮助工程师有效规避设计陷阱,提升PCIe系统的可靠性。
Android12指纹框架深度剖析(二):HAL层与TEE的交互机制
本文深入剖析Android12指纹框架中HAL层与TEE的交互机制,详细解析了从硬件指令翻译到安全通道建立的全流程。通过实测案例和日志分析,揭示了QSEECOM接口调用、安全数据通道建立及典型问题排查方法,为开发者优化指纹认证性能提供实用指导。
已经到底了哦
精选内容
热门内容
最新内容
INCA实验环境(EE)深度探索:如何像老手一样玩转示波器、记录器与数据导出
本文深入探讨了INCA实验环境(EE)的高级应用技巧,包括示波器的深度定制、实验数据的分层管理策略以及测量数据到Matlab的智能导出。通过实战案例和详细配置指南,帮助工程师提升在汽车电子控制单元(ECU)开发与标定中的工作效率,掌握INCA工具链的核心功能。
别再死记硬背公式了!用Unity/Three.js实战案例,5分钟搞懂向量点乘和叉乘
本文通过Unity和Three.js实战案例,深入浅出地讲解三维向量中点乘和叉乘的应用。从游戏AI的视野检测到3D图形中的法线计算,再到完整的交互系统构建,展示了这些数学工具如何解决实际问题。特别适合游戏开发者和Web 3D开发者快速掌握向量运算的核心应用场景。
PAT | 习题4-11 兔子繁衍问题:从斐波那契数列到算法优化实战
本文深入解析PAT习题4-11中的兔子繁衍问题,揭示其与斐波那契数列的数学关联。通过对比递归与迭代解法的性能差异,提供算法优化实战技巧,帮助读者掌握从基础实现到高效解决方案的进阶路径。特别针对算法竞赛场景,详细讲解如何通过内联计算等技巧提升性能。
为QGC开发铺路:在Jetson Orin Nano上部署Qt 5.15.3私有库的完整避坑指南
本文详细介绍了在Jetson Orin Nano上为QGC开发部署Qt 5.15.3私有库的完整流程,包括环境准备、源码编译、私有库配置及常见报错解决方案。通过本指南,开发者可以高效搭建稳定的Qt开发环境,解决QGC编译中的私有模块依赖问题,优化Jetson平台性能。
CocosCreator Layout组件深度玩法:从基础列表到复杂商城界面的网格布局实战
本文深入探讨了CocosCreator中Layout组件的高级应用,从基础列表到复杂商城界面的网格布局实战。通过详细的代码示例和布局参数设置,帮助开发者掌握混合布局的嵌套实现、动态内容管理以及与ScrollView的深度集成技巧,提升游戏UI开发效率。
Python实战:从Realsense D435深度相机中提取并解析内参矩阵
本文详细介绍了如何使用Python从Realsense D435深度相机中提取并解析内参矩阵,包括环境配置、相机连接、内参矩阵获取流程及其实际应用。通过实战代码示例,帮助开发者理解内参矩阵的核心参数及其在深度图转点云等计算机视觉任务中的关键作用,提升3D重建和深度感知应用的开发效率。
揭秘一拖二快充线:LDR6020 PD芯片如何实现双设备智能快充与数据传输
本文揭秘了基于LDR6020 PD芯片的一拖二快充线如何实现双设备智能快充与数据传输。通过动态功率分配算法和防冲突通信机制,该技术能智能识别设备并优化充电效率,同时支持边充边传数据。Type-C接口与PD协议的结合,使充电体验更加高效便捷,适合多设备用户。
告别手动复制粘贴:用TeXstudio+Endnote搞定LaTeX文献引用(保姆级避坑指南)
本文详细介绍了如何利用TeXstudio和Endnote实现LaTeX文献引用的全自动化工作流,从环境配置、Endnote到BibTeX的无损转换,到智能引用工作流的构建和常见问题诊断。通过这套方法,科研人员可以大幅提升写作效率,避免手动复制粘贴带来的错误和返工。
矩阵运算全解析:普通乘积、Hadamard积与Kronecker积的实战应用
本文全面解析矩阵运算中的普通乘积、Hadamard积与Kronecker积,通过实战案例展示它们在机器学习、图像处理和量子计算等领域的应用。详细介绍各种运算的性质、适用场景及性能优化技巧,帮助开发者高效解决实际问题。
主辅域控数据同步实战:从用户创建到组织架构管理的完整指南
本文详细介绍了主辅域控数据同步的实战操作,从用户创建到组织架构管理的完整流程。通过Active Directory(AD)域服务的多主机复制模型和USN机制,确保主域控制器(PDC)与辅助域控制器(BDC)之间的数据一致性。文章还提供了常见同步问题的排查方法和Repadmin工具的使用技巧,帮助企业实现高效的域控管理。