C4-PlantUML中模型与视图分离的设计实践

背景与需求

在软件架构可视化领域，C4模型是一种流行的分层抽象方法。使用C4-PlantUML时，开发者常遇到一个典型问题：如何实现模型定义与视图呈现的分离。具体表现为：

• 需要在多个图表中复用相同的模型元素（系统/容器/组件）
• 但又不希望这些基础元素在所有图表中自动渲染
• 期望保持模型定义的单一真实来源（Single Source of Truth）

技术方案分析

标准include的局限性

传统!include指令会直接渲染所有被包含元素，这会导致：

1. 基础模型文件被包含时产生冗余渲染
2. 破坏视图的专注度
3. 增加图表维护复杂度

现有解决方案

1. remove @unlinked指令
   通过标记未显式关联的元素为@unlinked，配合remove指令实现自动隐藏。但存在两个限制：

   • 可能触发内部异常
   • 当父元素（如System）包含子元素（如Component）时，需要同时引用父子元素才会显示

2. JSON元数据驱动
   通过外部JSON文件定义模型结构，再动态生成对应的PlantUML代码。这种方案：

   • 实现完全解耦
   • 支持更复杂的模型管理
   • 但需要额外开发转换工具

3. 预处理子部分包含
   利用PlantUML的预处理功能，通过!startsub/!endsub标记代码块，再使用!includesub选择性包含特定段落。这种方式：

   • 提供精确的包含控制
   • 保持纯文本工作流
   • 需要预先规划代码结构

最佳实践建议

简单项目方案

对于中小型项目，推荐组合使用：

' 基础模型文件(model.puml)
!startsub BASE_MODEL
System(systemA, "系统A")
Container(containerB, "容器B")
!endsub

' 视图文件(view.puml)
!includesub model.puml!BASE_MODEL
Rel(systemA, containerB, "调用")

复杂系统方案

对于企业级系统，建议采用：

1. 分层模型定义（按业务域/技术栈划分）
2. 版本化的JSON Schema存储核心模型
3. 自动化流水线生成最终图表

注意事项

1. 元素可见性规则需要全面测试
2. 跨文件引用时注意命名空间管理
3. 考虑引入命名规范（如前缀/后缀约定）
4. 文档化模型与视图的映射关系

通过合理运用这些模式，可以在C4-PlantUML中实现清晰的关注点分离，既能保证模型一致性，又能获得灵活的视图控制能力。