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

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

自动激活生命线，需要和 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

1.1.3 消息

消息箭头

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

并行 par

@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

@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

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

分组 group

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

@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 注释

@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 其它

增加空间

分割

页面标题、页眉和页脚

@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 例子

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