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

2024-02-06 00:20

本文主要是介绍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>>MALEFEMALE
}
«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

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

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

表示方式:

 classDiagramclassA --|> classB : InheritanceclassC --* classD : CompositionclassE --o classF : AggregationclassG --> classH : AssociationclassI -- classJ : Link(Solid)classK ..> classL : DependencyclassM ..|> classN : RealizationclassO .. 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…10或1个
1…*1个或多个
*多个
nn个(n>1)
0…n0个到n个(n>1)
1…n1个到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

这篇关于UML之在Markdown中使用Mermaid绘制类图的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/682628

相关文章

gitlab安装及邮箱配置和常用使用方式

《gitlab安装及邮箱配置和常用使用方式》:本文主要介绍gitlab安装及邮箱配置和常用使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1.安装GitLab2.配置GitLab邮件服务3.GitLab的账号注册邮箱验证及其分组4.gitlab分支和标签的

SpringBoot3应用中集成和使用Spring Retry的实践记录

《SpringBoot3应用中集成和使用SpringRetry的实践记录》SpringRetry为SpringBoot3提供重试机制,支持注解和编程式两种方式,可配置重试策略与监听器,适用于临时性故... 目录1. 简介2. 环境准备3. 使用方式3.1 注解方式 基础使用自定义重试策略失败恢复机制注意事项

nginx启动命令和默认配置文件的使用

《nginx启动命令和默认配置文件的使用》:本文主要介绍nginx启动命令和默认配置文件的使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录常见命令nginx.conf配置文件location匹配规则图片服务器总结常见命令# 默认配置文件启动./nginx

在Windows上使用qemu安装ubuntu24.04服务器的详细指南

《在Windows上使用qemu安装ubuntu24.04服务器的详细指南》本文介绍了在Windows上使用QEMU安装Ubuntu24.04的全流程:安装QEMU、准备ISO镜像、创建虚拟磁盘、配置... 目录1. 安装QEMU环境2. 准备Ubuntu 24.04镜像3. 启动QEMU安装Ubuntu4

使用Python和OpenCV库实现实时颜色识别系统

《使用Python和OpenCV库实现实时颜色识别系统》:本文主要介绍使用Python和OpenCV库实现的实时颜色识别系统,这个系统能够通过摄像头捕捉视频流,并在视频中指定区域内识别主要颜色(红... 目录一、引言二、系统概述三、代码解析1. 导入库2. 颜色识别函数3. 主程序循环四、HSV色彩空间详解

Windows下C++使用SQLitede的操作过程

《Windows下C++使用SQLitede的操作过程》本文介绍了Windows下C++使用SQLite的安装配置、CppSQLite库封装优势、核心功能(如数据库连接、事务管理)、跨平台支持及性能优... 目录Windows下C++使用SQLite1、安装2、代码示例CppSQLite:C++轻松操作SQ

Python常用命令提示符使用方法详解

《Python常用命令提示符使用方法详解》在学习python的过程中,我们需要用到命令提示符(CMD)进行环境的配置,:本文主要介绍Python常用命令提示符使用方法的相关资料,文中通过代码介绍的... 目录一、python环境基础命令【Windows】1、检查Python是否安装2、 查看Python的安

Python并行处理实战之如何使用ProcessPoolExecutor加速计算

《Python并行处理实战之如何使用ProcessPoolExecutor加速计算》Python提供了多种并行处理的方式,其中concurrent.futures模块的ProcessPoolExecu... 目录简介完整代码示例代码解释1. 导入必要的模块2. 定义处理函数3. 主函数4. 生成数字列表5.

Python中help()和dir()函数的使用

《Python中help()和dir()函数的使用》我们经常需要查看某个对象(如模块、类、函数等)的属性和方法,Python提供了两个内置函数help()和dir(),它们可以帮助我们快速了解代... 目录1. 引言2. help() 函数2.1 作用2.2 使用方法2.3 示例(1) 查看内置函数的帮助(

Linux脚本(shell)的使用方式

《Linux脚本(shell)的使用方式》:本文主要介绍Linux脚本(shell)的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录概述语法详解数学运算表达式Shell变量变量分类环境变量Shell内部变量自定义变量:定义、赋值自定义变量:引用、修改、删