PlantUML 语法基础

在深入探讨 C4 模型或序列时间线等特定架构布局之前,理解控制系统的基础规则至关重要PlantUML 指南PlantUML 依赖于一种简洁且高度直观的文本标记系统。一旦你掌握了引擎如何打开文档、命名结构组件以及路由连接线,编写任何复杂系统布局都会变得完全自然。

本快速入门涵盖了适用于 VPasCode 工作区中几乎每种 PlantUML 图表类型的全局结构语法机制。

1. 必需的文档包装器

每一行 PlantUML 代码块都必须以明确的框架标签开始并结束。这些标签告诉 VPasCode 解析器在预览画布中启动正确的渲染引擎:

  • @startuml — 此行必须精确放置在脚本的最顶部,其前不能有任何其他内容。
  • @enduml — 此行必须精确放置在脚本的最底部,标志着你的图表数据块的结束。

任何位于这两个标记之外编写的代码将被编译器安全忽略,或者可能在工作区诊断面板中触发语法验证警告。

2. 声明元素:ID 与显示标签

在建模软件系统时,你将创建各种结构元素,如组件、数据库、参与者或微服务。在 PlantUML 中,你可以通过定义其类型、内部简写 ID 和用引号包裹的用户友好显示名称来显式声明一个元素:

component microservice_id as "支付处理 API"
database db_id as "用户事务 SQL"

为什么这是最佳实践: 使用简短、清晰的内部 ID(例如microservice_id)可以让你在后续绘制关系线时快得多。如果你需要将面向客户的标签从“支付处理 API”更改为“全球结账服务”,你只需修改代码中的一行,而不是在脚本中更新几十行。

3. 掌握关系箭头与方向路由

系统节点之间的连接使用连字符(-)和箭头括号(>)的组合来绘制。连字符的长度以及方向关键字的使用,让你能够隐式控制自动布局引擎如何缩放你的图表:

  • 基本连接: A --> B绘制一条从元素 A 直接指向元素 B 的标准有向箭头。
  • 虚线依赖线: 用句点替换连字符会生成虚线,这是业界标准,用于表示异步依赖关系或网络调用:A ..> B.
  • 强制布局方向: 虽然布局引擎会自动分配盒子间距,但您可以通过在箭头字符串中直接插入方向关键字来明确控制布局方向:
    • A -up-> B (强制B在A上方渲染)
    • A -down-> B (强制B在A下方渲染)
    • A -left-> B (强制B在A左侧渲染)
    • A -right-> B (强制B在A右侧渲染)

4. 内联添加上下文:标签和代码注释

清晰的文档很大程度上依赖于在您的视觉线条和文本脚本周围添加适当的上下文:

标记连接线

您可以通过在关系映射后附加冒号(”:)直接添加解释性文本到任何连接线:

client_id --> api_id : "HTTPS POST /v1/checkout"

编写代码注释

如果您希望在脚本文件中留下管理备注、设计署名或架构说明,而不在画布上渲染视觉框,请使用单引号字符(”')。这会告诉引擎完全跳过该行的解析:

' TODO: 我们需要在DevOps迁移完成后更新此边界框
[遗留单体] --> [新微服务]

现在您已经熟悉了PlantUML的全局语法包装、组件声明和方向箭头参数,您已完全具备开始构建高级系统形状的能力。请继续下一页,解锁我们的架构与高层设计图!

滚动至顶部