在每个覆盖了equals方法的类中,也必须覆盖hashCode方法。
一、Object.hashCode的通用约定
1) 只要对象的equals方法的比较操作所用到的信息没有被修改,那么对这同一个对象调用多次,hashCode方法都必须始终如一的返回同一个整数。在一个应用程序的多次执行过程中,每次执行所返回的整数可以不一致。
2)如果两个对象根据equals方法比较是相等的,那么调用这两个对象中任意一个对象的hashCode方法都必须产生同样的整数结果。
3)如果两个对象根据equals方法比较是不相等的,那么调用这两个对象中任意一个对象的hashCode方法,则不一定产生不同的整数结果。
equals结果为true,hashCode相等。hashCode相等,equals不一定为true。
因实现equals方法没有覆盖hashCode而违反的关键约定是第二条:相等的对象必须具有相等的hashCode。这种情况可能出现equals结果相等但是hashCode不相等的情况。
二、产生散列码简单的解决方法
一个好的散列函数通常倾向于“为不相等的对象产生不相等的散列码”。
第一步:把某个非零常数值,比如说17,保存在一个名为result的int类型的变量值中。
第二步:对于对象中的每一个关键域f (指equals 方法中涉及的每个域,非equals用到的域一概不要考虑),完成以下步骤:
a. 为该域计算int 类型的散列码c:
i.如果该域是boolean 类型,则计算(f ? 1 : 0);
ii.如果该域是byte、char、short 或者int 类型,则计算(int)f;
iii.如果该域是long 类型,则计算(int)(f ^ (f >>> 32));
iv.如果该域是float 类型,则计算Float.floatToIntBits(f);
v.如果该域是double 类型,则计算Double.doubleToLongBits(f) 得到一个long 类型的值,然后按照步骤2.a.iii 对该long 类型计算散列值;
vi.如果该域是一个对象引用,并且该类的equals方法通过递归地调用equals的方式来比较这个域,则同样为这个域递归调用hashCode。如果需要更复杂的比较,则为这个域计算一个“范示”,然后针对这个范示调用hashCode。如果这个域的值为null,则返回0(或者是其他某个常数,但通常是0);
vii.如果该域是一个数组,则要把每一个元素当做单独的域来处理。也就是说,递归地应用上述规则,对每个重要的元素计算一个散列码,然后根据步骤2.b中的做法把这些散列值组合起来。
b .按照下面的公式,把步骤2.a中计算得到的散列码c 合并到result 中:
result = 31 * result + c;
习惯用素数计算散列结果,31是奇素数,而且31有个很好的特性,即用移位和减法来代替乘法,可以得到更好的性能
第三步:返回result 值。
第四步:写完了hashCode方法之后,要写单元测试来验证相等的实例是否都具有相等的散列码。
三、计算散列码的建议
1、可以把冗余域排除在外,换句话说,如果一个域的值可以根据参与计算的其他域值计算出来,则可以排除在外。必须排除equals比较计算中没有用到的如何域。
2、如果一个类是不可变的,并且计算散列值的开销也比较大,就应该考虑把散列码缓存在对象内部,而不是每次请求的时候都重新计算散列码。
3、不要试图从散列码计算中排除掉一个对象的关键部分来提高性能。
例子:
/**
* @description:hashCode
* @author: lty
* @date: 2021/5/15 23:25
*/
public final class PhoneNumber {
private final short areaCode;
private final short prefix;
private final short lineNumber;
public PhoneNumber(short areaCode, short prefix, short lineNumber) {
rangeCheck(areaCode, 999, "area code");
rangeCheck(prefix, 999, "prefix");
rangeCheck(lineNumber, 9999, "line number");
this.areaCode = (short)areaCode;
this.prefix = (short)prefix;
this.lineNumber = (short)lineNumber;
}
private static void rangeCheck(int arg,int max,String name) {
if(arg < 0 || arg > max)
throw new IllegalArgumentException(name +": "+ arg);
}
@Override
public boolean equals(Object obj) {
//1、使用==操作符检查“参数是否为这个对象的引用”
if(obj == this)
return true;
//2、使用instanceof操作符检查“参数是否为正确的类型”
if(!(obj instanceof PhoneNumber))
return false;
//3、把参数转化成正确的类型
PhoneNumber pn = (PhoneNumber)obj;
//4、对于该类的每个“关键”域,检查参数中的域是否与该对象中对应的域相匹配(其实就是比较两个对象的值是否相等了)
return pn.lineNumber == lineNumber
&& pn.prefix == prefix
&& pn.areaCode == areaCode;
}
@Override
public int hashCode() {
//把某个非零常数值,比如说17,保存在一个名为result的int类型的变量值中
int result = 17;
//如果该域是byte、char、short 或者int 类型,则计算(int)f;
//把步骤2.a中计算得到的散列码c 合并到result 中:
// result = 31 * result + c;
result = 31 * result + areaCode;
result = 31 * result + prefix;
result = 31 * result + lineNumber;
return result;
}
}