plantUML使用指南之序列图

文章目录

  • 前言
  • 一、序列图
    • 1.1 语法规则
      • 1.1.1 参与者
      • 1.1.2 生命线
      • 1.1.3 消息
      • 1.1.4 自动编号
      • 1.1.5 注释
      • 1.1.6 其它
      • 1.1.7 例子
    • 1.2 如何画好
  • 参考

前言

在软件开发、系统设计和架构文档编写过程中，图形化建模工具扮演着重要的角色。而 PlantUML 作为一种强大且简洁的开源工具，深受开发者和架构师们的喜爱。通过使用简单的文本语法，PlantUML 能够将复杂的概念转化为直观而易于理解的图形表示，使得软件设计和沟通变得更加高效和便捷。

本文旨在介绍和探索 PlantUML 的应用领域、语法规则和关键功能。我们将研究 PlantUML 的序列图，并通过实际案例和应用场景来展示其实际价值。

  • github地址：https://github.com/plantuml/plantuml

  • 中文文档：https://plantuml.com/zh/

一、序列图

序列图(Sequence diagram)，也叫时序图、顺序图，是一种常用的UML图形建模工具 ，用于描述多个对象参与实现业务目标时，彼此之间按时间顺序进行交互的过程.

1.1 语法规则

1.1.1 参与者

  • participant（参与者）

  • actor（角色）

  • boundary（边界）

  • control（控制）

  • entity（实体）

  • database（数据库）

  • collections（集合）

  • queue（队列）

    @startuml
'https://plantuml.com/sequence-diagram

participant Participant as Foo
actor       Actor       as Foo1
boundary    Boundary    as Foo2
control     Control     as Foo3
entity      Entity      as Foo4
database    Database    as Foo5
collections Collections as Foo6
queue       Queue       as Foo7

@enduml

    actor.png

1.1.2 生命线

关键字activate和deactivate用来表示参与者的生命活动激活和退出,destroy表示一个参与者的生命线的终结

@startuml
participant User

User -> A: DoWork
activate A

A -> B: << createRequest >>
activate B

B -> C: DoWork
activate C
C --> B: WorkDone
destroy C

B --> A: RequestCreated
deactivate B

A -> User: Done
deactivate A

@enduml

lifeline.png

自动激活生命线，需要和 return 配合使用

@startuml
autoactivate on
alice -> bob : hello
bob -> bob : self call
bill -> bob #005500 : hello from thread 2
bob -> george ** : create
return done in thread 2
return rc
bob -> george !! : delete
return success

@enduml

autolifeline.png

1.1.3 消息

消息箭头

消息种类箭头
同步消息->
异步消息->>
返回消息–>

  • 并行 par

    par.png

    @startuml
participant ClassA as a
participant ClassB as b
par
    a -> b: 1:Message1
    activate b
    deactivate b
else

    a -> b:2:Message2
    activate b
    deactivate b
else
    a -> b:3:Message3
    activate b
    deactivate b
end
@enduml

  • 选择 alt/else

    alt.png

    @startuml
participant ClassA as a
participant ClassB as b
alt 成功
    a -> b: 1:Message1
    activate b
    deactivate b
else 失败
    a -> b:2:Message2
    activate b
    deactivate b
end
@enduml

  • 循环 loop

    loop.png

    @startuml
participant ClassA as a
participant ClassB as b
loop 1000次
    a -> b: 1:Message1
    activate b
    deactivate b
end
@enduml

  • 分组 group

    group.png

    @startuml
participant ClassA as a
participant ClassB as b
group 自定义标签 [自定义]
    a -> b: 1:Message1
    activate b
    deactivate b
end
@enduml

1.1.4 自动编号

autonumber.png

@startuml
autonumber
participant ClassA as a
participant ClassB as b

a -> b: Message1
activate b
deactivate b

a -> b:Message2
activate b
deactivate b

a -> b:Message3
activate b
deactivate b

@enduml

1.1.5 注释

note.png

@startuml
autonumber
participant ClassA as a
participant ClassB as b

a -> b: Message1
note left: 左注释
activate b
deactivate b

a -> b:Message2
activate b
deactivate b
note right: 右注释

a -> b:Message3
note left
注释
多行
end note
activate b
deactivate b

@enduml

