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…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

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/373499.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

【MATLAB】交叉验证求光滑因子的广义神经网络回归预测算法

有意向获取代码&#xff0c;请转文末观看代码获取方式~也可转原文链接获取~ 1 基本定义 交叉验证求光滑因子的广义神经网络回归预测算法是一种用于选择模型超参数并提高泛化性能的方法。下面将对该算法进行详细介绍&#xff1a; 广义神经网络回归模型&#xff1a; 广义神经网络…

地下停车场智慧监查系统:科技让停车更智能

随着城市化进程的加速&#xff0c;停车难成为了许多城市居民的痛点。而地下停车场作为解决停车难问题的重要手段&#xff0c;其安全性和便捷性也成为了人们关注的焦点。为了解决这一问题&#xff0c;山海鲸可视化搭建的地下停车场智慧监查系统应运而生&#xff0c;为车主们提供…

单向循环链表——插入、删除、实现约瑟夫环、排序

2024年2月3日 1.请编程实现单向循环链表的头插&#xff0c;头删、尾插、尾删 自定义头文件&#xff1a; #ifndef __head_h__ #define __head_h__ #include<stdio.h> #include<stdlib.h> #include<string.h> typedef int datatype; typedef struct Node {da…

React进阶 - 15(React 中 ref 的使用)

本章内容 目录 一、e.target 获取事件对应“元素”的DOM节点二、ref三、ref 和 setState 合用 上一节我们了解了 React中的”虚拟DOM“中的”Diff算法““ &#xff0c;本节我们来说一说 React中 ref的使用 一、e.target 获取事件对应“元素”的DOM节点 打开之前工程中的 To…

摘录笔记——2024年2月5日

美团三年&#xff0c;总结的10条血泪教训在美团的三年多时光&#xff0c;如同一部悠长的交响曲&#xff0c;高高低低&#xff0c;而今离开已有一段时间。闲暇之余&#xff0c;梳理了三年多的收获与感慨&#xff0c;既是对过去一段时光的的一个深情回眸&#xff0c;也是对未来之…

XAI:探索AI决策透明化的前沿与展望

文章目录 &#x1f4d1;前言一、XAI的重要性二、为什么需要可解释人工智能三、XAI的研究与应用四、XAI的挑战与展望 &#x1f4d1;前言 随着人工智能技术的快速发展&#xff0c;它已经深入到了我们生活的方方面面&#xff0c;从智能手机、自动驾驶汽车到医疗诊断和金融投资&…

网桥与网关

文章目录 概要网桥网关联系与区别参考文章 概要 网桥和网关的理解 网桥 几个名词的概念 网关 联系与区别 参考文章 如何通俗地解释什么是网桥&#xff1f; 网关到底是什么求通俗易懂讲解? 网桥&#xff1a;网桥也叫桥接器&#xff0c;是连接两个局域网的一种存储/转发…

探索设计模式的魅力:外观模式简化术-隐藏复杂性,提供简洁接口的设计秘密

设计模式专栏&#xff1a;http://t.csdnimg.cn/U54zu 目录 引言&#xff1a;探索简化之路 一、起源和演变 二、场景案例分析 2.1 不用模式实现&#xff1a;用一坨坨代码实现 2.2 问题 2.3 外观模式重构代码 定义 界面 接口 利用外观模式解决问题步骤 外观模式结构和说明 重构…

07、全文检索 -- Solr -- Solr 全文检索 之 为索引库添加中文分词器

目录 Solr 全文检索 之 为索引库添加中文分词器添加中文分词器1、添加中文分词器的 jar 包2、修改 managed-schema 配置文件什么是 fieldType 3、添加 停用词文档4、重启 solr5、添加【*_cn】动态字段&#xff0c;并为该字段设置中文分词器6、演示分词器的区别演示 text_cjk 这…

智能优化算法 | Matlab实现飞蛾扑火(MFO)(内含完整源码)

