如何避免PlantUML中的文本与对象重叠问题？

问题描述 #

尝试用PlantUML绘制包含嵌套组件（组件内嵌套另一个组件）及内外接口的规范图示时，出现对象与文本重叠的问题，展示效果不佳。原代码如下：

@startuml
left to right direction
component "component2" {
  portin " " as pi1
  portin " " as pi2
  portout " " as po1
  rectangle comp1
  pi1 --> comp1 
  pi2 --> comp1 
  comp1 --> po1
}

label "Interface1" as I1
label "Interface2" as I2
label "Interface3" as O3

I1 --> pi1
I2 --> pi2
po1 --> O3
@enduml

原生成图存在文本与组件/端口重叠的问题，布局混乱。

修正方案 #

通过调整组件定义方式、端口位置和接口类型，解决重叠问题，代码如下：

@startuml
left to right direction

component "外部组件" as component2 {
  component "内部组件" as comp1
  ' 指定端口位置，避免与内部组件重叠
  portin "输入端口1" as pi1 left
  portin "输入端口2" as pi2 left
  portout "输出端口1" as po1 right
  
  pi1 --> comp1
  pi2 --> comp1
  comp1 --> po1
}

' 使用interface定义外部接口，优化布局
interface "Interface1" as I1
interface "Interface2" as I2
interface "Interface3" as O3

I1 --> pi1
I2 --> pi2
po1 --> O3
@enduml

修改说明 #

• 将内部的rectangle替换为component，保持组件层级一致性，PlantUML会自动优化内部布局
• 为端口添加left/right位置参数，明确端口位于外部组件的侧边，避免与内部组件重叠
• 用interface替代label定义外部接口，PlantUML对接口元素的布局逻辑更完善，减少文本重叠

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