换个思路快速上手UML和plantUML——时序图

上一章我们介绍了类图,我们很清楚,类图是从更加宏观的角度去梳理系统结构的,从类图中我们可以获取到类与类之间:继承,实现等关系信息,是宏观逻辑。下面我们继续换一个思路:作为一名软件工程结构化图的设计者去设计另一种图,要求:

1)这种图要微观的体现调用关系

2)要线性的体现调用的时间关系

3)要能体现不同逻辑的不同结果

而这种图主要用于阅读源码,或者向别人介绍代码思路的等等相关的场景。

在这里插入图片描述

1.入手代码

对比设计类图,这个微观一点图显然要更加复杂,为了能成功把这种图设计出来,所以我们从实际的一段代码出发

package se;
/**
 * @author: Jeffrey
 * @date: 2024/01/29/11:06
 * @description:
 */
public class TimeSequenceUML {
    public static void main(String[] args) {
        Client client = new Client();
        client.work();
    }
}
class Device{
    public void write(String hello) {
    }
}
class Server{
    private Device device;

    public void close() {
    }

    public void open() {
    }

    public void print(String hello) {
        device.write(hello);
    }
}

class Client{
    private Server server;
    public void work(){
        server.open();
        server.print("hello");
        server.close();
    }
}

2.代码分析

2.1 图的元素

这段代码并不难理解,调用关系也并不复杂,如果直接去像我们平时阅读源码的思路一样去走方法,可以得到一个线性的调用思路,但是我们经常会遇到这么几个问题:

  1. 代码的核心对象是谁?
  2. 代码的调用者是谁?
  3. 都是对象,这些对象的之间各自承担的逻辑任务其实很容易搞混

说白了:为了设计好这个图,我们要完成的第一件事就是把这些代码的元素抽象出来,用一个图形表示就好了。于是优秀的我们思考了很多相关的对象完成以下的元素设计:

元素:含义:图像:plantUml:
角色一般是逻辑的开始交互者,可以是:人,机器,系统image-20240129115711016actor name
对象一般是逻辑的中间参与者,一般代表对象,又可以改变形状为以下具体的类型image-20240129115932546participant client
实体image-20240129120139844entity name
控制image-20240129120208121control name
数据库image-20240129120216366database name
集合image-20240129120222746collections name
队列image-20240129120228971queue name
边界image-20240129120235244boundary name

2.2 图的结构

将对象抽象出来后,下一步我们必须要考虑的就是如何将这些对象组织起来:

学习过线程进程,操作系统,计算机体系结构中任何一门课程的朋友们都知道:我们感觉计算机的某个操作是一瞬间的事情,其实它经历了很多个线性阶段,即使是多核多处理器的计算机,也是由一个个线性的阶段和并行的阶段链接而成,如何让我们简单明了的直接看图就能看懂程序?那么就要在图中体现程序的线性和并行关系

可是连接起来之后,不得不考虑的一个问题就是元素和元素要怎么摆放?如何才能同时体现一段时间内在调用时间上的线性特征一个瞬间时方法调用的顺序线性特征

聪明的我们明白,是时候定下一些规则来了!

  1. 关系越紧密,交互越密集的元素要尽可能的放到越近的地方
  2. 我们定义一个坐标轴,纵向代表时间顺序的线性关系
  3. 横向代表一瞬间方法调用的线性关系,或者说方法调用的层次关系

image-20240129160639721

2.3 消息和生命周期

看看我们现在有什么?有元素,有规则,下一步就是把调用顺序放进去了!记得黑盒模型吗?我们知道封装的思想有一部分就是为了隐藏方法的具体实现细节,我们现在主要关注的是方法的顺序,我们可以把每个调用过程当作是一个黑盒,只关注黑盒的输入输出信息。

我们用:

image-20240129161048506

实线实箭头来表示调用,用虚线实箭头来表示返回信息

在PlantUML中:
-> 实线
--> 虚线

image-20240129161720713

消息已经做好了,回到我们的需求,我们需要反应每个对象在什么阶段是激活的,在什么时候就跟这个对象没有什么关系了。

