JUnit报错排查：转列表测试有序Map相等性失败原因

我最近在做单元测试时碰到一个头疼的问题：把两个带顺序的Map转换成List<Map.Entry<String, AtomicInteger>>后，用JUnit断言它们相等时，出现了完全摸不着头脑的失败。虽然我知道有更优的实现方式，但现在就想搞清楚这个错误到底是怎么来的。

我的测试代码片段如下：

@Test
public void sortedEntriesTest() {
    List<Map.Entry<String, AtomicInteger>> actualList = stream.sortedEntries(stream.getMap());
    List<Map.Entry<String, AtomicInteger>> expectedList = expectedMap.entrySet()
        .stream()
        .sorted(Comparator.comparingInt(e -> -e.getValue().get()))
        .collect(Collectors.toList());
    
    // 此处断言相等时抛出预期外的错误
    assertEquals(expectedList, actualList);
}

可能导致JUnit断言失败的几个关键点 #

• 排序规则不一致：你自己实现的stream.sortedEntries()方法里的排序逻辑，和预期列表用的Comparator.comparingInt(e -> -e.getValue().get())是不是完全匹配？比如有没有可能一个是降序、一个是升序？或者当多个entry的AtomicInteger值相同时，两者对key的排序逻辑不一样？默认的比较器在值相等时不会处理key的顺序，这时候两个列表里相同值的entry顺序可能不一致，直接导致整个列表断言失败。
• Map.Entry的equals逻辑细节：虽然AtomicInteger重写了equals（比较的是底层int值而非引用），但默认的Map.Entry实现（比如LinkedHashMap的Entry）的equals需要key和value都分别相等才行。你可以手动取两个列表对应位置的entry，调用entry1.equals(entry2)验证一下，看是否真的返回true。
• 原始Map的顺序可靠性：你提到两个Map都是“包含顺序”的，但要确认stream.getMap()返回的是不是真的有序Map（比如LinkedHashMap、TreeMap）。如果是HashMap这类无序Map，那entrySet的原始顺序本身就是不确定的，哪怕后续排序逻辑正确，也可能因为初始顺序问题导致最终列表不一致。
• JUnit断言的细节：普通的assertEquals在列表不相等时，给出的错误信息可能比较模糊。建议换成JUnit 4+的assertIterableEquals，它会明确指出哪一个位置的元素不匹配，或者元素数量不一致，帮你快速定位问题。

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