UML类图工具mermaid教程

2024-04-23 10:48
文章标签 工具 教程 uml mermaid 类图

本文主要是介绍UML类图工具mermaid教程,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

    • 写在开始
    • 定义类
    • 定义类成员
    • 定义类之间关系
      • 关系类型
        • Dependency依赖
        • Association关联
        • Aggregation聚合
        • Composition组合
        • Generalization泛化
          • Inheritance继承
          • Realization实现
    • 类描述
    • 注释

写在开始

mermaid可以用代码的形式来画UML类图,可在VsCode中安装插件直接使用.

UML类图可以清晰地表示类之间的关系,可以帮助程序员的开始敲代码之前进行系统架构,是必须掌握的一门技能.

本文将介绍如何使用开源工具mermaid以代码的形式来画类图.学习UML之间的关系以及mermaid的语法.

定义类

classDiagramclass AnimalVehicle <|-- Car

定义类成员

类成员包括类属性和类方法,mermaid使用()来区别元素是属性还是方法,只有方法后面才会携带括号.

  • 类属性相关修饰符的表示
`+`: Public`-`: Private`#`: Protected`~`: Package/Internal`*`: Abstract e.g.: someAbstractMethod()*`$`: Static e.g.: someStaticMethod()$
  • 使用类名带 :带成员名称来增加一个成员
classDiagramclass BankAccountBankAccount : +String ownerBankAccount : +BigDecimal balanceBankAccount : +deposit(amount) BooleanBankAccount : +withdrawal(amount)
BankAccount +String owner +BigDecimal balance +deposit(amount) : Boolean +withdrawal(amount)

或者使用 {} 来增加成员

classDiagramclass BankAccount{+String owner+BigDecimal balance+deposit(amount) Boolean+withdrawl(amount)}
BankAccount +String owner +BigDecimal balance +deposit(amount) : Boolean +withdrawl(amount)

定义类之间关系

[classA][Arrow][ClassB]:LabelText

关系类型

Dependency依赖

学生在学习生活中经常使用电脑,于是对电脑产生了依赖。依赖关系是五种关系中耦合最小的一种关系。类A要完成某个功能引用了类B,则类A依赖类B。依赖在代码中主要体现为类A的某个成员函数的返回值、形参、局部变量或静态方法的调用,则表示类A引用了类B

下图应该为虚线连接

classDiagram学生 ..> 电脑
学生 电脑
Association关联

关联关系使用实线加箭头表示,类之间的关系比依赖要强。学生与老师是关联的,学生可以不用电脑,但是学生不能没有老师。

classDiagram学生-->老师
学生 老师

单向关联

classDiagram学生-->老师  
学生 老师

双向关联

classDiagram学生--老师
学生 老师
Aggregation聚合

关联关系的一种,表示拥有has-a的关系.此时整体与部分之间是可分离的,它们可以具有各自的生命周期,部分可以属于多个整体的对象,也可以为多个整体对象共享,比如球员与球队、教练与球队的关系。此时球员和教练确实属于球队,但是并没有那么强的绑定关系,球员和教练都可以转会.

classDiagram球队A o-- 球员小贝球队A o-- 教练
球队A 球员小贝 教练
Composition组合

组合也是关联关系的一种特例,它体现的是一种contains-a的关系,这种关系比聚合更强,也称为强聚合
它同样体现整体与部分间的关系,但此时整体与部分是不可分的,整体的生命周期结束也就意味着部分的生命周期结束,比如小贝和他的头和心脏。

classDiagram球员小贝 *-- 头球员小贝 *-- 心脏
球员小贝 心脏
Generalization泛化

泛化是学术名称,通俗来讲,泛化指的是类与类之间的继承关系和类与接口之间的实现关系。

Inheritance继承

继承指的是一个类(称为子类、子接口)继承另外的一个类(称为父类、父接口)的功能.使用空心箭头加实线表示.

classDiagramPerson <|-- Student
Person Student
Realization实现

类实现接口,使用空心箭头加虚线表示

此处应该使用虚线

classDiagramclass IPayMode{<<interface>>+ pay()}class PasswordPayMode{+pay()}class FacePayMode{+pay()}class FingerprintPayMode{+pay()}IPayMode <|.. PasswordPayModeIPayMode <|.. FacePayModeIPayMode <|.. FingerprintPayMode
«interface» IPayMode +pay() PasswordPayMode +pay() FacePayMode +pay() FingerprintPayMode +pay()