但是这里我们要注意一个区别,对于Java 来说,大家都知道基于JVM,对象的回收一般是不由我们来负责的【我们负责的主要是一些系统的接口或者说一些通道/流的开关】,而在UML中也类似,对象的激活状态代表的不是如IOC中对象一直的在内存中/在容器中,而是代表:在一个对象工作的同时,另一个对象是否在工作?如果在工作,表示为激活,反之为不活跃。

也就是说:我们要反映同一时刻对象的活跃状态

考虑到生命周期和时间是线性相关的,我们用在对象上的长矩形来体现生命周期的长短

image-20240129162448097

用横向上的矩形在同一水平来表示同时刻不同对象的活跃状态

image-20240129162726726

进一步的完善我们的图:

image-20240129162851557

2.4补充语法

至此我们已经能基本完成一个简单代码的线性过程,为了方便我们的绘图和绘制更加直观的图,我们补充一部分PlantUML的语法:

2.4.1 组合片段
ALT

抉择组合片段 ALT:说白了就是要在图中体现IF-ELSE 逻辑
比如这串代码:

package se;

/**
 * @author: Jeffrey
 * @date: 2024/01/23/21:55
 * @description:
 */
public class Test {

    public static void main(String[] args) {
        Student student = new Student();
        if (student.isGender()){
            Mapper mysql = new MySqlMapper();
            mysql.insert(student);
        }else {
            Mapper sqlServer =new SqlserverMapper();
            sqlServer.insert(student);
        }
    }
}
class Student{
    private boolean gender = true;

    public boolean isGender() {
        return gender;
    }
}
interface Mapper{
    public void insert(Student student);
}
class MySqlMapper implements Mapper{
    @Override
    public void insert(Student student) {
        //持久化到Mysql
    }
}
class SqlserverMapper implements Mapper{
    @Override
    public void insert(Student student) {
        //持久化到SqlServer
    }
}

可以绘制为:

image-20240129165049761

如果用plant UML 来表示:

@startuml
actor wo
Participant Test
Participant Student
Participant MySqlMapper
Participant SqlserverMapper

autonumber
wo -> Test : main()
Test -> Student: isGender()
activate Student
alt Gender == true
    Student -> MySqlMapper:insert()
    activate MySqlMapper
    MySqlMapper --> Student
    deactivate MySqlMapper
else
    Student -> SqlserverMapper:insert()
    activate SqlserverMapper
    SqlserverMapper --> Student
    deactivate SqlserverMapper
end
Student --> Test
deactivate Student
@enduml

补充:

  1. 在plantUML 中if-else 逻辑通过 alt /else 来表示,如果需要else if,只需要再添加一个else,同时这个组合片段必须用end 来结尾
  2. 一般当向一个对象发出消息时,这个对象被激活,进入生命周期,返回消息时被置为不活跃状态,所以我在发完消息后用activate name 来激活对象,在回复完消息后用 deactivate name
  3. autonumber 可以用于自动对消息进行编号
  4. 还可以在第一条消息发送前用autoactivate on 来自动填充activate,然后每次需要返回消息时用return 代替:

综上可优化为:

autonumber
autoactivate on
wo -> Test : main()
Test -> Student: isGender()
activate Student
alt Gender == true
    Student -> MySqlMapper:insert()
    return
else
    Student -> SqlserverMapper:insert()
    return
end
return
Loop

显然这可用于代表循环

loop 1000 times
    Student -> SqlserverMapper:insert()
    return
    end

image-20240129170046241

Group

可直接简单用于将一部分逻辑框起来,再添加对应的注释

    group SqlServer逻辑单元 [数据持久化]
    Student -> SqlserverMapper:insert()
    return
    end

image-20240129170412126

2.4.2 逻辑分割/分隔符

可以将一块代码分割成若干逻辑模块/或者代码分层:

wo -> Test : main()
Test -> Student: isGender()
==初始化==
alt Gender == true
    Student -> MySqlMapper:insert()
    return
else
    group SqlServer逻辑单元 [数据持久化]
    Student -> SqlserverMapper:insert()
    return
    end
end
==持久层==

image-20240129170653321

2.4.3 让响应信息显示在箭头下面

可以使用skinparam responseMessageBelowArrow true命令,让响应信息显示在箭头下面。

2.4.4 增加彼此空间

可以使用|||来增加空间。

