Mermaid说明

最新推荐文章于 2025-10-15 10:59:32 发布

原创最新推荐文章于 2025-10-15 10:59:32 发布 · 9.2k 阅读

39 ·

CC 4.0 BY-SA版权

文章标签：

#系统架构

架构设计专栏收录该内容

54 篇文章

订阅专栏

Mermaid 是一个强大的图表工具，用简单的文本描述生成复杂的图表。为了让初学者更好地掌握 Mermaid 的使用，这里将详细介绍 Mermaid 的基本语法、高阶语法及使用技巧，并结合实际示例逐步讲解每一个符号和字母的意义。

一、Mermaid 基本语法详解

1. 流程图 (Flowchart)

流程图是 Mermaid 中最常用的图表类型之一，用于描述流程步骤及其关系。

详细解释：

graph TD：定义图表类型和方向。
- TD（Top Down）：表示图从上到下布局。
- LR（Left to Right）：从左到右。
- BT（Bottom to Top）：从下到上。
- RL（Right to Left）：从右到左。
A[开始]：定义一个普通矩形节点，ID 为 A，显示内容为“开始”。
- [内容]：表示这是一个矩形节点。
- A：节点的唯一标识符，可以是任何字母或名称。
B{是否继续?}：定义一个菱形判断节点，ID 为 B，用于条件分支。
- {内容}：表示这是一个判断节点，通常用于分支选择。
-->：表示节点之间的连线方向，连接两个节点。
|是|：连线标签，用于标注分支路径的条件。

2. 序列图 (Sequence Diagram)

序列图用来展示对象或角色之间的交互顺序。

详细解释：

sequenceDiagram：定义图表类型为序列图。
participant User as 用户：定义参与者 User，并将其显示为“用户”。
- participant：定义图表中的参与者（角色或对象）。
- User：参与者的 ID。
- as 用户：显示名称，便于阅读理解。
User->>System: 发送请求：表示 User 向 System 发送消息，使用 ->> 表示消息的传递方向。
System-->>User: 返回响应：表示 System 向 User 发送消息，-->> 表示消息传递的方向。

3. 类图 (Class Diagram)

类图用于表示类及其之间的关系，适合面向对象编程的设计。

详细解释：

classDiagram：定义图表类型为类图。
class Animal {...}：定义一个类 Animal，包含属性和方法。
- +String name：公有属性 name，类型为 String。
- +int age：公有属性 age，类型为 int。
- +makeSound()：公有方法 makeSound()。
Animal <|-- Dog：表示 Dog 类继承 Animal 类。
- <|--：箭头符号，表示继承关系。

Mermaid 类图关系中的 "1" 和 "*" 解释

"1"：表示“一对一”关系。
- 意思是：每个对象在关联的另一端只有一个实例。例如，Student "1" -- "1" ProgramEnrollment 表示一个学生只能有一个注册记录，而每个注册记录也只能对应一个学生。
"*"：表示“一对多”关系。
- 意思是：每个对象在关联的另一端可以有多个实例。例如，Department "1" -- "*" Program 表示一个部门可以有多个课程，但一个课程只能属于一个部门。
"0..1"：表示零个或一个的关系，即对象的另一端可以没有关联或只有一个关联。
"1..*"：表示至少一个到多个的关系，意思是对象的另一端必须至少有一个关联实例。

这些符号是为了方便阅读，明确表示对象之间的关联数量，并不是 Mermaid 的语法规则，而是从 UML 类图中的概念借鉴而来。

示例解释：Mermaid 类图中的 `"1"` 和 `"*"`

各个关系的详细含义：

Department "1" -- "*" Program：
- 含义：一个 Department（部门）可以有多个 Program（课程），但一个课程只能由一个部门管理。
Department "1" -- "*" Offer：
- 含义：一个 Department 可以提供多个 Offer（项目），但每个项目只能由一个部门提供。
Offer "1" -- "1" Program：
- 含义：每个 Offer 对应一个 Program，反过来，每个 Program 也只能有一个 Offer。
Program "1" -- "1" Curriculum：
- 含义：每个 Program（课程）都有一个 Curriculum（课程表），反之亦然。
Curriculum "1" -- "*" Course：
- 含义：一个 Curriculum 包含多个 Course（课程），但一个课程只能属于一个课程表。
Student "1" -- "1" ProgramEnrollment：
- 含义：每个 Student（学生）有一个 ProgramEnrollment（课程注册记录），而每个注册记录也只能有一个对应的学生。
ProgramEnrollment "1" -- "*" CourseEnrollment：
- 含义：一个 ProgramEnrollment 包含多个 CourseEnrollment（课程选课），但一个选课记录只能属于一个课程注册。
Student "1" -- "1" Offer：
- 含义：每个 Student 与一个 Offer 相关联，反之亦然。
ProgramEnrollment "1" -- "1" Program：
- 含义：每个 ProgramEnrollment 对应一个 Program，同样，一个 Program 只能有一个注册记录。
CourseEnrollment "1" -- "1" Course：
- 含义：每个 CourseEnrollment 对应一个具体的 Course（课程），反过来也是一样。