PlantUML时序图:条件分支、循环与中断处理指南
PlantUML动态行为表达:条件分支、循环并行与中断处理
在系统设计过程中,准确表达动态行为是时序图的核心价值。本文将深入讲解PlantUML中条件分支、循环并行和中断处理三大关键行为表达方式,帮助您绘制更具表现力的时序图。
一、条件分支表达
1.1 基础条件块(alt/else)
alt
和else
关键字用于表示条件分支逻辑,类似于编程语言中的if-else结构:
@startuml
用户 -> 系统 : 提交订单
alt 库存充足
系统 -> 库存服务 : 扣减库存
系统 -> 支付网关 : 发起支付
else 库存不足
系统 -> 用户 : 显示缺货通知
end
@enduml
实践建议:
- 每个
alt
必须对应一个end
闭合 - 复杂条件建议用注释说明(
// 条件说明
) - 嵌套层级不宜超过3层,否则可考虑拆分场景
1.2 可选场景(opt)
opt
用于表示可能不执行的场景块:
@startuml
用户 -> 系统 : 登录请求
opt 记住登录状态
系统 -> Cookie : 写入令牌
end
系统 -> 用户 : 返回主页
@enduml
典型应用场景:
- 功能开关控制的分支
- 非核心业务流程
- 可选的校验步骤
二、循环与并行处理
2.1 循环结构(loop)
loop
块表示重复执行的操作:
@startuml
用户 -> API网关 : 批量查询请求
loop 遍历ID列表
API网关 -> 业务服务 : 单条查询
业务服务 -> 数据库 : 获取数据
end
API网关 -> 用户 : 返回聚合结果
@enduml
增强表达:
- 添加循环次数说明:
loop 3次重试
- 结合注释说明退出条件
2.2 并行处理(par/and)
par
块表示并行执行的流程:
@startuml
用户 -> 订单服务 : 创建订单
par
订单服务 -> 库存服务 : 预占库存
and
订单服务 -> 风控服务 : 风险校验
end
订单服务 -> 用户 : 创建结果
@enduml
注意事项:
- 并行块中消息顺序不代表实际执行顺序
- 建议用注释说明并行任务的关联性
- 复杂并行场景可考虑拆分为多个时序图
三、中断处理机制
3.1 异常中断(break)
break
用于表示异常中断流程:
@startuml
用户 -> 支付服务 : 发起支付
支付服务 -> 风控系统 : 交易验证
break 风控拒绝
支付服务 -> 用户 : 拒绝通知
end
支付服务 -> 银行通道 : 执行扣款
@enduml
最佳实践:
- 明确标注中断条件(如
break 超时重试失败
) - 中断块内应包含完整的异常处理流程
- 避免在中断块内进行复杂业务处理
四、综合应用示例
@startuml
客户 -> 电商系统 : 提交秒杀请求
alt 秒杀未开始
电商系统 -> 客户 : 返回倒计时
else 秒杀进行中
loop 3次重试
电商系统 -> 库存服务 : 扣减库存
break 库存不足
电商系统 -> 客户 : 秒杀失败通知
end
电商系统 -> 订单服务 : 创建订单
end
opt 开启消息通知
电商系统 -> 消息队列 : 发送成功通知
end
end
@enduml
五、设计建议
复杂度控制:
- 单个时序图不超过15个消息交互
- 嵌套层级控制在3层以内
- 复杂逻辑拆分为子流程引用
可读性优化:
- 使用颜色区分不同分支(
skinparam
) - 添加右侧注释说明业务规则
- 保持消息箭头的方向一致性
- 使用颜色区分不同分支(
工程化实践:
- 通过
!include
复用公共流程片段 - 使用变量定义条件表达式
- 版本控制中记录图表变更历史
- 通过
通过合理运用这些动态行为表达元素,可以使您的时序图更加精确地反映系统实际运行时的各种状态和分支情况,显著提升技术文档的沟通效率。
评论已关闭