1.1.6 其它

  • 增加空间

  • 分割

  • 页面标题、页眉和页脚

    page.png

    @startuml
header Page Header
footer Page %page% of %lastpage%

title Example Title
autonumber
participant ClassA as a
participant ClassB as b

a -> b: Message1
activate b
deactivate b
' 增加空间
|||
a -> b:Message2
activate b
deactivate b
' 分割
== 分割 ==
a -> b:Message3
activate b
deactivate b
@enduml

1.1.7 例子

charge.png

@startuml
actor       用户 as user
participant 充值APP as APP
participant 管理后台 as admin
participant 手机运营商 as mobile

autonumber
user -> APP:输入手机号码
activate user
activate APP
activate admin
APP -> admin:校验通过，发送手机号码
admin -> admin:校验通过，判断归属地
admin --> APP:返回归属地、话费套餐信息
deactivate admin
APP -> APP:展示归属地话费套餐信息
deactivate  APP
user -> APP:选择话费套餐
activate APP
activate admin
APP -> admin:生成提交订单(订单号、手机号..)
admin -> admin: 校验订单信息，生成充值订单
admin --> APP: 返回订单创建成功
deactivate  admin
APP -> APP: 展示支付方式选项(支付宝、微信等)
deactivate  APP
user -> APP: 选择支付方式
activate APP
APP -> APP: 发送支付请求调起支付平台
user -> APP: 支付套餐费用
activate admin
APP -> admin: 查询支付结果
admin -> admin: 查询支付结果，更新订单信息
group 并行
    admin --> APP:返回支付结果
    APP -> APP: 展示支付结果，更新订单信息
    activate mobile
    admin -> mobile:发送充值请求
    mobile -> mobile: 接收订单，处理充值
    mobile -> admin: 通知充值结果
    deactivate mobile
end
admin -> admin: 接收充值结果，更新订单信息
admin --> APP: 返回充值结果
deactivate admin
APP -> APP: 更新订单信息
APP --> user: 展示充值结果
@enduml

1.2 如何画好

  1. 定义参与者和对象： 首先，确定在时序图中涉及的各个参与者和对象。参与者可以是系统组件、用户或其他实体，对象可以是消息发送者、接收者或系统部件。
    • participant关键字定义参与者，用于表示系统中的各个对象或角色，它们可以是实际的物理对象、软件组件或外部系统
    • actor关键字表示与系统进行交互的外部用户、角色或其他系统
    • boundary关键字用于表示系统与外部实体之间的边界，通常用来表示用户界面或系统与外界的交互接口。
    • control关键字用于表示系统中的控制器、逻辑组件或业务流程。
    • entity关键字用于表示系统中的数据实体或领域对象,通常用于表示数据存储、业务实体或数据库表等
    • database关键字用于表示数据库或持久化存储系统。
    • collections关键字用于表示集合、列表或数组等数据结构
    • queue关键字用于表示队列或消息传递机制
  2. 描述消息交互顺序： 确定消息传递的顺序和相关时间线。使用 PlantUML 中的箭头表示消息的发送和接收。同时，通过使用数字标记，表示消息的顺序和时间跨度。
  3. 细化交互细节： 如果需要详细描述消息的内容、参数或其他信息，可以在消息箭头上方添加文本标签，描述消息的具体内容。
  4. 绘制生命线和激活期： 在时序图中，生命线表示对象的存在期，激活期表示对象的活动时间段。您可以使用 PlantUML 中的生命线和激活期来清晰地展示对象的生存和活动状态。

参考

  1. 10年产品经理教你3步画好UML时序图，轻松掌握流程分析利器

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

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

相关文章

Kafka消费者重平衡

Kafka消费者重平衡

「&#xff08;重平衡&#xff09;Rebalance本质上是一种协议&#xff0c;规定了一个Consumer Group下的所有Consumer如何达成一致&#xff0c;来分配订阅Topic的每个分区」。 比如某个Group下有20个Consumer实例&#xff0c;它订阅了一个具有100个分区的Topic。 正常情况下&…
阅读更多...
Linux的MySQL安装与卸载

Linux的MySQL安装与卸载