类描述

<<Interface>> 表示接口类<<abstract>> 代表抽象类<<Service>> 代表服务等级<<enumeration>> 代表一个枚举

可以在定义类后使用

classDiagramclass Shape<<interface>> Shape
«interface» Shape

也可以在定义类中使用

classDiagramclass Shape{<<interface>>noOfVerticesdraw()}class Color{<<enumeration>>REDBLUEGREENWHITEBLACK}
«interface» Shape noOfVertices draw() «enumeration» Color RED BLUE GREEN WHITE BLACK

注释

注释必须自己一行, 并且必须以 %% (双百分号) 开头.

这篇关于UML类图工具mermaid教程的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J

Linux系统中卸载与安装JDK的详细教程

《Linux系统中卸载与安装JDK的详细教程》本文详细介绍了如何在Linux系统中通过Xshell和Xftp工具连接与传输文件,然后进行JDK的安装与卸载,安装步骤包括连接Linux、传输JDK安装包... 目录1、卸载1.1 linux删除自带的JDK1.2 Linux上卸载自己安装的JDK2、安装2.1

Python基于wxPython和FFmpeg开发一个视频标签工具

《Python基于wxPython和FFmpeg开发一个视频标签工具》在当今数字媒体时代,视频内容的管理和标记变得越来越重要,无论是研究人员需要对实验视频进行时间点标记,还是个人用户希望对家庭视频进行... 目录引言1. 应用概述2. 技术栈分析2.1 核心库和模块2.2 wxpython作为GUI选择的优

Linux卸载自带jdk并安装新jdk版本的图文教程

《Linux卸载自带jdk并安装新jdk版本的图文教程》在Linux系统中,有时需要卸载预装的OpenJDK并安装特定版本的JDK,例如JDK1.8,所以本文给大家详细介绍了Linux卸载自带jdk并... 目录Ⅰ、卸载自带jdkⅡ、安装新版jdkⅠ、卸载自带jdk1、输入命令查看旧jdkrpm -qa

Java使用Curator进行ZooKeeper操作的详细教程

《Java使用Curator进行ZooKeeper操作的详细教程》ApacheCurator是一个基于ZooKeeper的Java客户端库,它极大地简化了使用ZooKeeper的开发工作,在分布式系统... 目录1、简述2、核心功能2.1 CuratorFramework2.2 Recipes3、示例实践3

springboot简单集成Security配置的教程

《springboot简单集成Security配置的教程》:本文主要介绍springboot简单集成Security配置的教程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录集成Security安全框架引入依赖编写配置类WebSecurityConfig(自定义资源权限规则

MySQL Workbench 安装教程(保姆级)

《MySQLWorkbench安装教程(保姆级)》MySQLWorkbench是一款强大的数据库设计和管理工具,本文主要介绍了MySQLWorkbench安装教程,文中通过图文介绍的非常详细,对大... 目录前言:详细步骤:一、检查安装的数据库版本二、在官网下载对应的mysql Workbench版本,要是

使用Java实现通用树形结构构建工具类

《使用Java实现通用树形结构构建工具类》这篇文章主要为大家详细介绍了如何使用Java实现通用树形结构构建工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录完整代码一、设计思想与核心功能二、核心实现原理1. 数据结构准备阶段2. 循环依赖检测算法3. 树形结构构建4. 搜索子

利用Python开发Markdown表格结构转换为Excel工具

《利用Python开发Markdown表格结构转换为Excel工具》在数据管理和文档编写过程中,我们经常使用Markdown来记录表格数据,但它没有Excel使用方便,所以本文将使用Python编写一... 目录1.完整代码2. 项目概述3. 代码解析3.1 依赖库3.2 GUI 设计3.3 解析 Mark

通过Docker Compose部署MySQL的详细教程

《通过DockerCompose部署MySQL的详细教程》DockerCompose作为Docker官方的容器编排工具,为MySQL数据库部署带来了显著优势,下面小编就来为大家详细介绍一... 目录一、docker Compose 部署 mysql 的优势二、环境准备与基础配置2.1 项目目录结构2.2 基