AssertJ集合去重断言排序问题分析与修复

背景介绍

AssertJ是一个流行的Java测试断言库，提供了丰富的断言方法来简化测试代码编写。在集合操作方面，AssertJ提供了doesNotHaveDuplicates()方法来验证集合中是否包含重复元素。然而，在实际使用中发现了一个关于元素排序显示的问题。

问题现象

当对一个已排序的集合执行doesNotHaveDuplicates()断言时，如果断言失败，错误信息中显示的重复元素列表并不是按照原集合的顺序排列的。这虽然不影响断言功能的正确性，但会给开发者调试带来不便，因为开发者需要额外精力去匹配错误信息中的重复元素和实际集合中的位置。

问题根源分析

通过查看AssertJ源码可以发现，该断言内部使用了一个TreeSet来收集重复元素。TreeSet会根据元素的自然顺序或指定的Comparator进行排序，这就导致了即使原始集合是有序的，错误信息中显示的重复元素也会被重新排序。

解决方案讨论

社区提出了两种可能的解决方案：

1. 使用LinkedHashSet替代TreeSet：LinkedHashSet会保持元素的插入顺序，这样重复元素的显示顺序将与它们在原始集合中首次出现的顺序一致。

2. 保持当前实现但调整比较逻辑：另一种思路是保持TreeSet但调整比较逻辑，使重复元素按照它们在原始集合中首次出现的位置排序。

经过讨论，社区最终选择了第一种方案，因为它实现更简单，且能更好地满足开发者调试的需求。特别是当集合中存在null元素时，LinkedHashSet能更直观地展示重复元素的出现顺序。

实现细节

修复方案主要涉及以下修改：

1. 将内部使用的TreeSet替换为LinkedHashSet
2. 移除不必要的自定义比较器
3. 保持原有的元素收集逻辑，只是改变了存储结构

这种修改确保了错误信息中的重复元素列表会按照它们在原始集合中首次出现的顺序显示，与集合的实际顺序保持一致，大大提高了调试效率。

对开发者的影响

这一改进虽然看似微小，但在实际开发中能带来显著的便利：

1. 调试效率提升：开发者可以快速定位重复元素在原始集合中的位置
2. 一致性增强：错误信息的显示顺序与集合顺序一致，减少认知负担
3. 特殊元素处理：对null元素的显示也更加符合直觉

最佳实践建议

对于使用AssertJ进行集合测试的开发者，建议：

1. 对于有序集合的断言，使用最新版本的AssertJ以获得更好的错误信息
2. 在编写测试时，考虑集合的顺序特性，选择合适的断言方法
3. 对于复杂的集合断言，可以组合使用多个断言方法来精确验证各种条件

这一改进体现了AssertJ团队对开发者体验的持续关注，即使是看似微小的细节优化，也能显著提升测试代码的可维护性和调试效率。