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

相关文章

如何为Yarn配置国内源的详细教程

《如何为Yarn配置国内源的详细教程》在使用Yarn进行项目开发时,由于网络原因,直接使用官方源可能会导致下载速度慢或连接失败,配置国内源可以显著提高包的下载速度和稳定性,本文将详细介绍如何为Yarn... 目录一、查询当前使用的镜像源二、设置国内源1. 设置为淘宝镜像源2. 设置为其他国内源三、还原为官方

Maven的使用和配置国内源的保姆级教程

《Maven的使用和配置国内源的保姆级教程》Maven是⼀个项目管理工具,基于POM(ProjectObjectModel,项目对象模型)的概念,Maven可以通过一小段描述信息来管理项目的构建,报告... 目录1. 什么是Maven?2.创建⼀个Maven项目3.Maven 核心功能4.使用Maven H

MySql match against工具详细用法

《MySqlmatchagainst工具详细用法》在MySQL中,MATCH……AGAINST是全文索引(Full-Textindex)的查询语法,它允许你对文本进行高效的全文搜素,支持自然语言搜... 目录一、全文索引的基本概念二、创建全文索引三、自然语言搜索四、布尔搜索五、相关性排序六、全文索引的限制七

基于Java实现回调监听工具类

《基于Java实现回调监听工具类》这篇文章主要为大家详细介绍了如何基于Java实现一个回调监听工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录监听接口类 Listenable实际用法打印结果首先,会用到 函数式接口 Consumer, 通过这个可以解耦回调方法,下面先写一个

IDEA自动生成注释模板的配置教程

《IDEA自动生成注释模板的配置教程》本文介绍了如何在IntelliJIDEA中配置类和方法的注释模板,包括自动生成项目名称、包名、日期和时间等内容,以及如何定制参数和返回值的注释格式,需要的朋友可以... 目录项目场景配置方法类注释模板定义类开头的注释步骤类注释效果方法注释模板定义方法开头的注释步骤方法注

使用Python构建一个Hexo博客发布工具

《使用Python构建一个Hexo博客发布工具》虽然Hexo的命令行工具非常强大,但对于日常的博客撰写和发布过程,我总觉得缺少一个直观的图形界面来简化操作,下面我们就来看看如何使用Python构建一个... 目录引言Hexo博客系统简介设计需求技术选择代码实现主框架界面设计核心功能实现1. 发布文章2. 加

JS+HTML实现在线图片水印添加工具

《JS+HTML实现在线图片水印添加工具》在社交媒体和内容创作日益频繁的今天,如何保护原创内容、展示品牌身份成了一个不得不面对的问题,本文将实现一个完全基于HTML+CSS构建的现代化图片水印在线工具... 目录概述功能亮点使用方法技术解析延伸思考运行效果项目源码下载总结概述在社交媒体和内容创作日益频繁的

基于Python打造一个全能文本处理工具

《基于Python打造一个全能文本处理工具》:本文主要介绍一个基于Python+Tkinter开发的全功能本地化文本处理工具,它不仅具备基础的格式转换功能,更集成了中文特色处理等实用功能,有需要的... 目录1. 概述:当文本处理遇上python图形界面2. 功能全景图:六大核心模块解析3.运行效果4. 相

springboot项目中常用的工具类和api详解

《springboot项目中常用的工具类和api详解》在SpringBoot项目中,开发者通常会依赖一些工具类和API来简化开发、提高效率,以下是一些常用的工具类及其典型应用场景,涵盖Spring原生... 目录1. Spring Framework 自带工具类(1) StringUtils(2) Coll

Python虚拟环境终极(含PyCharm的使用教程)

《Python虚拟环境终极(含PyCharm的使用教程)》:本文主要介绍Python虚拟环境终极(含PyCharm的使用教程),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录一、为什么需要虚拟环境?二、虚拟环境创建方式对比三、命令行创建虚拟环境(venv)3.1 基础命令3