在Markdown中使用Mermaid来绘制类图

1. 关于Mermaid的简介

Mermaid的使用可以让使用文本和代码创建图表和可视化效果。它是一种基于 Javascript 的图表和图表工具，可呈现受 Markdown 启发的文本定义以动态创建和修改图表。

2. 类图简介

是UML图中的一种，统一建模语言（UML）中的类图是一种静态结构图，它通过显示系统的类，其属性，操作（或方法）以及对象之间的关系来描述系统的结构。

顶部内容

顶部包含类的名称。粗体居中，且第一个字母大写

中间内容

中间的内容包含类的属性，左对齐且首字母是小写

底部内容

底部的内容包含类的方法，左对齐且首字母是小写

实例

演示代码：

    class BankAccount{
        String owner
        BigDecimal balance
        deposit(amount) bool
        withdrawl(amount) int
    }

演示效果：

classDiagram
    class BankAccount{
        +String owner
        +BigDecimal balance
        +deposit(amount) bool
        +withdrawl(amount) int
    }

3. 类与类之间的关系

类之间的8种关系

泛化（Inheritance）

• 这是一种继承关系，表示一般与特殊的关系，如：小狗是动物的一种
• 箭头指向:带三角箭头的实线，子类指向父类
• mermaid语法: A --|> B

演示代码：

    class Animal{
        我是父类
    }

    class Dog{
        我是子类
    }
    Animal <|-- Dog

演示效果：

Animal

我是父类

Dog

我是子类

实现（Realization）

• 一种类与接口的关系，表示类是接口所有特征和行为的实现.
• 箭头指向:带三角箭头的虚线，箭头指向接口
• mermaid语法:A ..|> B

演示代码：

    class UserDao{
        
    }

    class UserDaoImpl{
        
    }

    UserDao <|.. UserDaoImpl

演示效果：

UserDao

UserDaoImpl

关联（Association)

• 是一种拥有的关系，它使一个类知道另一个类的属性和方法；如：老师与学生，丈夫与妻子关联可以是双向的，也可以是单向的
• 双向的关联可以有两个箭头或者没有箭头，单向的关联有一个箭头
• 代码体现:成员变量
• 箭头指向:带普通箭头的实线，拥有者指向被拥有者
• mermaid语法: A "1" --> "n" B

演示代码：

    Student "n" <--> "n" Teacher

    Course "n"<--"1" Student

演示效果：

n

n

n

1

Student

Teacher

Course

聚合（Aggregation）

• 整体与部分的关系，且部分可以离开整体而单独存在,如车和轮胎是整体和部分的关系，轮胎离开车仍然可以存在
• 聚合关系是关联关系的一种，是强关联；关联和聚合在语法上无法区分，必须考察具体的逻辑关系
• 代码体现:成员变量
• 箭头指向:带空心菱形的实心线，菱形指向整体.
• mermaid语法:A o-- B

演示代码：

    Car "1"o-- "1" 引擎
    Car "1"o-- "4" 轮胎

演示效果：

1

1

1

4

Car

引擎

轮胎

组合(Composition)

• 是整体与部分的关系，但部分不能离开整体而单独存在.如公司和部门是整体和部分的关系，没有公司就不存在部门。
• 组合关系是关联关系的一种，是比聚合关系还要强的关系.最强的关联关系
• 要求普通的聚合关系中代表整体的对象负责代表部分的对象的生命周期
• 代码体现:成员变量
• 箭头指向:带实心菱形的实线，菱形指向整体
• mermaid语法:A "1" *-- "n" B

演示代码：

    部门 "n" <--* "1" 公司

演示效果：

n

1

部门

公司

注意：关联，聚合，组合不同类关系的区分

依赖(Dependency)

• 是一种使用的关系，即一个类的实现需要另一个类的协助
• 要尽量不使用双向的互相依赖
• 代码体现:局部变量、方法的参数或者对静态方法的调用
• 箭头指向:带箭头的虚线，指向被使用者
• mermaid语法:A ..> B

演示效果：

计算机

人类

这里注意和实现的区分，实现用的是完全的三角形箭头虚线，依赖用的是三角箭头虚线

4. 类与类之间各种关系的强弱

泛化（类与继承关系） = 实现（类与接口关系） >
组合（整体与部分的关系）> 聚合（整体与部分的关系） >
关联（拥有的关系） > 依赖（使用的关系）

5. Mermaid中使用注释

%%即可，不会被解析器解析

6. ENDING

文章部分内容来源于其他作者，由本人结合自己经验整改而成，尽可能的通俗易懂，如果侵犯了您的权益，请迅速联系我，我将立即删除。

2022年07月07日17:06:37