跳到正文

免费工具

Structurizr DSL 转 C4 模型图

粘贴 Structurizr DSL 工作区或工作区 JSON 导出,即可把 C4 模型的各个视图显示为可编辑的图表:人员、软件系统、容器、组件和部署节点,关系以其描述作为标签。可以选择一个视图,也可以把所有视图分别打开为独立的图表。

示例输出

由 Structurizr 示例绘制的示例图表
试试示例网上银行 (DSL)包裹追踪 (JSON)

使用方法

  1. 粘贴或拖入工作区

    可以是 workspace.dsl 文件、从 Structurizr playground 复制的 DSL,或 Structurizr 导出的 JSON。会读取 model 和 views 块,styles 可以留在文本中。

  2. 查看每个 C4 视图

    工作区中的所有视图都会列出,从系统全景图一直到组件和部署视图。选择其中一个,预览会用 C4 卡片、边界和带标签的箭头重新绘制。

  3. 在 Archboard 中打开

    把视图保存为新图表,即可重新排列、添加批注、分享链接,或导出为 SVG 和 PNG。使用 Google 或 GitHub 账号即可注册。

从 Structurizr 工作区绘制的内容

所选视图由模型的以下部分构成:

  • person

    人员绘制为带描述的 C4 人员卡片。带有 External 标签的人员,或在 JSON 导出中 location 为 External 的人员,会成为外部人员。

  • softwareSystem

    软件系统绘制为带描述的 C4 系统卡片。带有 External 标签的系统会成为外部系统卡片,只显示名称。

  • container

    容器绘制为带技术和描述的卡片。带有 Database 标签的容器会成为数据库卡片,只显示名称。带 Queue 标签的容器、带 External 标签的容器和组件以及 enterprise 块会以各自的 C4 类型绘制:queue 容器、external container 和 component 卡片,以及 enterprise 边界。

  • component

    组件绘制为带技术的卡片,位于所属容器之内。

  • ->

    关系绘制为以描述为标签的箭头,技术写在其后的方括号中。如果视图只显示父元素,子元素之间的关系会在父元素之间只绘制一次。

  • container bankingcomponent banking.api

    容器视图和组件视图的范围绘制为框:容器视图中是软件系统,组件视图中是容器。

  • group

    分组绘制为包住其中人员、系统或容器的框。空分组不会绘制。

  • deploymentNodeinfrastructureNodecontainerInstance

    部署视图中,嵌套的部署节点绘制为框,容器实例和软件系统实例绘制为其对应元素的卡片,基础设施节点绘制为部署节点卡片。

  • systemLandscapesystemContextdeployment

    系统全景、系统上下文、容器、组件和部署视图,每个视图都是独立的图表。没有视图的工作区会得到一个全景图、每个系统一个上下文视图,以及每个含容器的系统一个容器视图。

  • autoLayout lrinclude *

    include * 按各视图类型的含义解析,支持列出标识符的 include 和 exclude,以及 autoLayout 的方向;未指定方向时从上到下。

一个工作区,多个视图

一个工作区通常包含同一模型的多个视图。文件中的第一个视图会先绘制,预览上方的视图选择器可以切换到同一文本的任何其他视图。要保留所有视图,使用 打开所有视图 会在你的工作区中为每个视图创建一个图表,所选视图排在最前。在 Free 方案中,超出图表上限的视图不会被悄悄丢弃:工具会告诉你已打开多少个、还剩多少个。

Structurizr 导入不包含的内容

  • 工作区引用的文件和脚本:!include、!docs、!adrs、!script、!plugin 和 workspace extends 不会被跟随或执行。它们会计入一条警告,粘贴文本中写出的内容仍会全部绘制。
  • 元素和关系的样式、主题与品牌设置。形状、颜色和图标来自 C4 卡片,图表在 Archboard 中打开后可以再修改样式。
  • dynamic、filtered、custom 和 image 视图,以及写成表达式的 include 或 exclude 规则。它们会被跳过并计数,其他视图仍会列出。
  • JSON 导出中保存的元素位置。由于 Structurizr 的尺寸与 C4 卡片不匹配,每个视图都会重新自动布局。
  • 文档章节、决策记录、properties、perspectives 和 URL。只读取模型及其视图。

关于 Structurizr 的问题

可以从 Structurizr DSL 绘制哪些 C4 层级?

Structurizr 建模的全部层级:第 1 层的系统上下文和系统全景视图、第 2 层的容器视图、第 3 层的组件视图,另外还有部署视图。代码层级的图不属于 Structurizr 工作区,因此没有可绘制的内容。

可以粘贴工作区 JSON 导出来代替 DSL 吗?

可以。Structurizr 保存或导出的 JSON 读取方式相同:每个视图中列出的元素和关系都会绘制,包括人员、系统、容器和部署节点。保存的位置会被忽略,每个视图都会重新自动布局。

可以一次打开所有视图吗?

可以。工作区有两个或更多视图时,打开所有视图 会从你选择的视图开始,为每个视图创建独立的图表。如果方案的图表上限让它提前停止,已打开的视图会保留,其余视图会被计数,不会在你不知情的情况下丢失。

我的工作区使用了 !include,该怎么办?

把被包含的文件粘贴到同一个文本框中,替换对应的 !include 行。该指令不会被跟随,而是计入一条警告,因为工具只读取你提供的文本。

在 Archboard 中打开图表时会保存什么?

预览不会保存。选择 在 Archboard 中打开 后,你看到的视图会连同 C4 卡片、边界、框和带标签的箭头一起,作为新图表保存到你的工作区。之后修改 DSL 或 JSON 不会更新它。

Structurizr 转图表工具免费吗?

免费。粘贴工作区和查看图表都不需要账号。在 Archboard 中打开一个视图或全部视图需要免费账号。

一分钟打开画布

使用 Google 或 GitHub 登录。单席位免费,团队加入后再升级。