安装与卸载 卸载安装配置yum源安装MySQL 声明一下本人用的Linux版本是CentOs7.9版本的。 卸载 如果我们用的云服务器&#xff0c;云服务器可能会自带MySQL或者mariadb&#xff08;其实就是MySQL的一个开源分支&#xff09;&#xff0c;如果我们不想用自带的&#xff0c;需要先…
阅读更多...
2023年全国职业院校技能大赛软件测试赛题第9套

2023年全国职业院校技能大赛软件测试赛题第9套

2023年全国职业院校技能大赛 软件测试赛题第9套 赛项名称： 软件测试 英文名称： Software Testing 赛项编号： GZ034 归属产业： 电子与信息大类 赛项组别： 高等职业教育 …
阅读更多...
“成像光谱遥感技术中的AI革命：ChatGPT应用指

“成像光谱遥感技术中的AI革命：ChatGPT应用指

遥感技术主要通过卫星和飞机从远处观察和测量我们的环境&#xff0c;是理解和监测地球物理、化学和生物系统的基石。ChatGPT是由OpenAI开发的最先进的语言模型&#xff0c;在理解和生成人类语言方面表现出了非凡的能力。本文重点介绍ChatGPT在遥感中的应用&#xff0c;人工智能…
阅读更多...
BUGKU-WEB ezbypass

BUGKU-WEB ezbypass

题目描述 题目截图如下&#xff1a; 进入场景看看&#xff1a; 解题思路 代码审计题目发现需要构造一个字符串&#xff0c;使得它不包含字母、数字、特殊字符的PHP代码片段&#xff0c;长度小于105&#xff0c;然后传递给$codepost提交参数&#xff0c;eval&#xff08;&…
阅读更多...
【JS】浅谈防抖与节流

【JS】浅谈防抖与节流

防抖与节流 前言一、防抖1.1是什么&#xff1f;1.2做什么&#xff1f;1.3应用场景&#xff1f;1.4实现原理&#xff1f; 二、节流是什么&#xff1f;2.1是什么&#xff1f;2.2做什么&#xff1f;2.3应用场景&#xff1f;2.4实现原理&#xff1f; 总结 前言 防抖与节流算是面试…
阅读更多...
一起玩儿3D打印机——01 3D打印机初探

一起玩儿3D打印机——01 3D打印机初探

摘要&#xff1a;本文介绍3D打印技术的基本知识以及3D打印机的结构分类和组成 3D打印技术这几年得到了快速的发展&#xff0c;在一些特定领域和特定行业逐渐被越来越多的人所接受并大量使用。与之相关的供应链和产业链也日益壮大&#xff0c;并形成了完善的体系。 这次之所以…
阅读更多...
虚拟化技术的介绍

虚拟化技术的介绍

查看是否支持虚拟化: Linux虚拟化平台安装 云服务类型: 华为云的介绍: 公有云配置 区域&#xff1a; 同一个区域中的云主机是可以互相连通的&#xff0c;不通区域云主机是不能使用内部网络互相通信的 选择离自己比较近的区域&#xff0c;可以减少网络延时卡顿 华为云yum仓库&…
阅读更多...
[C语言] 数据存储

[C语言] 数据存储

类型意义&#xff1a; 1.类型决定内存空间大小&#xff08;大小决定了使用范围&#xff09; 2.如何看待内存空间的视角 类型分类 整形 类型大小(字节)short2int4long4long8 浮点型 类型大小(字节)float4double8long double12 构造类型 数组结构性struct联合union枚举enum 指…
阅读更多...
windows下安装python3.8

windows下安装python3.8

一、从官网下载安装包 官网地址&#xff1a;https://www.python.org/downloads/ 华为云地址&#xff1a;https://mirrors.huaweicloud.com/python/ 第三方镜像&#xff1a;https://registry.npmmirror.com/binary.html?pathpython/ 注意&#xff1a;从python3.8.10版本开始…
阅读更多...
java八股文 笔记（持续更新中~）

java八股文 笔记（持续更新中~）

1 Redis 2Mysql 3JVM 4java基础底层 5 spring 6 微服务 7.......(持续更新) One:Redis篇 1.穿透 2&#xff1a;击穿 3&#xff1a;雪崩 3 33 4:双写一致 5.持久化
阅读更多...
Vue3全家桶 - Vue3 - 【8】模板引用【ref】（访问模板引用 + v-for中的模板引用 + 组件上的ref）

