
在现代软件工程中,清晰、分层地表达系统架构至关重要。C4 模型(Context, Container, Component, Code)正是为此而生。本文将深入探讨 C4 模型中的第二层——容器图(Container Diagram),并演示如何利用 Visual Paradigm 的 VPasCode 工具,通过代码驱动的方式快速构建专业的架构图。
什么是容器图?
容器图位于 C4 模型的层级结构中,介于“上下文图”和“组件图”之间。它的主要作用是展示系统的高层技术架构。与上下文图关注外部交互不同,容器图关注的是系统内部由哪些可独立部署的单元组成。
在 C4 术语中,“容器”并不一定指 Docker 容器。它指的是一个独立部署、具有特定技术栈的构建块。常见的容器类型包括:
- Web 应用程序:如基于 React 或 Angular 的前端应用。
- 移动应用程序:如 iOS 或 Android 原生应用。
- 微服务:如基于 Spring Boot 或 Node.js 的后端 API 服务。
- 数据库:如 PostgreSQL 或 MongoDB。
- 消息队列:如 Kafka 或 RabbitMQ。
解读 VPasCode 中的容器图示例
让我们通过 VPasCode 的界面来拆解一个典型的“订单处理平台(Order Processing Platform)”的容器图。左侧是代码编辑器,右侧是实时渲染的图表。
1. 引入标准库与布局
在 VPasCode 中编写 C4 图的第一步是引入 C4 的标准定义。这确保了你的图表遵循 C4 规范,并且样式统一。
@startuml C4_Container
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
LAYOUT_LEFT_RIGHT()
title Container Diagram - Order Processing Platform
代码中的 LAYOUTLEFTRIGHT() 指令告诉渲染引擎采用左右布局,通常用于将外部人员(Person)放在左侧,系统容器放在右侧。
2. 定义人员(Person)
容器图必须包含与系统交互的用户角色。在代码中,我们使用 Person 关键字来定义这些角色。
Person(customer, "Customer", "Places orders and tracks delivery status")
Person(admin, "Operations Administrator", "Manages products, orders, refunds, and reports")
这里定义了两个角色:
- Customer(客户):下单并追踪配送状态。
- Operations Administrator(运营管理员):管理产品、订单和退款。
3. 定义外部依赖(SystemExt)
系统往往不是孤立的,它需要与外部服务交互。这些外部服务被称为 SystemExt。
System_Ext(identity, "Identity Provider", "OAuth 2.0 / OIDC authentication")
System_Ext(payment, "Payment Gateway", "External payment authorization and capture")
System_Ext(email, "Email Service", "Transactional email delivery")
System_Ext(shipping, "Shipping Provider", "Shipment and tracking integration")
在这个示例中,系统依赖身份提供商(如 Auth0 或 Okta)进行认证,依赖支付网关处理资金,依赖邮件服务发送通知,并依赖物流提供商处理发货。
4. 定义系统边界与容器(Container)
这是容器图的核心部分。我们需要定义一个系统边界,并在其中放置具体的容器。
System_Boundary(orderBoundary, "Order Processing Platform") {
Container(webApp, "Web Application", "React", "Provides the customer and administrator user interfaces")
Container(orderApi, "Order API", "Java / Spring Boot", "Exposes APIs for products, checkout, orders, refunds, and tracking")
Container(worker, "Order Processing Worker", "Java / Spring Boot", "Processes order events and coordinates payment, inventory, and fulfillment")
ContainerDb(orderDb, "Order Database", "PostgreSQL", "Stores orders, products, inventory, and fulfillment data")
}
在这个边界内,我们定义了四个关键容器:
- Web Application (React):前端界面。
- Order API (Java/Spring Boot):主要的业务逻辑入口。
- Order Processing Worker (Java/Spring Boot):一个后台处理服务,负责异步处理订单事件。
- Order Database (PostgreSQL):持久化存储数据的数据库。
5. 建立连接关系
最后,我们需要用箭头连接这些元素,并标注通信协议。例如:
Person(customer) --(Uses [HTTPS])--> Container(webApp, "Web Application")
Container(webApp) --(Calls application APIs [JSON/HTTPS])--> Container(orderApi, "Order API")
Container(orderApi) --(Reads and writes orders [JDBC])--> ContainerDb(orderDb, "Order Database")
Container(orderApi) --(Publishes order commands and events [Kafka protocol])--> Container(eventBus, "Event Bus")
这些连接线清晰地展示了数据流向和技术栈(如 HTTPS, JDBC, Kafka)。
使用 VPasCode 的优势
相比于传统的拖拽式绘图工具,使用 VPasCode 编写 C4 图具有显著优势:
- 版本控制友好:架构代码是纯文本,可以像代码一样提交到 Git 仓库,轻松追踪架构变更历史。
- 快速迭代:修改一个容器的描述或添加一个新的依赖,只需修改几行代码即可,无需手动调整对齐。
- 自动化生成:结合 CI/CD 流程,可以自动从代码注释生成最新的架构图,确保文档与代码同步。
总结
容器图是连接业务需求与技术实现的桥梁。通过 VPasCode 和 C4 模型,您可以快速构建出既专业又易于维护的系统架构图。无论是为了设计新系统,还是为了向团队解释现有架构,掌握这一技能都将大大提升您的沟通效率。
