Apache Commons DiffBuilder 3.7嵌套复杂对象列表对比问题求助

我之前也踩过这个坑，Apache Commons Lang 3.7的ReflectionDiffBuilder和DiffBuilder在处理包含嵌套复杂对象的列表属性时，确实会出现对比失效的情况。核心原因是：

• 3.7版本默认对集合（包括List）的对比是浅层次的：要么检查集合引用是否相同，要么依赖元素自身的equals()方法（如果你的自定义对象没重写equals()，那就是引用对比），不会递归遍历列表里的每个复杂对象，去逐一对比它们的属性。

下面给你两种可行的解决方案：

方案一：自定义Equator手动处理嵌套列表（适用于3.7版本） #

你可以通过DiffBuilder的append()方法，为列表属性指定自定义的Equator，手动递归对比每个嵌套对象的属性。

首先定义你的实体类：

public class Master {
    private Integer id;
    private String name;
    private List<Detail> details;

    // 构造器、Getter、Setter省略
}

public class Detail {
    private Integer id;
    private String name;

    // 构造器、Getter、Setter省略
}

然后编写自定义对比逻辑：

import org.apache.commons.lang3.builder.DiffBuilder;
import org.apache.commons.lang3.builder.ReflectionDiffBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import org.apache.commons.lang3.builder.Equator;

public class ObjectComparator {
    public static String compareMasterObjects(Master master1, Master master2) {
        return new DiffBuilder(master1, master2, ToStringStyle.DEFAULT_STYLE)
                // 对比基础属性
                .append("id", master1.getId(), master2.getId())
                .append("name", master1.getName(), master2.getName())
                // 自定义对比details列表
                .append("details", master1.getDetails(), master2.getDetails(), new Equator<List<Detail>>() {
                    @Override
                    public boolean equate(List<Detail> details1, List<Detail> details2) {
                        // 处理null情况
                        if (details1 == null && details2 == null) return true;
                        if (details1 == null || details2 == null || details1.size() != details2.size()) {
                            return false;
                        }
                        // 遍历每个Detail对象，用ReflectionDiffBuilder对比属性
                        for (int i = 0; i < details1.size(); i++) {
                            Detail d1 = details1.get(i);
                            Detail d2 = details2.get(i);
                            String diffResult = new ReflectionDiffBuilder(d1, d2, ToStringStyle.DEFAULT_STYLE)
                                    .build()
                                    .toString();
                            // 如果两个Detail有差异，返回false
                            if (!diffResult.isEmpty()) {
                                return false;
                            }
                        }
                        return true;
                    }

                    @Override
                    public int hash(List<Detail> details) {
                        return details != null ? details.hashCode() : 0;
                    }
                })
                .build()
                .toString();
    }
}

这个方法会逐一检查列表里的每个Detail对象的属性差异，把所有差异汇总到最终的对比结果里。

方案二：升级Apache Commons Lang到3.8+版本（更简便） #

从Apache Commons Lang 3.8版本开始，ReflectionDiffBuilder已经优化了对集合类型的处理，支持递归对比集合中的嵌套复杂对象，不需要额外写自定义逻辑。

升级依赖后，直接使用ReflectionDiffBuilder就能得到正确的对比结果：

public static String compareMasterObjectsV38(Master master1, Master master2) {
    return new ReflectionDiffBuilder(master1, master2, ToStringStyle.DEFAULT_STYLE)
            .build()
            .toString();
}

补充说明 #

如果你的自定义对象重写了equals()和hashCode()方法，3.7版本也能基于这些方法做列表元素的对比，但只能判断元素是否“相等”，无法像ReflectionDiffBuilder那样输出具体的属性差异。而升级到3.8+版本后，不仅能判断相等性，还能输出每个嵌套对象的具体差异细节。

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