文章目录 效果一览文章概述源码设计参考资料效果一览 文章概述 智能优化算法 | Matlab实现飞蛾扑火(MFO)(内含完整源码) 源码设计 %%%% clear all clc SearchAgents_no=100; % Number of search ag

【技能树学习】Git入门——练习题解析

前言 本篇文章给出了Git入门技能树中部分的练习题解析&#xff0c;包括分支管理&#xff0c;Git标签&#xff0c;在Mac和Windows上使用GitVSCode的步骤。强调了git cherry-pick不直接支持从标签中选择提交&#xff0c;git tag -d只能删除本地标签&#xff0c;Mac系统的终端可以…

C/C++ 回调函数 callback 异步编程

一、C语言的回调函数 1.小试牛刀 #include <iostream> using namespace std; #include <memory> #include <stdlib.h>int add(int a, int b) {return a b; }void test01() {// 函数指针可以指向任何类型的函数&#xff0c;只要函数的参数列表和返回值类型…

单片机串口 奇偶校验 配置问题

一、问题描述 使用GD32单片机串口进行通信测试&#xff0c;单片机的串口配置的是偶校验(Even)、数据位为8、停止位为1、波特率为9600。串口测试软件用的格西烽火&#xff0c;软件的配置如下&#xff1a;   单片机通过串口和串口测试软件进行通信交互&#xff0c;软件收到的数…

绩效主义不可取,为什么还有那么多企业在使用KPI?KPI到底行不行!

“绩效主义毁了索尼” “企业差点被KPI害死” “绩效主义就是企业的脓包” 相信这些言论在过去的若干年里都听过&#xff0c;都是国内外知名企业的大佬说过的话&#xff0c;KPI绩效考核犹如过街老鼠&#xff0c;人人喊打。 虽然近几年&#xff0c;随着小米、知乎等互联网企业…

【HTML 基础】语义化标签

文章目录 1. <header>2. <nav>3. <article>4. <section>5. <footer>为什么使用语义化标签结语 在现代的 Web 开发中&#xff0c;语义化标签成为设计网页结构的重要组成部分。通过使用 <header>, <nav>, <article>, <sectio…

新型生成式 AI 助手 Amazon Q(预览版)上线

今天&#xff0c;我们宣布推出 Amazon Q&#xff0c;这是一种新型的生成式人工智能助手&#xff0c;专门用于满足办公场景需要&#xff0c;可以根据客户业务进行定制。客户可以使用 Amazon Q 进行对话、解决问题、生成内容、获取见解并采取行动&#xff0c;所有这些都基于客户自…

RibbonOpenFeign源码(待完善)

Ribbon流程图 OpenFeign流程图

亚马逊认证考试系列 - 知识点 - 安全组介绍

第一部分&#xff1a;AWS简介 Amazon Web Services&#xff08;AWS&#xff09;是全球领先的云计算服务提供商&#xff0c;为个人、企业和政府机构提供广泛的云服务解决方案。AWS的服务包括计算、存储、数据库、分析、机器学习、人工智能、物联网、安全和企业应用等领域。AW…

2寸证件照多大?怎么裁剪?分享3个工具!

在我们的日常生活中&#xff0c;证件照是必不可少的。不同的场合需要不同尺寸的证件照&#xff0c;其中2寸证件照是最为常见的一种。那么&#xff0c;2寸证件照是多大呢&#xff1f;又有哪些软件可以编辑证件照呢&#xff1f;本文将为你一一解答。 首先&#xff0c;让我们来了解…

大数据企业应用场景分析

目录 一、企业分析 1.1 企业领域维度分析 1.2 技术服务型维度分析 1.3 细分领域维度分析 二、大数据应用场景 2.1 数据分析 2.2 智能推荐 2.3 产品/流程优化 2.4 异常监测 2.5 智能管理 2.6 人工智能和机器学习 三、总结 前言&#xff1a;想讲清楚大数据应用对企业…