@startuml
Alice -> Bob: message 1
Bob --> Alice: ok
|||
Alice -> Bob: message 2
Bob --> Alice: ok
||45||
Alice -> Bob: message 3
Bob --> Alice: ok
@enduml

image-20240129170856693

2.4.5 包裹参与者

可以使用boxend box画一个盒子将参与者包裹起来。

2.4.5 并行

可以使用parend par 来将同一时间段并行逻辑括起来

3.代码实战

我们用之前我写的一个简单Netty 实现的servlet 容器的代码来进行一次简单的项目实战,源码地址是:

Netty实现简易tomcat容器

大概整体项目并不规范的时序思路是这样的:

img

这个项目实现的基本功能就是根据自定义协议传入网页请求信息,实现对信息的解码,并包装成实现了HttpServlet 接口的容器。

而我们的目标就是用时序图来完成从HelloServlet收到一个登录请求的调用过程的绘图:

业务层

@startuml
autonumber
autoactivate on
Actor browser as br
Participant HelloServlet as hs
Participant HttpServletRequest as req
Participant UserService as us
br -> hs:dePost(req,rep)
hs->req:getParameter(username)
return String:username
hs->req:getParameter(password)
return String:password
hs->us:login(username,password)
return false
return response
@enduml

image-20240129222907980

本篇关键词:时间顺序,方法调用顺序,生命周期=激活状态

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

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

相关文章

【周赛】第382场周赛

🔥博客主页: A_SHOWY🎥系列专栏:力扣刷题总结录 数据结构 云计算 数字图像处理 力扣每日一题_ 从这一场(第382场周赛)周赛开始记录,目标是尽快达到准确快速AC前三道题,每场比赛…

贝莱德里程碑

作者:秦晋 见证奇迹的时刻。 1月27日,全球资产管理巨头贝莱德在美国证监会于1月10日审批通过比特币ETF的17天内,其比特币现货ETF资产管理规模已经突破20亿美元。持有比特币总数已达49952个。领跑其他9只比特币ETF机构参与者。不包括灰度GBTC&…

【JavaScript 漫游】专栏介绍

专栏介绍 本专栏旨在记录 JavaScript 核心语法,作为笔者日常学习和工作中的参考手册和代码示例仓库。 内容上力求覆盖 ES5、DOM、BOM 和 ES6 规范的所有内容。对于常用且重要的知识点,应该详细描述并附带有大量的代码示例。对于在工作场景中很少用到的…

数据结构——用Java实现二分搜索树

目录 一、树 二、二分搜索树 1.二叉树 2.二分搜索树 三、代码实现 1.树的构建 2.获取树中结点的个数 3.添加元素 4.查找元素 (1)查找元素是否存在 (2)查找最小元素 (3)查找最大元素 5.二分搜索…

算法39:统计全 1 子矩形(力扣1504)----单调栈

题目: 给你一个 m x n 的二进制矩阵 mat ,请你返回有多少个 子矩形 的元素全部都是 1 。 示例 1: 输入:mat [[1,0,1],[1,1,0],[1,1,0]] 输出:13 解释: 有 6 个 1x1 的矩形。 有 2 个 1x2 的矩形。 有 3 个 2x1 的矩…

(2024|ICLR,MAD,真实数据与合成数据,自吞噬循环)自消耗生成模型变得疯狂

Self-Consuming Generative Models Go MAD 公和众和号:EDPJ(进 Q 交流群:922230617 或加 VX:CV_EDPJ 进 V 交流群) 目录 0. 摘要 2. 自吞噬生成模型 2.1 自吞噬过程 2.2 自吞噬过程的变体 2.3 自吞噬循环中的偏…

Advanced EFS Data Recovery:恢复 Windows NTFS 中 EFS 加密文件

Advanced EFS Data Recovery 数据恢复软件可以破解 NTFS 加密,并解密受 Windows 加密文件系统 (EFS) 保护的文件。 Advanced EFS Data Recovery 功能列表 通过破解加密文件系统 (EFS) 来解除 NTFS 加密 解密转移到另…

Java面试题(11)

59.说一说springMVC的运行流程 1. 用户向服务器发送请求,请求被 Spring 前端控制 Servelt DispatcherServlet 捕获; 2. DispatcherServlet 对请求 URL 进行解析,得到请求资源标识符(URI)。然后根据该 URI,…

