PlantUML中JSON变量管理的深拷贝问题解析

问题背景

在PlantUML预处理器的使用过程中，开发者发现了一个关于JSON变量管理的潜在问题。当使用%json_add函数对JSON数组进行操作时，原始变量会被意外修改，这不符合大多数开发者对变量赋值的预期行为。

问题重现

考虑以下PlantUML代码示例：

@startuml
title 为什么$a和$b会被修改？

!$a = [0,1]
!$b = %json_add($a, 5)
!$c = %json_add($a, 6)

json a {
"value":$a
}
json b {
"value":$b
}
json c {
"value":$c
}
@enduml

在这个例子中，开发者期望：

1. 创建初始数组$a = [0,1]
2. 创建$b为在$a基础上添加元素5的新数组
3. 创建$c为在$a基础上添加元素6的新数组

然而实际结果是所有三个变量都被修改了，这是因为PlantUML内部实现中变量引用被共享导致的。

技术分析

这个问题本质上是一个关于对象拷贝的经典问题，涉及浅拷贝(Shallow Copy)和深拷贝(Deep Copy)的区别：

1. 浅拷贝：只复制对象本身，不复制对象内部引用的其他对象

   • 新对象和原对象共享内部引用
   • 修改内部对象会影响所有引用它的变量
   • 实现简单，性能高

2. 深拷贝：递归复制对象及其所有引用的对象

   • 新对象完全独立于原对象
   • 修改不会相互影响
   • 实现复杂，性能较低

在PlantUML的JsonArray实现中，最初使用的是浅拷贝方式，这导致了变量间的意外共享。解决方案是为JsonValue类添加了cloneMe()方法实现深拷贝。

解决方案实现

PlantUML团队在JsonArray类中添加了如下深拷贝实现：

public JsonValue cloneMe() {
    JsonArray result = new JsonArray();
    for (JsonValue value : values) {
        result.add(value.cloneMe());
    }
    return result;
}

这种实现方式确保了：

1. 创建新的JsonArray对象
2. 递归复制所有内部元素
3. 返回完全独立的新对象

最佳实践建议

基于这个问题，开发者在处理JSON数据时应注意：

1. 明确操作意图：是需要修改原对象还是创建新对象
2. 对于需要保持独立性的操作，使用深拷贝方式
3. 在编写预处理函数时，考虑是否需要先复制输入参数
4. 测试时特别注意复合数据结构的修改影响范围

总结

这个问题的解决不仅修复了%json_add函数的行为，也为PlantUML中其他JSON操作函数提供了参考。理解浅拷贝和深拷贝的区别对于处理复杂数据结构至关重要，能够帮助开发者避免类似的意外行为。

PlantUML团队通过添加cloneMe()方法解决了这个问题，同时也提醒开发者在处理对象引用时需要格外小心，特别是在预处理这种可能涉及多次变量传递和修改的场景中。