何时改写equals方法
当一个类有自己特有的"逻辑相等"概念,而且超类也没有实现equals方法实现期望的行为,这是我们需要改写equals方法。这种比较适合"值类"情形,比如Integer或者Date。当需要自定义类最为HashMap的键时,也需要改写equals方法,与此同时还需改写hashcode()方法。
对于改写equals方法所需遵守的通过规定:
自反性:对于任何非空引用值 x,x.equals(x) 都应返回 true。
对称性:对于任何非空引用值 x 和 y,当且仅当 y.equals(x) 返回 true 时,x.equals(y) 才应返回 true。
传递性:对于任何非空引用值 x、y 和 z,如果 x.equals(y) 返回 true,并且 y.equals(z) 返回 true,那么 x.equals(z) 应返回 true。
一致性:对于任何非空引用值 x 和 y,多次调用 x.equals(y) 始终返回 true 或始终返回 false,前提是对象上 equals 比较中所用的信息没有被修改。
对于任何非空引用值 x,x.equals(null) 都应返回 false。
对于上面几个规则,我们在使用的过程中最好遵守,否则会出现意想不到的错误。
这里说明一点:对于改写equals中的"非空性",为了测试实参与当前对象的相等情况,equals方法首先把实参转为一种适当的类型,在转换之前,equals方法必须使用instanceof操作符,检查实参是否为正确的类型:
public boolean equals(Object o) {
if (!(o instanceof Mytype)) {
return false;
....
}
}
如果o为null,则类型检查结果为false,所以不需做单独的null检查。
实现高质量的equals方法:
- 使用==操作符检查"实参是否为指向对象的一个引用".
- 使用instanceof操作符检查"实参是否为正确的类型"
- 把实参转换为正确的类型
- 对于每一个"关键域",检查实参中的域与当前对象中对应的域值是否匹配
比较域值的常用方法(防止原对象引用域值本身为Null的情况)
(field == null ? o.field == null :field.equals(o.field) );
如果是对象引用,那么下面的方法会更快一点:
(field == o.field || (o.field != null && field.equals(o.field) );
- 改写equals方法之后,改写hashcode
- 不要将equals声明中的Object对象换成其他类型。
以下代码是错误的例子:
public boolean equals(Mytype o) {
...
}
以下是一个样例:
public class Mytype
{
private String field;
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (!(o instanceof Mytype)) {
return false;
}
Mytype my = (Mytype)o;
return (field == my.field ||(my.field != null &&field.equals(my.field)));
}
public boolean equals(Mytype o) {
}
}
有时候实参与对象本身比较也省略掉了。
改写hashCode方法
在每个改写equals方法的类中,你也必须改写hashCode()方法。
hashcode的约定:
- 如果一个对象的equals方法作比较所用的信息没有被修改的话,那么,对该对象调用hashcode方法多次,始终返回用一个整数值。
- 如果两个对象根据equals方法是相等的,那么它们具有相同的散列码
- 如果两个对象根据equals方法不是相等的,那么调用这两个对象中任一个对象的hashcode方法,不要求必须产生不同的整数结果。
未重写hashcode方法引发的问题
如果一个类A只重写了equals方法,当它的实例对象被用作HashMap的键时,在获取这个键对应的值的时候,问题来了,用put(K1,V)方法和get(K1)方法时,这里涉及类A的两个实例,第二个对象和第一个实例相等,第二个实例用于检索时,问题发生了,类A并没有重写hashcode方法,所以两个实例具有不同的散列码,违反了hashcode的约定,因此,Put方法把对象K1放在一个散列桶里,而get方法去另一个散列桶里查找他的对象。
改写hashcode的"部分良方"
以下是从《Effective Java》截取的一部分良方,如果想看更详细的方案,可以参阅《Effective Java》这本书。
- 把数值17(或者其他数值)保存在一个result的int类型的变量中
- 计算int类型的散列码
- boolean类型计算:(f ? 0:1)
- 以下是例子:
@Override
public int hashCode() {
int result = 17;
result = result * 37 + string.hashCode();
result = result * 37 + number;
return result;
}