STM32 E18-D80NK红外避障传感器

E18-D80NK-N是一款红外光电传感器,它同时具备发射和接收功能。通过对发射光进行调制后发出,并通过接收头对反射光进行解调输出。 E18-D80NK-N采用了透镜来增强传感器的性能,使其能够检测更远的距离。根据红外光的特性,不同颜色的…

VitePress-04-文档中的表情符号的使用

说明 vitepress 的文档中是支持使用表情符号的,像 😂 等常用的表情都是支持的。 本文就来介绍它的使用方式。 使用语法 语法 : :表情名称: 例如 : :joy: 😂 使用案例代码 # 体会【表情】的基本使用 > hello world …

22.Lambda 表达式

Lambda 表达式 1. 概况2. 函数式接口3. 格式3.1 完整格式3.2 省略格式 4. 代码示例5. 输出结果6. 注意事项 学习Lambda表达式之前最好先学会 匿名内部类 具体信息请查看 API 帮助文档 1. 概况 Lambda 表达式是一种在编程中用来表示匿名函数的简洁语法。它是基于函数式编程风格…

2024.1.27每日一题

LeetCode 最大合金数 2861. 最大合金数 - 力扣(LeetCode) 题目描述 假设你是一家合金制造公司的老板,你的公司使用多种金属来制造合金。现在共有 n 种不同类型的金属可以使用,并且你可以使用 k 台机器来制造合金。每台机器都需…

SpringBoot之JWT登录

JWT JSON Web Token(JSON Web令牌) 是一个开放标准(rfc7519),它定义了一种紧凑的、自包含的方式,用于在各方之间以JSON对象安全地传输信息。此信息可以验证和信任,因为它是数字签名的。jwt可以使用秘密〈使用HNAC算法…

嵌入式学习第十三天

9.指针: (1)const指针 const 关键字 常量(只读) 1.const int *p; 2.int const *p; 1和2是等价的 const修饰 *p,指针变量p的值可以改变,但不能利用指针修改指向空间中的值 3.int *const p; const修饰 p,指针变量p的值不能改变…

【教程】极简Docker搭建“帕鲁幻兽PalWorld”服务器, 附资源

注意: 如果搭建在个人服务器或者内网中,需要做内网穿透,可以看这篇博客: 【教程】超详细安装和使用免费内网穿透软件Zerotier-One-CSDN博客文章浏览阅读523次,点赞8次,收藏8次。真的很详细https://blog.csd…

[设计模式Java实现附plantuml源码~结构型]树形结构的处理——组合模式

前言: 为什么之前写过Golang 版的设计模式,还在重新写Java 版? 答:因为对于我而言,当然也希望对正在学习的大伙有帮助。Java作为一门纯面向对象的语言,更适合用于学习设计模式。 为什么类图要附上uml 因为很…

Mysql查询数据

1 基本查询语句 MySQL从数据表中查询数据的基本语句为SELECT语句。SELECT语句的基本格式是: 2 单表查询 2.1 查询所有字段 SELECT * FROM 表名; 2.2 在SELECT语句中指定所有字段 SELECT f_id, s_id ,f_name, f_price FROM fruits; 2.3 查询单个字段 SELECT 列名FR…

Ajax入门与使用

目录 ◆ AJAX 概念和 axios 使用 什么是 AJAX? 怎么发送 AJAX 请求? 如何使用axios axios 函数的基本结构 axios 函数的使用场景 1 没有参数的情况 2 使用params参数传参的情况 3 使用data参数来处理请求体的数据 4 上传图片等二进制的情况…

C数据类型

目录 1. 数据类型分类 2. 整数类型 3. 浮点类型 4. void 类型 5. 类型转换 1. 数据类型分类 在 C 语言中,数据类型指的是用于声明不同类型的变量或函数的一个广泛的系统。变量的类型决定了变量存储占用的空间,以及如何解释存储的位模式。 C 中…

格外空间以设计带动凯迪仕品牌价值增长 | 揽获6项国际设计大奖

Kaadas凯迪仕专注于智能锁领域,作为一家集产品研发、制造、品牌、全球销售、安装、售后于一体的全产业链公司,致力于服务全球每一个家庭,以更优质的产品,为全球众多家庭带去高品质生活体验。基于新消费时代背景,传统空…