
在现代云原生架构中,理解系统如何在物理或虚拟环境中运行至关重要。部署图(Deployment Diagram)是 UML 建模中用于展示软件组件在硬件节点上的物理分布、容器化环境以及它们之间通信路径的关键工具。借助 Visual Paradigm 的 VPasCode 工具,我们可以利用 PlantUML 语法,以“代码即图表”(Diagram-as-Code)的方式,高效地定义复杂的 Kubernetes 集群拓扑。
本文将深入解析如何编写代码来构建一个典型的“在线订单系统”的生产环境部署图。我们将通过代码示例,逐步拆解节点(Nodes)、容器(Containers)、外部依赖(Dependencies)以及通信协议(Protocols)的建模方法。
1. 部署图的核心概念与 VPasCode 语法
在 VPasCode 编辑器中,我们使用 PlantUML 的扩展语法来描述系统架构。与传统的拖拽式绘图不同,代码方式允许我们更精确地控制层级结构,特别是对于嵌套的 Kubernetes 命名空间(Namespace)和集群(Cluster)。
一个标准的部署图通常包含以下元素:
- 节点 (Node): 代表物理服务器、虚拟机或逻辑区域(如“Cloud Region”)。
- 容器/进程 (Container/Process): 代表运行在节点上的具体应用实例(如 Web 容器、API 容器)。
- 外部依赖 (External Dependencies): 代表数据库、消息队列或第三方云服务(如支付网关)。
- 通信路径 (Communication Path): 定义节点间的数据流向及使用的协议(如 HTTPS, TLS)。
2. 逐步构建:从代码到架构图
让我们通过左侧的代码编辑器,逐行解析如何构建右侧的可视化图表。我们将构建一个包含互联网入口、Kubernetes 集群、应用命名空间以及外部存储和支付服务的完整架构。
2.1 定义顶层环境与节点
首先,我们需要定义图表的标题,并声明最外层的物理或逻辑节点。在代码中,我们使用 node 关键字。
@startuml
title Online Order System - Production Deployment
' 定义最外层的物理节点
node "Internet" as Internet
' 定义云区域节点
node "Cloud Region" {
' 在云区域内定义 Kubernetes 集群节点
node "Kubernetes Cluster" {
' 在集群内定义应用命名空间
node "Application Namespace" {
' 在命名空间内定义具体的容器(Artifact)
artifact "Web Container" as Web
artifact "Order API Container" as Api
artifact "Worker Container" as Worker
}
}
}
@enduml
解析: 注意代码中的缩进结构。node "Cloud Region" 内部包含了 Kubernetes Cluster,而 Kubernetes Cluster 内部又包含了 Application Namespace。这种嵌套结构直接对应了右侧图表中层层递进的方框布局。
2.2 定义外部基础设施与数据组件
除了应用容器,生产环境通常还需要数据库、消息队列和密钥管理服务。VPasCode 提供了特定的关键字来区分这些组件的类型。
' 定义数据库
database "Managed Order DB" as Db
' 定义消息队列
queue "Managed Event Bus" as Bus
' 定义密钥管理节点
node "Secrets Manager" as Secrets
' 定义外部云服务商
cloud "Payment Provider" as Payment
cloud "Warehouse Network" as Warehouse
解析: database、queue 和 cloud 关键字会自动渲染出对应的图标。例如,cloud 关键字通常用于表示位于当前云环境之外的第三方服务(如 AWS 的支付服务或独立的仓库网络)。
2.3 定义通信路径与协议
最后一步是连接这些组件,并标注通信协议。这对于理解系统的安全性和数据流向至关重要。
' 定义连接关系
Internet --> Ingress : HTTPS
Ingress --> Web : HTTPS
Web --> Api : HTTPS
Api --> Db : TLS
Api --> Bus : TLS
Api --> Secrets : TLS
Api --> Warehouse : HTTPS/VPN
Api --> Payment : HTTPS
解析: 语法 Source --> Target : Protocol 是标准的 PlantUML 连接符。
- HTTPS: 用于 Web 流量和外部支付。
- TLS: 用于内部敏感数据通信(如 API 到数据库)。
- HTTPS/VPN: 表示通过加密隧道连接到仓库网络。
3. 关键建模技巧与最佳实践
在编写此类部署图时,有几个细节决定了图表的专业性和可读性。
- 语义化命名: 不要只使用 “Node1” 或 “Container A”。使用 “Web Container” 或 “Managed Order DB” 这样的名称,能让读者一眼看懂组件的功能。
- 协议标注: 在云原生架构中,安全至关重要。务必在连接线上标注协议(如 TLS),这能体现系统对数据传输加密的重视。
- 层级管理: 利用大括号
{ ... }清晰地划分物理边界(Region)、逻辑边界(Cluster)和逻辑边界(Namespace)。这有助于区分基础设施层和应用层。
4. 总结
通过 VPasCode 工具,我们不仅生成了一张清晰的部署图,还建立了一套可版本控制、可复用的架构文档。这种“代码即图表”的方法,使得架构师能够专注于逻辑设计,而非繁琐的绘图操作。无论是为了内部沟通还是技术文档编写,掌握 PlantUML 语法都是现代技术人员的必备技能。
