文章目录
- [UML 时序图(Sequence Diagram)详解:从基础概念到实际项目应用](#UML 时序图(Sequence Diagram)详解:从基础概念到实际项目应用)
-
- [一、什么是 UML 时序图?](#一、什么是 UML 时序图?)
- 二、时序图的基本组成元素
-
- [2.1 参与者(Actor)](#2.1 参与者(Actor))
- [2.2 对象与生命线(Lifeline)](#2.2 对象与生命线(Lifeline))
- [2.3 激活条(Activation)](#2.3 激活条(Activation))
- [2.4 消息(Message)](#2.4 消息(Message))
- [三、组合片段(Combined Fragment)](#三、组合片段(Combined Fragment))
-
- [3.1 opt ------ 可选执行(Optional)](#3.1 opt —— 可选执行(Optional))
- [3.2 alt ------ 条件分支(Alternative)](#3.2 alt —— 条件分支(Alternative))
- [3.3 par ------ 并行执行(Parallel)](#3.3 par —— 并行执行(Parallel))
- [3.4 loop ------ 循环执行(Loop)](#3.4 loop —— 循环执行(Loop))
- [3.5 break ------ 中断执行(Break)](#3.5 break —— 中断执行(Break))
- [3.6 critical ------ 临界区(Critical Region)](#3.6 critical —— 临界区(Critical Region))
- [3.7 ref ------ 引用其他交互(Interaction Use)](#3.7 ref —— 引用其他交互(Interaction Use))
- [3.8 assert ------ 断言(Assertion)](#3.8 assert —— 断言(Assertion))
- [3.9 neg ------ 无效交互(Negative)](#3.9 neg —— 无效交互(Negative))
- [3.10 strict ------ 严格顺序(Strict Sequencing)](#3.10 strict —— 严格顺序(Strict Sequencing))
- [3.11 seq ------ 弱顺序(Weak Sequencing)](#3.11 seq —— 弱顺序(Weak Sequencing))
- [3.12 ignore 和 consider](#3.12 ignore 和 consider)
- 四、常见组合片段对比
- 五、时序图中的其他重要知识
-
- [5.1 Guard(守卫条件)](#5.1 Guard(守卫条件))
- [5.2 消息的执行顺序](#5.2 消息的执行顺序)
- [5.3 消息的嵌套调用](#5.3 消息的嵌套调用)
- [5.4 创建与销毁对象](#5.4 创建与销毁对象)
- [六、实际项目案例:AVI 系统上传检测数据到 SeaweedFS](#六、实际项目案例:AVI 系统上传检测数据到 SeaweedFS)
-
- [6.1 正常上传流程](#6.1 正常上传流程)
- [6.2 加入 alt:上传成功与失败](#6.2 加入 alt:上传成功与失败)
- [6.3 加入 loop:失败重试](#6.3 加入 loop:失败重试)
- [6.4 加入 par:并行处理](#6.4 加入 par:并行处理)
- [6.5 加入 opt:可选备份](#6.5 加入 opt:可选备份)
- [6.6 完整 PlantUML 示例](#6.6 完整 PlantUML 示例)
- [七、如何绘制 UML 时序图?](#七、如何绘制 UML 时序图?)
-
- [7.1 PlantUML](#7.1 PlantUML)
- [7.2 Mermaid](#7.2 Mermaid)
- [7.3 Draw.io(diagrams.net)](#7.3 Draw.io(diagrams.net))
- [7.4 工具选择建议](#7.4 工具选择建议)
- 八、绘制时序图的常见误区
-
- [8.1 将时序图画成流程图](#8.1 将时序图画成流程图)
- [8.2 忽略返回消息](#8.2 忽略返回消息)
- [8.3 滥用 par](#8.3 滥用 par)
- [8.4 混淆 opt 和 alt](#8.4 混淆 opt 和 alt)
- [8.5 混淆同步和异步消息](#8.5 混淆同步和异步消息)
- [8.6 时序图过于复杂](#8.6 时序图过于复杂)
- [九、时序图与其他 UML 图的区别](#九、时序图与其他 UML 图的区别)
- 十、总结
UML 时序图(Sequence Diagram)详解:从基础概念到实际项目应用
一、什么是 UML 时序图?
UML(Unified Modeling Language,统一建模语言)是一种用于软件系统分析、设计和建模的标准化语言。
时序图(Sequence Diagram),也称为顺序图或序列图,是 UML 中非常重要的一种交互图,主要用于描述系统中多个对象之间的交互过程,以及这些交互按照时间顺序发生的情况。
简单来说:
时序图就是通过图形的方式,描述系统中谁调用谁、什么时候调用、传递什么数据,以及不同条件下系统如何执行。
例如,一个用户登录系统的过程:
- 用户向客户端输入账号和密码。
- 客户端向服务器发送登录请求。
- 服务器查询数据库。
- 数据库返回用户信息。
- 服务器验证账号和密码。
- 验证成功,返回登录成功;验证失败,返回错误信息。
如果使用普通文字描述,可能需要较长篇幅才能说清楚。如果使用时序图,就可以直观地展示整个调用过程。
二、时序图的基本组成元素
UML 时序图主要由以下几个元素组成:
- 参与者(Actor)
- 对象或生命线(Lifeline)
- 激活条(Activation)
- 消息(Message)
- 返回消息(Return Message)
- 组合片段(Combined Fragment)
2.1 参与者(Actor)
参与者表示与系统进行交互的外部角色。
通常使用小人图标表示。
例如:
- 用户
- 管理员
- 外部系统
- 第三方服务
参与者不一定是具体的人,也可以是系统外部的其他软件系统。
2.2 对象与生命线(Lifeline)
生命线表示参与交互的对象或系统组件。
通常使用矩形框表示对象名称,并从矩形框底部向下绘制一条虚线。
例如:
- Client:客户端
- Server:服务器
- Database:数据库
- SeaweedFS:文件存储服务
生命线表示对象在整个交互过程中的存在范围。
时序图中有一个非常重要的规则:
时间通常从上往下推进。
越靠上的消息表示越早发生,越靠下的消息表示越晚发生。
2.3 激活条(Activation)
激活条也叫执行规格(Execution Specification),通常表现为生命线上的一段细长矩形。
它表示对象正在执行某个操作或处理某个请求。
例如:
客户端向服务器发送请求后,服务器开始处理请求,此时服务器生命线上会出现激活条。
当处理完成后,激活条结束。
激活条可以帮助开发人员判断:
- 当前哪个对象正在执行任务。
- 方法调用持续的时间范围。
- 对象之间的调用关系。
- 嵌套调用的执行情况。
2.4 消息(Message)
消息是时序图中最核心的元素,用于描述对象之间的通信。
常见消息类型如下:
| 消息类型 | 含义 | 说明 |
|---|---|---|
| 同步消息 | Synchronous Message | 发送方等待接收方执行完成 |
| 异步消息 | Asynchronous Message | 发送方发送后不必等待处理完成 |
| 返回消息 | Return Message | 接收方返回执行结果 |
| 自关联消息 | Self Message | 对象调用自身的方法 |
| 创建消息 | Create Message | 创建一个新的对象 |
| 销毁消息 | Delete Message | 销毁一个对象 |
(1)同步消息
同步消息通常使用实线和实心箭头表示。
例如:
客户端调用服务器接口,等待服务器返回结果。
text
Client Server
| |
|--- request --->|
| |
|<--- response --|
| |
同步调用常见于普通函数调用、HTTP 请求等待响应等场景。
(2)异步消息
异步消息通常使用实线和开放箭头表示。
发送方发送消息后,可以继续执行自己的其他操作,不需要等待接收方处理完成。
例如:
客户端向消息队列发送任务,发送成功后继续处理其他业务。
text
Client MQ
| |
|--- publish ->|
| |
|--- other --->|
常见场景:
- 消息队列。
- 异步任务。
- 事件通知。
- 后台任务调度。
(3)返回消息
返回消息通常使用虚线和开放箭头表示。
表示被调用对象执行完成后,将结果返回给调用方。
例如:
text
Client Server
| |
|--- request --->|
| |
|<-- response ---|
返回消息可以携带返回值,也可以表示操作完成。
(4)自关联消息
自关联消息表示对象调用自身的方法。
例如:
服务器在处理请求时,调用自身的 validate() 方法进行参数验证。
text
Server
|
|--- validate()
|<-- result
|
这种方式适合展示对象内部的方法调用关系。
(5)创建与销毁消息
创建消息表示在交互过程中创建一个新对象。
销毁消息表示对象生命周期结束,通常使用带有 X 标记的生命线终点表示。
常见于对象生命周期、连接创建与释放等场景。
三、组合片段(Combined Fragment)
组合片段是 UML 时序图中非常重要的概念。
当系统中存在条件判断、循环、并行执行等复杂逻辑时,仅使用普通消息很难清楚地表达。
因此,UML 提供了组合片段,用于描述不同的控制逻辑。
组合片段通常由一个矩形框表示,左上角有一个操作符(Operator),例如:
- opt
- alt
- par
- loop
- break
- critical
- ref
- assert
- neg
- strict
- seq
- ignore
- consider
下面重点介绍实际开发中最常用的操作符。
3.1 opt ------ 可选执行(Optional)
含义:满足指定条件时执行,不满足条件时跳过。
opt 相当于编程语言中的单个 if 判断。
例如:用户登录时,如果勾选了记住密码,就保存登录状态。
text
用户 客户端
| |
|--- 登录 ---->|
| |
| opt |
| [记住密码] |
| |--- 保存登录状态
| |
对应伪代码:
csharp
if (rememberPassword)
{
SaveLoginState();
}
典型应用场景:
- 用户勾选记住密码。
- 上传完成后可选生成缩略图。
- 根据配置决定是否备份文件。
- 根据业务配置决定是否记录详细日志。
需要注意:
opt 只有一个可选分支,没有满足条件时的 else 分支。
3.2 alt ------ 条件分支(Alternative)
含义:根据不同条件,选择对应的分支执行。
alt 类似于编程语言中的 if / else if / else。
例如:用户登录时,根据账号密码验证结果返回不同信息。
text
用户 服务器
| |
|--- 登录 ---->|
| |
| alt |
| [验证成功] |
| |--- 返回登录成功
|--------------|
| [验证失败] |
| |--- 返回错误信息
对应伪代码:
csharp
if (loginSuccess)
{
ReturnSuccess();
}
else
{
ReturnError();
}
典型应用场景:
- 登录成功 / 登录失败。
- 文件存在 / 文件不存在。
- 数据校验通过 / 数据校验失败。
- 上传成功 / 上传失败。
- 数据库连接成功 / 数据库连接异常。
需要注意:
alt 中的每个分支都有一个条件(Guard),一般情况下选择符合条件的分支执行。
如果多个条件同时成立,应该在业务设计中明确优先级或保证条件互斥。
3.3 par ------ 并行执行(Parallel)
含义:多个交互分支可以并行执行。
par 表示不同分支之间没有严格的先后顺序,可以同时进行。
例如:系统上传检测数据后,需要同时执行数据库记录更新和日志记录。
text
客户端 服务器 数据库 日志服务
| | | |
|--- 上传数据 -->| | |
| | | |
| | par | |
| |--- 更新记录 ->| |
| |------------------------------>|
| | | |--- 写日志
| | | |
对应伪代码:
csharp
await Task.WhenAll(
UpdateDatabaseAsync(),
WriteLogAsync()
);
典型应用场景:
- 同时更新数据库和日志。
- 同时调用多个第三方接口。
- 并行查询多个数据源。
- 多个文件同时上传。
- 多个独立任务同时执行。
需要注意:
par 表示允许并行执行,并不意味着一定使用多线程。
另外,par 不代表所有分支必须同时开始、同时结束。各分支可以有不同的执行时间。
3.4 loop ------ 循环执行(Loop)
含义:满足循环条件时,重复执行某段交互过程。
loop 类似于编程语言中的 for、while。
例如:系统批量上传多个文件。
text
客户端 服务器
| |
| loop |
| [文件数量 > 0]|
|--- 上传文件 ->|
|<-- 上传结果 --|
| |
对应伪代码:
csharp
foreach (var file in files)
{
Upload(file);
}
典型应用场景:
- 批量上传文件。
- 循环读取数据库记录。
- 重试请求。
- 定时轮询。
- 批量处理检测数据。
loop 可以包含循环次数或循环条件,例如:
text
loop [i < 10]
loop [上传失败且重试次数 < 3]
3.5 break ------ 中断执行(Break)
含义:满足指定条件时,中断当前交互过程,并跳出所在的交互片段。
例如:文件上传过程中,如果发现文件格式错误,则立即终止后续处理。
text
客户端 服务器
| |
|--- 上传文件 ->|
| |
| break |
| [文件格式错误]|
|<-- 返回错误 --|
对应伪代码:
csharp
if (fileFormatInvalid)
{
return;
}
典型应用场景:
- 参数验证失败,终止后续操作。
- 权限不足,中断业务处理。
- 文件格式不正确,终止上传流程。
- 检测到严重异常,提前退出处理流程。
3.6 critical ------ 临界区(Critical Region)
含义:标识一段需要保证原子执行的交互过程,其他并行交互不能与其交错执行。
例如:多个线程同时修改同一个共享资源,需要保证修改操作不会相互干扰。
text
线程A 共享资源
| |
| critical |
|--- 读取数据 ->|
|--- 修改数据 ->|
|--- 写入数据 ->|
| |
典型应用场景:
- 共享数据修改。
- 库存扣减。
- 账户余额更新。
- 共享文件写入。
注意:critical 是交互模型中的临界区约束,不等同于具体编程语言中的 lock、mutex 或数据库事务。实际系统仍然需要使用相应的同步机制实现。
3.7 ref ------ 引用其他交互(Interaction Use)
含义:引用另一个已经定义好的时序图或交互过程。
当某个业务流程比较复杂,并且多个业务都会使用同一段交互逻辑时,可以通过 ref 引用其他时序图。
例如:
登录流程中引用统一身份认证流程。
text
用户 登录系统
| |
|--- 登录 ---->|
| |
| ref |
| 统一认证流程 |
| |
|<-- 登录结果 --|
典型应用场景:
- 统一身份认证。
- 公共权限验证。
- 通用文件上传。
- 统一异常处理。
- 复用公共业务流程。
3.8 assert ------ 断言(Assertion)
含义:表示交互必须严格符合指定的行为,否则属于无效交互。
例如:支付成功后,必须生成支付记录。
可以用来表达系统中必须满足的交互约束。
3.9 neg ------ 无效交互(Negative)
含义:描述不允许发生的交互行为。
例如:未通过权限验证的用户,不允许访问受保护的数据。
3.10 strict ------ 严格顺序(Strict Sequencing)
含义:要求不同操作片段严格按照规定顺序执行。
例如:
- 必须先完成身份验证。
- 身份验证成功后才能查询数据。
- 查询完成后才能返回结果。
3.11 seq ------ 弱顺序(Weak Sequencing)
含义:规定同一生命线上的事件顺序,但不同生命线之间允许存在一定的交错。
适用于需要描述局部先后关系、但不要求所有对象严格串行的交互过程。
3.12 ignore 和 consider
这两个操作符通常成对理解。
ignore:忽略指定类型的消息,不将其作为当前交互关注的内容。consider:只关注指定类型的消息,其他消息不作为当前交互分析的重点。
适用于复杂系统的交互分析和模型约束。
四、常见组合片段对比
| 操作符 | 中文含义 | 核心作用 | 类似编程逻辑 |
|---|---|---|---|
| opt | 可选执行 | 满足条件才执行 | if |
| alt | 条件分支 | 多个条件选择一个分支 | if / else |
| par | 并行执行 | 多个分支允许并行 | 并发任务 |
| loop | 循环执行 | 重复执行某段交互 | for / while |
| break | 中断执行 | 提前终止交互 | break / return |
| critical | 临界区 | 约束交互不能交错 | lock |
| ref | 引用交互 | 复用其他时序图 | 函数调用 |
| assert | 断言 | 指定必须成立的交互 | assert |
| neg | 无效交互 | 描述不允许的交互 | 非法操作 |
| strict | 严格顺序 | 严格约束执行顺序 | 串行执行 |
| seq | 弱顺序 | 约束局部事件顺序 | 部分有序 |
| ignore | 忽略消息 | 排除指定消息 | 过滤 |
| consider | 关注消息 | 只考虑指定消息 | 白名单 |
五、时序图中的其他重要知识
5.1 Guard(守卫条件)
Guard 是组合片段中用于控制分支是否执行的条件表达式。
通常使用方括号表示。
例如:
text
[登录成功]
[文件存在]
[重试次数 < 3]
[用户具有管理员权限]
Guard 是判断条件,不是实际执行的消息。
5.2 消息的执行顺序
时序图最重要的规则是:
时间从上向下推进,而不是从左向右推进。
横向表示不同参与者,纵向表示时间顺序。
例如:
text
用户 客户端 服务器 数据库
| | | |
|--- 登录 ---->| | |
| |--- 请求 ---->| |
| | |--- 查询 ---->|
| | |<-- 数据 -----|
| |<-- 结果 -----| |
|<-- 页面 -----| | |
这表示用户发起登录请求,客户端调用服务器,服务器查询数据库,最后将结果返回给用户。
5.3 消息的嵌套调用
在复杂业务中,一个对象可能调用另一个对象,而被调用对象又继续调用其他对象。
例如:
text
Client
|
|--- Login()
|
|--- Validate()
|
|--- QueryUser()
|
|--- GenerateToken()
|
|<-- LoginResult
通过激活条和消息嵌套,可以清楚展示调用关系。
5.4 创建与销毁对象
对象不一定在整个交互过程中一直存在。
例如:
- 创建数据库连接。
- 创建任务对象。
- 创建临时文件。
- 释放连接资源。
时序图可以通过创建消息和销毁消息描述对象的生命周期。
六、实际项目案例:AVI 系统上传检测数据到 SeaweedFS
下面结合实际软件项目,演示如何使用时序图描述完整业务流程。
假设 AVI 系统需要将检测数据上传到 SeaweedFS,同时更新数据库,并根据上传结果决定是否重试。
涉及以下参与者:
- AVI 客户端:负责检测数据处理。
- Proxy:负责 S3 请求代理。
- SeaweedFS:负责文件存储。
- Database:负责数据记录。
- Log Service:负责日志记录。
6.1 正常上传流程
业务流程:
- AVI 客户端完成检测。
- AVI 客户端向 Proxy 发送上传请求。
- Proxy 将请求转发给 SeaweedFS。
- SeaweedFS 保存文件。
- SeaweedFS 返回上传结果。
- Proxy 返回结果给 AVI 客户端。
- AVI 客户端更新数据库记录。
6.2 加入 alt:上传成功与失败
上传结果不同,需要执行不同逻辑:
- 上传成功:更新数据库状态。
- 上传失败:记录失败原因。
6.3 加入 loop:失败重试
当上传失败时,允许最多重试 3 次。
6.4 加入 par:并行处理
上传成功后,可以同时执行:
- 更新数据库。
- 写入操作日志。
6.5 加入 opt:可选备份
如果开启备份功能,则额外执行备份操作。
6.6 完整 PlantUML 示例
可以使用下面的 PlantUML 代码生成完整时序图:
plantuml
@startuml
title AVI检测数据上传SeaweedFS时序图
actor AVI客户端 as AVI
participant Proxy
participant SeaweedFS
database Database
participant LogService
AVI -> Proxy: 上传检测数据
loop 上传失败且重试次数 < 3
Proxy -> SeaweedFS: S3 PutObject
SeaweedFS --> Proxy: 返回上传结果
alt 上传成功
break 上传成功,退出重试循环
else 上传失败
Proxy --> AVI: 返回失败原因
end
end
alt 上传成功
par 更新数据库
AVI -> Database: 更新检测数据路径和状态
Database --> AVI: 更新完成
else 写入日志
AVI -> LogService: 记录上传成功日志
LogService --> AVI: 记录完成
end
opt 开启备份
AVI -> SeaweedFS: 备份检测数据
SeaweedFS --> AVI: 返回备份结果
end
AVI -> AVI: 标记任务完成
else 上传最终失败
AVI -> Database: 更新上传失败状态
Database --> AVI: 更新完成
AVI -> LogService: 记录上传失败日志
end
@enduml
说明:
loop:控制上传失败后的重试。alt:区分上传成功和失败。par:并行更新数据库和记录日志。opt:根据配置决定是否执行备份。break:上传成功后退出重试片段。
实际设计时,建议明确重试次数、异常处理、数据库更新失败后的补偿逻辑,以及文件上传成功但数据库更新失败时如何恢复。
七、如何绘制 UML 时序图?
常见的时序图绘制工具有以下几种。
7.1 PlantUML
PlantUML 是一种通过文本代码生成 UML 图的工具。
优点:
- 使用文本描述时序图。
- 支持 Git 版本管理。
- 方便修改和维护。
- 支持 opt、alt、par、loop 等组合片段。
- 可以集成到 Markdown 和技术文档中。
官网:
https://plantuml.com/zh/sequence-diagram
7.2 Mermaid
Mermaid 是一种支持 Markdown 的图表描述语言。
优点:
- 语法简单。
- 适合技术博客。
- GitHub、部分 Markdown 编辑器支持。
- 可以直接在代码中维护图表。
官网:
简单示例:
数据库 服务器 客户端 数据库 服务器 客户端 #mermaid-svg-0X8kOL83ZKzlP7vc{font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;fill:#333;}@keyframes edge-animation-frame{from{stroke-dashoffset:0;}}@keyframes dash{to{stroke-dashoffset:0;}}#mermaid-svg-0X8kOL83ZKzlP7vc .edge-animation-slow{stroke-dasharray:9,5!important;stroke-dashoffset:900;animation:dash 50s linear infinite;stroke-linecap:round;}#mermaid-svg-0X8kOL83ZKzlP7vc .edge-animation-fast{stroke-dasharray:9,5!important;stroke-dashoffset:900;animation:dash 20s linear infinite;stroke-linecap:round;}#mermaid-svg-0X8kOL83ZKzlP7vc .error-icon{fill:#552222;}#mermaid-svg-0X8kOL83ZKzlP7vc .error-text{fill:#552222;stroke:#552222;}#mermaid-svg-0X8kOL83ZKzlP7vc .edge-thickness-normal{stroke-width:1px;}#mermaid-svg-0X8kOL83ZKzlP7vc .edge-thickness-thick{stroke-width:3.5px;}#mermaid-svg-0X8kOL83ZKzlP7vc .edge-pattern-solid{stroke-dasharray:0;}#mermaid-svg-0X8kOL83ZKzlP7vc .edge-thickness-invisible{stroke-width:0;fill:none;}#mermaid-svg-0X8kOL83ZKzlP7vc .edge-pattern-dashed{stroke-dasharray:3;}#mermaid-svg-0X8kOL83ZKzlP7vc .edge-pattern-dotted{stroke-dasharray:2;}#mermaid-svg-0X8kOL83ZKzlP7vc .marker{fill:#333333;stroke:#333333;}#mermaid-svg-0X8kOL83ZKzlP7vc .marker.cross{stroke:#333333;}#mermaid-svg-0X8kOL83ZKzlP7vc svg{font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;}#mermaid-svg-0X8kOL83ZKzlP7vc p{margin:0;}#mermaid-svg-0X8kOL83ZKzlP7vc .actor{stroke:hsl(259.6261682243, 59.7765363128%, 87.9019607843%);fill:#ECECFF;}#mermaid-svg-0X8kOL83ZKzlP7vc text.actor>tspan{fill:black;stroke:none;}#mermaid-svg-0X8kOL83ZKzlP7vc .actor-line{stroke:hsl(259.6261682243, 59.7765363128%, 87.9019607843%);}#mermaid-svg-0X8kOL83ZKzlP7vc .innerArc{stroke-width:1.5;stroke-dasharray:none;}#mermaid-svg-0X8kOL83ZKzlP7vc .messageLine0{stroke-width:1.5;stroke-dasharray:none;stroke:#333;}#mermaid-svg-0X8kOL83ZKzlP7vc .messageLine1{stroke-width:1.5;stroke-dasharray:2,2;stroke:#333;}#mermaid-svg-0X8kOL83ZKzlP7vc #arrowhead path{fill:#333;stroke:#333;}#mermaid-svg-0X8kOL83ZKzlP7vc .sequenceNumber{fill:white;}#mermaid-svg-0X8kOL83ZKzlP7vc #sequencenumber{fill:#333;}#mermaid-svg-0X8kOL83ZKzlP7vc #crosshead path{fill:#333;stroke:#333;}#mermaid-svg-0X8kOL83ZKzlP7vc .messageText{fill:#333;stroke:none;}#mermaid-svg-0X8kOL83ZKzlP7vc .labelBox{stroke:hsl(259.6261682243, 59.7765363128%, 87.9019607843%);fill:#ECECFF;}#mermaid-svg-0X8kOL83ZKzlP7vc .labelText,#mermaid-svg-0X8kOL83ZKzlP7vc .labelText>tspan{fill:black;stroke:none;}#mermaid-svg-0X8kOL83ZKzlP7vc .loopText,#mermaid-svg-0X8kOL83ZKzlP7vc .loopText>tspan{fill:black;stroke:none;}#mermaid-svg-0X8kOL83ZKzlP7vc .loopLine{stroke-width:2px;stroke-dasharray:2,2;stroke:hsl(259.6261682243, 59.7765363128%, 87.9019607843%);fill:hsl(259.6261682243, 59.7765363128%, 87.9019607843%);}#mermaid-svg-0X8kOL83ZKzlP7vc .note{stroke:#aaaa33;fill:#fff5ad;}#mermaid-svg-0X8kOL83ZKzlP7vc .noteText,#mermaid-svg-0X8kOL83ZKzlP7vc .noteText>tspan{fill:black;stroke:none;}#mermaid-svg-0X8kOL83ZKzlP7vc .activation0{fill:#f4f4f4;stroke:#666;}#mermaid-svg-0X8kOL83ZKzlP7vc .activation1{fill:#f4f4f4;stroke:#666;}#mermaid-svg-0X8kOL83ZKzlP7vc .activation2{fill:#f4f4f4;stroke:#666;}#mermaid-svg-0X8kOL83ZKzlP7vc .actorPopupMenu{position:absolute;}#mermaid-svg-0X8kOL83ZKzlP7vc .actorPopupMenuPanel{position:absolute;fill:#ECECFF;box-shadow:0px 8px 16px 0px rgba(0,0,0,0.2);filter:drop-shadow(3px 5px 2px rgb(0 0 0 / 0.4));}#mermaid-svg-0X8kOL83ZKzlP7vc .actor-man line{stroke:hsl(259.6261682243, 59.7765363128%, 87.9019607843%);fill:#ECECFF;}#mermaid-svg-0X8kOL83ZKzlP7vc .actor-man circle,#mermaid-svg-0X8kOL83ZKzlP7vc line{stroke:hsl(259.6261682243, 59.7765363128%, 87.9019607843%);fill:#ECECFF;stroke-width:2px;}#mermaid-svg-0X8kOL83ZKzlP7vc :root{--mermaid-font-family:"trebuchet ms",verdana,arial,sans-serif;} alt 登录成功 登录失败 用户 登录 发送登录请求 查询用户信息 返回用户信息 登录成功 返回错误 展示结果 用户
7.3 Draw.io(diagrams.net)
Draw.io 是一款常用的在线流程图和架构图绘制工具。
优点:
- 支持拖拽绘制。
- 操作直观。
- 支持 UML 图形。
- 适合绘制复杂架构和交互图。
- 可以导出 PNG、SVG、PDF 等格式。
官网:
7.4 工具选择建议
| 工具 | 主要特点 | 适用场景 |
|---|---|---|
| PlantUML | 代码生成图形 | 软件设计文档、开发协作 |
| Mermaid | Markdown 原生集成 | 技术博客、README |
| Draw.io | 可视化拖拽 | 架构图、复杂交互设计 |
如果是软件开发人员,推荐优先学习 PlantUML 和 Mermaid。
八、绘制时序图的常见误区
8.1 将时序图画成流程图
流程图主要描述业务处理步骤,而时序图重点描述不同对象之间的消息交互。
两者的侧重点不同。
8.2 忽略返回消息
只画请求消息,不画返回消息,会导致调用关系不够完整。
尤其是接口调用、数据库查询、文件上传等业务,建议适当体现返回结果。
8.3 滥用 par
多个操作并不意味着一定可以并行。
如果后一个操作必须依赖前一个操作的结果,就不能简单地放入两个并行分支。
例如:
先上传文件,再将文件路径写入数据库,这两个操作存在依赖关系,不应该直接设计成并行执行。
8.4 混淆 opt 和 alt
两者的区别:
opt:只有一个可选分支,条件不满足就跳过。alt:有多个条件分支,根据条件选择对应分支。
8.5 混淆同步和异步消息
同步消息意味着调用方需要等待被调用方完成相应处理。
异步消息意味着调用方发送消息后可以继续执行,不必等待对方处理完成。
不要仅凭系统中是否使用了多线程来判断消息类型。
8.6 时序图过于复杂
如果一个时序图包含大量参与者、复杂分支和大量消息,阅读起来会比较困难。
建议:
- 按业务模块拆分时序图。
- 使用 ref 引用公共交互。
- 将异常流程和正常流程适当拆分。
- 只保留关键的调用和返回消息。
九、时序图与其他 UML 图的区别
UML 中有多种图形,每种图形关注的内容不同。
| 图形 | 英文 | 主要作用 |
|---|---|---|
| 用例图 | Use Case Diagram | 描述系统功能及参与者 |
| 类图 | Class Diagram | 描述类、属性、方法及关系 |
| 时序图 | Sequence Diagram | 描述对象之间的时间顺序和交互 |
| 活动图 | Activity Diagram | 描述业务流程和活动流转 |
| 状态图 | State Machine Diagram | 描述对象状态及状态转换 |
| 组件图 | Component Diagram | 描述系统组件及依赖关系 |
| 部署图 | Deployment Diagram | 描述软件运行环境及部署关系 |
例如:
- 用例图回答:系统有哪些功能?
- 类图回答:系统由哪些类组成?
- 时序图回答:这些对象之间如何交互?
- 活动图回答:业务流程如何流转?
- 状态图回答:对象有哪些状态,如何变化?
这些图可以结合使用,共同描述一个完整的软件系统。
十、总结
UML 时序图是软件需求分析、系统设计和开发协作中非常重要的工具。
通过时序图,可以清楚地展示:
- 系统中有哪些参与者和对象。
- 对象之间如何进行消息传递。
- 各个操作按照什么顺序执行。
- 哪些操作是同步的,哪些是异步的。
- 不同条件下系统会执行什么逻辑。
- 哪些任务可以并行执行。
- 循环、重试和异常情况下系统如何处理。
尤其需要掌握以下几个常用组合片段:
opt:可选执行。alt:条件分支。par:并行执行。loop:循环执行。break:中断执行。critical:临界区。ref:引用其他交互。
对于实际软件开发而言,时序图不仅仅是设计文档中的一张图,更是一种梳理系统调用关系、分析接口依赖、排查业务问题和明确开发职责的有效工具。
建议在开发复杂业务功能之前,先通过时序图梳理完整的调用链路,明确正常流程、异常流程、并发逻辑和数据流转关系,可以有效减少开发过程中的沟通成本和设计遗漏。