PlantUML

最新推荐文章于 2025-06-22 13:44:04 发布

xnuscd

最新推荐文章于 2025-06-22 13:44:04 发布

阅读量1.6k

点赞数 6

CC 4.0 BY-SA版权

文章标签：大数据

本文链接：https://blog.csdn.net/xnuscd/article/details/144225582

PlantUML 是一种简单的描述性语言，用于绘制各种 UML 图（如时序图、类图、活动图等）。它基于纯文本描述，生成图形化的 UML 图表。以下是 PlantUML 的基本语法简介，特别是时序图的语法。

基本语法规则

开始和结束：
- 每个 PlantUML 脚本以 @startuml 开始，以 @enduml 结束。
- 例如：
```
@startuml
// 图表内容
@enduml
```
注释：
- 单行注释：// 这是注释
- 多行注释：/* 注释内容 */
关键字不区分大小写：
- 例如 actor 和 ACTOR 是等价的。

时序图语法

1. 角色（Participants）

定义参与者（可以是用户、系统、服务等）：

actor User
participant "Web Interface" as Web
participant "/auto_build/initiate" as Initiate

常见的角色类型：
- actor：外部用户或系统。
- participant：系统内的组件或模块。
- boundary、control、entity 等：特定种类的参与者，通常用于类图。

2. 消息（Messages）

描述参与者之间的消息传递：

User -> Web: 用户操作
Web --> User: 返回数据
Web -> Initiate: 调用后端接口

消息类型：
- ->：普通消息。
- -->：异步消息。
- <-、<--：返回消息。

3. 激活和失活（Activation and Deactivation）

激活表示对象在某个时间段内正在处理任务，显示为生命线上的矩形。

Web -> Initiate: 调用接口
activate Initiate
Initiate --> Web: 返回结果
deactivate Initiate

4. 条件与分支（alt / opt / loop）

条件分支（alt）：

alt 条件A
    Web -> Initiate: 执行操作A
else 条件B
    Web -> Initiate: 执行操作B
end

可选逻辑（opt）：

opt 条件C
    Web -> Initiate: 执行操作C
end

循环（loop）：

loop 每次循环
    Web -> Initiate: 循环中的操作
end

5. 对象的创建和销毁

创建对象：
```
Web -> NewService: +创建新对象
```
销毁对象：
```
destroy NewService
```

6. 返回值

方法调用的返回值：

Web -> Initiate: 调用方法
Initiate --> Web: 返回结果

7. 注释

添加注释，用于说明某些步骤：

note right of Web: 这是接口调用的说明

完整示例：信息收集接口的时序图

以下是基于你的需求的完整 PlantUML 示例代码：

@startuml
actor User
participant Frontend
participant "/auto_build/initiate" as Initiate
participant "Configuration Checker" as ConfigChecker
participant "Information Collector" as InfoCollector

User -> Frontend: 执行构建操作
Frontend -> Initiate: 发送构建请求 (user_id, autobuild_id, user_input)
Initiate -> ConfigChecker: 执行前置配置检查
ConfigChecker --> Initiate: 检查结果

alt 配置检查失败
    Initiate -> Frontend: 返回错误信息 (missing_configurations, message)
else 配置检查通过
    Initiate -> InfoCollector: 调用信息收集模块 (user_input)
    InfoCollector --> Initiate: 收集信息 (application_name, application_function)
    Initiate -> Frontend: 返回收集信息 (collected_info, message)
end
@enduml