EqualsBuilder类的使用

apache的commons-lang包提供了一个EqualsBuilder类，提供了基本属性、数组、对象等比较操作的封装，可以辅助实现对象的equals(Object)方法。

这个类的使用比较简单，官方API文档中提供了一个典型示例：

public boolean equals(Object obj) {
if (obj == null) { return false; }
if (obj == this) { return true; }
if (obj.getClass() != getClass()) {
return false;
}
MyClass rhs = (MyClass) obj;
return new EqualsBuilder()
.appendSuper(super.equals(obj))
.append(field1, rhs.field1)
.append(field2, rhs.field2)
.append(field3, rhs.field3)
.isEquals();
}

这个示例中需要注意appendSuper(super.equals(obj))方法。这个方法官方说明较少，如果类直接继承自Object类或父类没有覆盖equals(Object obj)方法此方法会返回false，造成比较的失败。这个方法容易对使用者造成误导，应谨慎使用，一般使用中主要还是使用append(field1, rhs.field1)方法。

这个方法要求通过父类的equals方法与obj对象进行比较并存储比较结果。源码如下。

public EqualsBuilder appendSuper(boolean superEquals) {
if (isEquals == false) {
return this;        //已经存储了为false的比较结果不在进行后续处理
}
isEquals = superEquals;     //将本次比较结果存入isEquals属性
return this;
}

后续的append()方法也会首先判断当前存储的isEquals属性，如果前面比较为false则不知进行性后续比较操作。

public EqualsBuilder append(Object lhs, Object rhs) {
if (isEquals == false) {    //如果前面比较结果为false直接返回
return this;
}

//进行下面的比较操作
...
}