记一次BUG：深拷贝与浅拷贝（Java）

记录在近期工作中的一个BUG。需求：从所有邮件模板中，筛选出符合的邮件模板，根据不同的数据，将模板中特定的“字眼”替换为具体的值。这里只针对BUG相关的问题，不涉及与业务相关。

深拷贝与浅拷贝的概念

深拷贝

• 可以理解为：对对象完全的拷贝，一个对象在内存中所占得内存大小，深拷贝就是拷贝一份一模一样的对象在堆内存中。

浅拷贝

• 通俗易懂的讲：就是对象的引用拷贝，这个引用指向堆中的同一个地址。

代码解读

// 拿到所有的模板
List<Template> templates = templateDao.getTemplateList();

// 筛选
Template template = templates.stream()
    .filter(t -> "PVC".equals(t.getEvent()) && "EN".equals(t.getLanguage()))
    .findFirst()
    .orElse(null);
if (template != null) {
    // 替换模板中定好的 ”字眼“
    // do something
}

不难看出，这段代码在方法中，如果单次调用是没有问题的；如果在一个循环中，而且代码中的Language是通过不同的情况取得，在运行中就会出现问题，代码如下：

// 拿到所有的模板
List<Template> templates = templateDao.getTemplateList();

for (String lang : languages) {
    // 筛选
    Template template = templates.stream()
        .filter(t -> Objects.equals(t.getEvent(), "PVC") && Objects.equals(lang, t.getLanguage()))
        .findFirst()
        .orElse(null);
    if (template != null) {
        // 替换模板中定好的 ”字眼“
        // do something
    }
}

此段代码，首先我改变过滤条件的写法，防止出现空指针异常。分析下这段代码：如果language相同，那么只有第一次才会替换字眼成功，因为第一次替换之后templates集合中的对应元素也会被替换掉，之后出现相同的语言，过滤出来的template中的字眼已经是被替换掉了，所有会出现相同的数据。这也是这个问题的关键点，说明此处是浅拷贝，只是拷贝对象的引用，引发的BUG。对此，这里提供三种参考方式：

方式一：

• 重写Template的clone()方法，这种方式网上资料也是很多的，但是本人并没有尝试，只是了解一下，感觉太麻烦了。

方式二：

• 使用序列化与反序列化实现深拷贝（推荐）

@SuppressWarnings("unchecked")
public static Object deepCopy(Object src) throws IOException, ClassNotFoundException{
    test(src);
    test1(src);
    if (src == null) {
        return null;
    }
    ByteArrayOutputStream bos = new ByteArrayOutputStream();
    ObjectOutputStream out = new ObjectOutputStream(bos);
    out.writeObject(src);
    ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray());
    ObjectInputStream in =new ObjectInputStream(bis);
    return in.readObject();
}

方式三：

• 使用 commons-lang3 中的org.apache.commons.lang3.SerializationUtils类，其实这个工具类内部实现也是方式二的写法。（推荐）

Template temp = SerializationUtils.clone(template);

通过第三种方式修改后，整体代码如下：

// 拿到所有的模板
List<Template> templates = templateDao.getTemplateList();

for (String lang : languages) {
    // 筛选
    Template template = templates.stream()
        .filter(t -> Objects.equals(t.getEvent(), "PVC") && Objects.equals(lang, t.getLanguage()))
        .findFirst()
        .orElse(null);
    if (template != null) {
        Template temp = SerializationUtils.clone(template);
        // 替换模板中定好的 ”字眼“
        // do something
    }
}

若有不对之处，请指点一二，谢谢。
记录在工作中的BUG，不断完善自我，加油！