UML之在Markdown中使用Mermaid绘制类图

1.UML概述

UML(Unified modeling language UML)统一建模语言,是一种用于软件系统分析和设计的语言工具,它用于帮助软件开发人员进行思考和记录思路。

  • 类图是描述类与类之间的关系的,是UML图中最核心的。
  • 类图的是用于描述系统中类(对象)本身的组成和类(对象)之间的各种静态关系。
  • 类关系涉及 依赖、关联、聚合、组合、实现、泛化(继承) 这六种关系,耦合度依次递增。

2.Mermaid 类图

mermaid地址:Mermaid Github

mermaid是一种JavaScript库, 可以用于生成流程图、序列图、甘特图等各种图表。由于其简单易用、功能强大,越来越多的人开始使用它来创建图表。

本人大部分情况下是在Markdown文档中使用Mermaid,加上IDEA也可以直接导出Mermaid格式的类图,整理笔记比较方便。

因此本文档的软件环境为:IDEA为代码编辑器、Obsidian为Markdown编辑器。以此为参考。

本文主要演示Mermaid类图的画法。

一些关键字如下:

关键字 定义
classDiagram 定义类图
class{} 定义一个类,属性和方法写在{}内,如无内容,则不写{}
+ 权限:公共
- 权限:私有
# 权限:保护
~ 权限:包 / 内部
$ 静态

Markdown中格式如下:

3.类属性与方法

  • 类:格式:class 类名{} ,如果类内容为空,则省略{}。比如class Objectclass Person{}

  • 属性: 格式:权限 类型 属性名,比如- String name

  • 方法:格式:权限 方法名(参数类型) 返回值类型 ,比如+ goSchool(Bus) boolean

    classDiagram
    class Student{
    - String name
    + Integer age
    + goSchool(Bus) boolean
    - goHome() String
    # doHomework() Object[]
    ~ examine() List~string~
    }

Student - String name + Integer age +goSchool(Bus) -goHome() #doHomework() ~examine()

4.类注释

注释有两种:

  • 一种是表明类性质的标记型注释;

  • 一种是单纯的注释,写在%%后面,解析器会自动忽略该行内容,比如:

    classDiagram
    %% 这是一个注释,解析器自动忽略
    class Student

特殊标记包括:

  • <<interface>> 接口
  • <<abstract>> 抽象类
  • <<service>> 服务等级
  • <<enumeration>> 枚举

定义方式有以下两种:

  • 方式1:定义在类之后的单独一行

    classDiagram
    class ICourse{
    + String name
    + select() Boolean
    }
    <<interface>> ICourse

<<interface>> ICourse + String name +select()

  • 方式2:与类一起定义在嵌套结构中

    classDiagram
    class Gender{
    <<enumeration>>
    MALE
    FEMALE
    }

<<enumeration>> Gender MALE FEMALE

5.类关系(重要)

常用的类关系有以下几种,按照耦合度由低到高排序:

关系 图形 mermaid符号 说明
依赖 ..> 只要在类中引用了另一个类的类,那么它们之间就是依赖关系。 比如类A中有方法m,方法m的返回值类型为类B,此时,类A与类B依赖。
关联 --> 相较于依赖关系,关联关系的依赖性更高。 比如类A中有成员属性b,此时类A与类B关联。
聚合 --o 关联性是更强的关联关系。是整体和个体的关系。但二者可分割。 比如类A中有成员属性b,并且属性b通过setter赋值,此时二者就是聚合关系。
组合 *-- 关联性是更强的关联关系。是整体和部分的关系。二者不可分割。 比如类A中有成员属性b,并且属性b是在类A的构造方法中赋值,此时二者就是组合关系。
实现 ...|> 类A实现了类B(接口或抽象类)
泛化 (继承) --|> 类A继承了类B

还包括一些不常用的,比如:

  • -- 链接(实线)
  • .. 链接(虚线)

表示方式:

 classDiagram
 classA --|> classB : Inheritance
 classC --* classD : Composition
 classE --o classF : Aggregation
 classG --> classH : Association
 classI -- classJ : Link(Solid)
 classK ..> classL : Dependency
 classM ..|> classN : Realization
 classO .. classP : Link(Dashed)

Inheritance Composition Aggregation Association Link(Solid) Dependency Realization Link(Dashed) classA classB classC classD classE classF classG classH classI classJ classK classL classM classN classO classP

6.关系的基数 / 多重性

类图中的多重性或基数表示一个类的实例数,这些实例可以链接到另一个类的实例。

比如,学生与班级,一个学生对应一个班级,但一个班级对应多个学生。

选项有:

代码 说明
1 只有1个
0...1 0或1个
1...* 1个或多个
* 多个
n n个(n>1)
0...n 0个到n个(n>1)
1...n 1个到n个(n>1)

表示方式:

classDiagram
Customer "1" --> "*" Ticket
Student "1" --> "1..*" Course
Galaxy --> "many" Star : Contains

1 * 1 1..* Contains many Customer Ticket Student Course Galaxy Star

相关推荐
J老熊4 天前
Java设计模式之责任链模式详细讲解和案例示范
java·设计模式·面试·系统架构·责任链模式·uml
GuokLiu8 天前
240907-Gradio插入Mermaid流程图并自适应浏览器高度
流程图·gradio·mermaid
吕永强9 天前
面向对象需求分析
需求分析·uml·类图·用例图·顺序图·状态图·活动图
Tacy021311 天前
UML概述
uml
茜茜西西CeCe15 天前
软件工程知识点总结(2):需求分析(一)——用例建模
软件工程·需求分析·uml·用例图·活动图·用例建模·ooa
J老熊15 天前
Java设计模式之建造者模式详细讲解和案例示范
java·设计模式·面试·系统架构·建造者模式·uml
General_G16 天前
UML之时序图
uml
J老熊17 天前
Java设计模式之原型模式详细讲解和案例示范
java·设计模式·面试·系统架构·uml·原型模式
rolt19 天前
业务资源管理模式语言02
设计模式·uml·面向对象·分析模式