关于Object的equals()及hashCode()
在某些时候,我们需要判断两个对象是否相等。Java的每个类都继承于Object类。它使用equals()及hashCode()这两个方法来判断两个Object是否相等。
1. equals()
对于非null的对象引用,依下面关系进行判断:
l 对于任一非null引用x,x.equals(x)应返回true
l 对于任一非null引用x及y,仅在y.equals(x)返回true时,x.equals(y)才返回true
l 对于任一非null引用x、y及z,如果x.equals(y)为true,而且y.equals(z)为true,则x.equals(z)应返回true
l 对于任一非null引用x及y,如果用于比较的信息没有改变,无论多少次调用x.equals(y)都会恒定地返回true或false
l 对于任一非null引用x,x.equals(null)应返回false
Object的默认实现是只有在两个Object的引用相等时,才会返回true,即return x == y;
如果要覆盖(override)此方法,需要同时覆盖hasCode(),要求是:两个相等的对象必须有相等的hash code。
2. hashCode()
其必须遵循的约定是:
l 在一个Java应用的一次运行中,如果用于equals()比较的信息未变,同一个对象的hasCode()必须恒定地返回相同的整数。但在同一个应用的另一个运行中,此值可以改变
l 如果根据equals(),两个对象均相同,则调用这两个对象的hasCode()必须返回相同的int值。
l 如果equals()返回false,这两个对象的hashCode()可以返回相同的int值。但不等的两个对象返回不同的int值可以提高hashtables的运行效率。
作为常理,不相等的对象的hasCode()应可能地返回不同的int值。(通常可以将对象的内存地址转换为int值后返回,但这不是Java语言所要求的)。
3. 小结
l hashCode()必须配合equals()来实现判定两个对象是否相等
l 由于默认的equals()方法是使用是否同一对象的引用来判断是否相等,由于默认的hashCode()返回对象的内存地址,而不同的对象有不同的地址,因此,如果未覆盖equals(),也不需覆盖hashCode()。但有一点需注意,由于内存地址比Integer的数值要大,因此不同地址所转换成的int值可能会一样。即使出现这种情况也不要紧,仅影响hashtable的运行效率而已。
l hashCode()的返回值必须根据用于equals()判断的信息来决定。如果equals()返回true,hashCode()必须返回相同的int值。如果equals()为false,最好返回不同的int值。
这样,只要符合上面3点条件,采用何种公式或方式来实现hasCode()均是可行的。
4. 实例
尽管道理很浅显,但要实现起来并不容易,尤其是hashCode()。考虑一下两个对象,如果它们的一个String的字段相等就可认为两个对象相等。这种情况下,应如何根据这个String的字段来返回相同或不同的int值?相等时很好办,用以下的语句即可解决:
if (strA.equals(strB)) {
return 1;
}
但不等时呢,难点在于如何将不等的String值转换为不同的int值。而且,如果这两个对象均出自同一类,您所编写的代码均适用于这两个对象,同样的代码,如何才能出现不同的结果?如果通过硬编码的方式,先取得另一个对象的hashCode()值,再依此修改本对象的hasCode()值,势必造成每次比较都会导致本身的hasCode()值频繁发生变化。而如果同一类的不同实例使用各自的算法,从而无需提取另一个对象的hashCode()值,但在比较时,又如何实时地了解对方的情况?我们陷入了两难的境地。
好消息是,jakarta-commons中一个lang包,其EqualsBuilder与HashCodeBuilder类可方便地解决此问题。对于equals()及hashCode(),均有硬编码及反射机制的两种解决方法。
EqualsBuilder
先看码编码方式:
public boolean equals(Object obj) {
if (obj instanceof MyClass == false) {
return false;
}
if (this == obj) {
return true;
}
MyClass rhs = (MyClass) obj;
return new EqualsBuilder()
.appendSuper(super.equals(obj))
.append(field1, rhs.field1)
.append(field2, rhs.field2)
.append(field3, rhs.field3)
.isEquals();
}
在进行基本的判断后,通过EqualsBulder.append()的方式,将用于区分两个对象的各个业务关键逻辑逐一增加至其实例中就可以了。
下面是反射机制:
public boolean equals(Object obj) {
return EqualsBuilder.reflectionEquals(this, obj);
}
代码更简洁。
HashCodeBuilder
先看硬编码方式:
public class Person {
String name;
int age;
boolean smoker;
...
public int hashCode() {
// you pick a hard-coded, randomly chosen, non-zero, odd number
// ideally different for each class
return new HashCodeBuilder(17, 37).
append(name).
append(age).
append(smoker).
toHashCode();
}
}
这里,name, age, smoker等字段均为在equals()中使用的信息。任选两个随意的非零奇数作为构造函数的参数,并逐一加至HashCodeBuilder的实例中。
再看反射机制:
public int hashCode() {
return HashCodeBuilder.reflectionHashCode(this);
}
同样也很简单。
尽管通过反映机制看起来比较简单,但一是速度较慢,二是要受到安全机制的制约,因此,应尽可能地使用硬编码的方式。