Vue3全家桶 - Vue3 - 【8】模板引用【ref】（访问模板引用 + v-for中的模板引用 + 组件上的ref）

模板引用【ref】 Vue3官网-模板引用&#xff1b;如果我们需要直接访问组件中的底层DOM元素&#xff0c;可使用vue提供特殊的ref属性来访问&#xff1b; 一、 访问模板引用 在视图元素上采用ref属性来设置需要访问的DOM元素&#xff1a; 该 ref 属性可采用 字符串 值的执行设…
阅读更多...
docker-compose Install ONLYOFFICE

docker-compose Install ONLYOFFICE

ONLYOFFICE 前言 ONLYOFFICE 是一款全面的协作办公软件套件，集成了文档处理、电子表格和演示文稿等功能，为团队提供了无缝协作的工作环境。其功能强大，操作简便，是各种规模和类型的团队的首选工具。 功能介绍 多人协作：ONLYOFFICE 提供实时协作功能，让团队成员可以同时…
阅读更多...
QGIS 开发之旅一《二次开发环境搭建》

QGIS 开发之旅一《二次开发环境搭建》

1、 安装QT 下载QT Index of /new_archive/qt 我选择的版本是 Qt5.14.2 2、安装VS2017 Downloads & Keys - Visual Studio Subscriptions。下载后选择windows通用平台开发和C 开发就可以了。 3、安装插件QT vs tools 搜索 qt vs tools&#xff0c;选择第一个安装 …
阅读更多...
【vivado】 clock wizard 时钟IP

【vivado】 clock wizard 时钟IP

一、前言 MMCM和PLL是在FPGA设计中不可避免需要使用到的时钟资源&#xff0c;对于其功能及使用方法的理解是正确进行FPGA设计的前提。 二、Xilinx 时钟 IP配置 vivado中使用时钟向导(Clocking Wizard)配置时钟IP核&#xff0c;其框图如下&#xff1a; clk_in 输入时钟&#…
阅读更多...
MachineSink - 优化阅读笔记

MachineSink - 优化阅读笔记

注&#xff1a;该优化与全局子表达式消除刚好是相反的过程&#xff0c;具体该不该做这个优化得看代价模型算出来的结果(有采样文件指导算得会更准确) 该优化过程将指令移动到后继基本块中&#xff0c;以便它们不会在不需要其结果的路径上执行。 该优化过程并非旨在替代或完全…
阅读更多...
按键+串口发送实验

按键+串口发送实验

摸鱼记录 Day_15 &#xff5e;(&#xffe3;▽&#xffe3;&#xff5e;)(&#xff5e;&#xffe3;▽&#xffe3;)&#xff5e; review 前边已经学习了&#xff1a; 串口发送Vivado 串口通信(UART)------串口发送-CSDN博客 按键基于状态机的按键消抖实现-CSDN博客 1. …
阅读更多...
CANopen转Profinet网关连接西门子PLC与变流器通讯

CANopen转Profinet网关连接西门子PLC与变流器通讯

CANopen转Profinet网关&#xff08;XD-COPNm20&#xff09;在智能领域&#xff0c;变流器的应用非常广泛&#xff0c;变流器一般会采用CANopen协议。现场采用台达的变流器&#xff08;支持CANopen协议&#xff09;作为CANopen从站&#xff0c;S7-1500系列PLC做主站&#xff0c;…
阅读更多...
ENVI 如何批量拆分多波段栅格

ENVI 如何批量拆分多波段栅格

在处理遥感图像时&#xff0c;需要将多波段栅格进行拆分是很常见的需求。下面介绍一种方法&#xff0c;可以实现图像批量拆分并重命名。 打开ENVI的App Store 搜索并下载应用 在ENVI的App Store中搜索"将多波段图像拆分成多个单波段文件"&#xff0c;并下载安装。 打…
阅读更多...
索引失效的介绍和避免方法

索引失效的介绍和避免方法

索引是什么 在关系数据库 中&#xff0c;索引是一种单独的、物理的对数据库表中一列或多列的值进行排序的一种 存储结构 &#xff0c;它是某个表中一列或若干列值的集合和相应的指向表中物理标识这些值的数据页的逻辑指针清单。 索引的作用相当于图书的目录&#xff0c;可以根据…
阅读更多...
最新文章

Copyright @ 2022~2023