PlantUML组件图中如何复用已声明的组件？

问题描述 #

我尝试用 PlantUML 绘制组件图，希望先声明组件 C，再将其复用在多个 node 中，编写了如下代码：

@startuml

cloud CMS #darkgreen {
component NMProxy #lightgreen 
}

component C #orange
node GW1 #brown {
C 
}

node GW2 #brown {
C
}

node GW3 #brown {
C
}

GW1 -up-> NMProxy
GW2 -down-> NMProxy
GW3 -down-> NMProxy

@enduml

但解析器在 GW1 节点首次使用组件 C 时抛出错误，请问是否存在先声明组件再通过名称复用它的方法？

解决方案 #

PlantUML 中直接在容器（如 node）内部写已声明的组件名，会被默认视为创建一个新的同名组件，这会和外部已声明的组件 C 产生冲突，从而触发解析错误。要复用已声明的组件，需要在容器内部通过 ref 关键字明确引用外部组件，或者使用 component C 的方式复用（本质是关联已存在的组件）。

修改后的代码示例1（使用 ref 关键字） #

@startuml

cloud CMS #darkgreen {
component NMProxy #lightgreen 
}

component C #orange
node GW1 #brown {
ref C
}

node GW2 #brown {
ref C
}

node GW3 #brown {
ref C
}

GW1 -up-> NMProxy
GW2 -down-> NMProxy
GW3 -down-> NMProxy

@enduml

修改后的代码示例2（使用 component 引用） #

@startuml

cloud CMS #darkgreen {
component NMProxy #lightgreen 
}

component C #orange
node GW1 #brown {
component C
}

node GW2 #brown {
component C
}

node GW3 #brown {
component C
}

GW1 -up-> NMProxy
GW2 -down-> NMProxy
GW3 -down-> NMProxy

@enduml

上述两种方式都能实现先声明组件 C，再在多个 node 中复用的需求，同时避免解析报错。

内容的提问来源于stack exchange，提问作者Ulisse Rubizzo