C4-PlantUML中处理包含文件时图例更新的问题解析

在使用C4-PlantUML进行架构图绘制时，开发者可能会遇到一个特殊问题：当使用!include指令包含其他Puml文件时，图例(Legend)的显示会出现异常。本文将深入分析这一问题的成因，并提供几种有效的解决方案。

问题现象

在标准使用场景下，当开发者使用AddContainerTag添加自定义标签并设置图例文本后，通过SHOW_LEGEND()指令可以正确显示图例。然而，如果在主文件中包含另一个也引用了C4-PlantUML库的文件时，虽然容器形状会正确显示，但图例文本却会丢失。

问题根源

这一问题的根本原因在于重复包含C4-PlantUML库文件。每次包含C4_Container.puml时，都会重新初始化图例相关的变量和设置，导致之前定义的标签图例信息被重置。这种设计是C4-PlantUML有意为之的，以确保每个文件的独立性。

解决方案

方案一：变量检查法

最可靠的解决方案是使用PlantUML的变量系统来避免重复包含：

@startuml
!include C4_Container.puml
%set_variable_value("DONT_INCLUDE_C4_AGAIN",1)

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

Container(cont_no_tag, "Container no tag")
Container(cont_with_tag, "Container with tag-1", $tags="the-tag")

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

Container(cont_included, "Included container with the-tag", $tags="the-tag")

SHOW_LEGEND()
@enduml

这种方法通过设置和检查全局变量来确保C4库只被包含一次，从而保留所有的标签定义和图例设置。

方案二：子模块包含法

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

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

@startuml
!include C4_Container.puml

!startsub predefinedModule1
Container(cont_included, "Included container with the-tag", $tags="the-tag")
!endsub
@enduml

2. 在主文件中包含特定子模块：

@startuml
!include C4_Container.puml

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

Container(cont_no_tag, "Container no tag")
Container(cont_with_tag, "Container with tag-1", $tags="the-tag")

!includesub include.puml!predefinedModule1

SHOW_LEGEND()
@enduml

这种方法不仅解决了图例问题，还提供了更好的模块化组织方式。

方案三：include_once指令（目前存在bug）

理论上，PlantUML的!include_once指令正是为解决重复包含问题而设计的，但目前版本中存在bug，无法正常工作。开发者可以关注PlantUML的更新，待bug修复后这将是最简洁的解决方案。

注意事项

1. 当使用子模块包含法时，需要注意被包含文件中不能使用反斜杠(\)进行多行格式化，这会导致解析错误。

2. 对于大型项目，建议统一采用变量检查法，它提供了最大的灵活性和可靠性。

3. 无论采用哪种方案，都建议在团队内部建立统一的包含规范，以避免不同开发者采用不同方式导致的维护问题。

通过理解这些解决方案的原理和适用场景，开发者可以更有效地在C4-PlantUML中组织复杂的架构图，确保图例和其他设置在各种包含场景下都能正确显示。