C4 Modelling 使用教程

项目介绍

C4 Modelling 是一个用于在 draw.io 中创建软件系统模型的插件，提供了 C4 模型表示法元素。C4 模型由 Simon Brown 开发，是一种用于描述软件架构的层次化方法，包括上下文、容器、组件和代码四个层次。通过使用 C4 Modelling 插件，用户可以更方便地在 draw.io 中绘制和展示软件系统的架构图。

项目快速启动

安装步骤

1. 克隆项目仓库：

   git clone https://github.com/tobiashochguertel/c4-draw.io.git
   

2. 导入库文件：

   • 打开 draw.io。
   • 选择 文件 -> 从设备打开库 -> 选择 XML 文件，导入项目中的库定义文件。

3. 使用 C4 模型形状：

   • 在 draw.io 中，通过复制和粘贴形状来创建架构图。
   • 选择形状并按 Cmd + M（Mac）或 Ctrl + M（Windows）编辑形状数据。

示例代码

以下是一个简单的示例，展示如何在 draw.io 中使用 C4 模型形状创建一个容器图：

<mxfile host="app.diagrams.net">
  <diagram name="Page-1" id="0">
    <mxGraphModel dx="1024" dy="768" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
      <root>
        <mxCell id="0"/>
        <mxCell id="1" parent="0"/>
        <mxCell id="2" value="系统上下文" style="shape=c4Context;verticalLabelPosition=bottom;verticalAlign=top;align=center;html=1;outlineConnect=0;fillColor=#ffffff;strokeColor=#000000;gradientColor=none;gradientDirection=north;strokeWidth=2;fontColor=#000000;fontStyle=1;fontSize=16;" vertex="1" parent="1">
          <mxGeometry x="100" y="100" width="200" height="100" as="geometry"/>
        </mxCell>
      </root>
    </mxGraphModel>
  </diagram>
</mxfile>

应用案例和最佳实践

应用案例

• 企业级系统架构设计：使用 C4 模型在 draw.io 中绘制复杂的企业级系统架构图，帮助团队理解和沟通系统结构。
• 微服务架构规划：通过 C4 模型展示微服务之间的交互和依赖关系，优化服务设计和部署。

最佳实践

• 保持图表简洁：避免在单个图表中包含过多细节，确保图表易于理解和沟通。
• 使用一致的命名和样式：统一形状和标签的命名和样式，提高图表的可读性。
• 定期更新图表：随着系统的发展，定期更新架构图，确保其反映最新的系统状态。

典型生态项目

• draw.io：C4 Modelling 插件的基础平台，提供强大的图形绘制和编辑功能。
• C4 Model：由 Simon Brown 开发的软件架构描述方法，C4 Modelling 插件的核心理论基础。
• GitHub：项目托管和版本控制平台，方便团队协作和代码管理。

通过结合这些生态项目，C4 Modelling 插件为用户提供了一个完整的软件架构设计和沟通工具链。