C4-PlantUML 中处理标签与图例的注意事项

前言

在使用 C4-PlantUML 进行架构图绘制时，标签(Tag)和图例(Legend)是非常实用的功能。然而，当项目规模扩大、需要引入多个包含文件时，开发者可能会遇到图例显示异常的问题。本文将深入分析这一现象的原因，并提供多种解决方案。

问题现象分析

在 C4-PlantUML 中，我们可以通过 AddContainerTag 方法为容器添加自定义标签，并指定其在图例中的显示文本。例如：

AddContainerTag("the-tag", $shape=EightSidedShape(), $legendText="The-tag (eight sided)")

正常情况下，使用 SHOW_LEGEND() 会正确显示所有定义的标签及其说明。但当项目结构复杂化，特别是使用 !include 引入其他文件时，可能会出现标签形状生效但图例不显示的情况。

根本原因

这一问题的核心在于 C4-PlantUML 的初始化机制。每次包含 C4_Container.puml 文件时，都会重置之前的标签定义和图例设置。因此，如果在主文件和被包含文件中都引入了 C4_Container.puml，就会导致先定义的标签信息被后续的初始化覆盖。

解决方案

方案一：变量检查法

通过在首次包含后设置变量，后续包含前检查该变量是否存在，可以避免重复初始化：

!if %not(%variable_exists("DONT_INCLUDE_C4_AGAIN"))
    !include C4_Container.puml
    %set_variable_value("DONT_INCLUDE_C4_AGAIN",1)
!endif

这种方法简单直接，适用于大多数场景，但需要在所有可能包含 C4_Container.puml 的地方添加检查逻辑。

方案二：包含子模块法

PlantUML 提供了 !startsub、!endsub 和 !includesub 指令，可以更优雅地处理模块化包含：

1. 在被包含文件中定义子模块：

!startsub predefinedModule
Container(cont_included, "Included container", $tags="the-tag")
!endsub

2. 在主文件中选择性包含：

!includesub include.puml!predefinedModule

这种方法隔离了初始化代码和业务代码，结构更清晰。但需要注意，当前版本对多行语句(使用反斜杠换行)的支持可能存在问题。

方案三：架构重组法

对于复杂项目，建议重组项目结构：

1. 创建专门的初始化文件，包含所有全局设置和标签定义
2. 业务组件文件只包含具体的元素定义
3. 主文件按顺序包含初始化文件和业务组件

这种方案虽然需要调整项目结构，但长期来看最易于维护。

最佳实践建议

1. 单一初始化原则：确保 C4_Container.puml 只在项目的一个位置被包含
2. 标签集中管理：将所有标签定义放在一个专门的文件中
3. 模块化设计：使用子模块功能分离关注点
4. 版本控制：记录使用的 C4-PlantUML 版本，避免因版本更新导致兼容性问题

总结

在大型项目中使用 C4-PlantUML 时，合理的文件组织和包含策略至关重要。理解 PlantUML 预处理机制的工作原理，可以帮助开发者避免类似图例显示异常的问题。根据项目规模和团队习惯，选择最适合的解决方案，可以显著提高架构图的可维护性和一致性。