背景
我们知道在Java中比较两个对象是否相同,可以有多种方法,最常见的就是 == 和 equals 方法。但是由于==对比的是对象引用本身,因此重写equals才是最常用和可靠的比较两个对象是否相同的方法(当然重写equals同时意味着可能需要重写hashCode)
对于==和equals的异同,可以参考《阿里java规范》中对于Integer的一个很有意思的例子,因为Integer在实现时对-127~127的数字做了一个缓存,因此:
Integer i1 = 1, i2 = 1 ; i1==i2; // true i1.equals(i2); // true Integer i1 = 1024, i2 = 1024 ; i1==i2; // false i1.equals(i2); // true
但是在实际搬砖的过程中,很多时候对于每个需要比较的对象都重写equals是很麻烦的(有时这种重写equals可能导致新的依赖情况),而且对于一些无法修改源码的类重写equals也是不可行的。
因此想到了通过反射来处理这样一些情况,就能比较简单的进行一些深度的比较,从而不需要重写每个比较对象的equals方法,也降低了编码时候的侵入性。
方案
因此基于以上想法,特别将这种利用反射来实现的深度比较封装了一个简单的功能类,能比较方便的实现对比的功能。所以这其实是一篇广告文,骗你去访问我的github的,没想到吧!哈哈哈!
重要的广告无耻的做完3次之后,更无耻的讲下怎么用好了!还是没想到吧,哈哈哈!
使用示例
具体的使用示例如下:
// 初始化并设置对比属性
CompareUtils compareUtils = CompareUtils.build();
compareUtils.ignoreAnnotation(); // 是否忽略自定的 @NotCompare 注解
compareUtils.ignoreCollection() // 是否忽略对Collection类型的属性的比较(e.g. List)
compareUtils.ignoreMap(); // 是否忽略对Map类型的属性的比较
// 直接使用isDifferent方法来比较得出是否是相同的对象
Boolean isDifferent = compareUtils.isDifferent(firstObject, secondObject);
当然对于初始化和设置属性,推荐使用这种方式:
CompareUtils utils = CompareUtils.build()
.includeAnnotation()
.includeCollection()
.includeMap();
具体属性设置说明
- ignoreAnnotation/includeAnnotation : 鉴于灵活性的考虑,在对比中可能需要忽略一些不关注的属性值是否相同,因此提供了一个 @NotCompare 的注解,缺省情况下会跳过使用了注解的属性,但是可以通过该设置来选择是否开启跳过注解这一功能;
- ignoreCollection/includeCollection : 缺省情况下会对比对象中Collection类型的属性,但是可以通过该方法来开启或关闭这一行为
- ignoreMap/includeMap : 缺省情况下会对比对象中Map类型的属性,但是可以通过该方法来开启或关闭这一行为
注意点
- 对比的对象 不能有递归嵌套
- 通过一些会 增加属性数量 的方法生成的对象(比如Mokito.mock的对象),会造成 比对结果不准确,因为工具类在缺省情况下会将所有的属性都进行比较,而增加属性数量方法生成的对象,可能包含了一些额外的不相同的属性,造成本应该相同的对象最后存在不同的情况