任何覆盖了equals方法的类都需要覆盖hashCode方法。
忽视这一条将导致类无法与基于散列的数据结构一起正常工作,比如和HashMap、HashSet和Hashtable。
下面是hashCode相关规范:
·在程序执行期间,只要对象的equals方法的比较操作所用到的信息没有被修改,那么对这个对象调用多少次hashCode,起结果必须始终如一地返回同一个证书。
如果是同一个程序执行多次,每次调用的结果可以不一致。
·如果两个对象根据equals方法比较是相等的,那么两个对象的hashCode结果必须相同。
·如果两个对象根据equals方法比较是不相等的,那么这两个对象的hashCode不一定返回不同的结果。
但是,如果不同的对象返回不同的hashCode,则能提高散列表的性能。
下面的代码就是一个反面例子:
// Shows the need for overriding hashcode when you override equals - Pages 45-46 import java.util.HashMap; import java.util.Map; public final class PhoneNumber { private final short areaCode; private final short prefix; private final short lineNumber; public PhoneNumber(int areaCode, int prefix, int 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 o) { if (o == this) return true; if (!(o instanceof PhoneNumber)) return false; PhoneNumber pn = (PhoneNumber) o; return pn.lineNumber == lineNumber && pn.prefix == prefix && pn.areaCode == areaCode; } // Broken - no hashCode method! // A decent hashCode method - Page 48 // @Override public int hashCode() { // int result = 17; // result = 31 * result + areaCode; // result = 31 * result + prefix; // result = 31 * result + lineNumber; // return result; // } public static void main(String[] args) { Map<PhoneNumber, String> m = new HashMap<PhoneNumber, String>(); m.put(new PhoneNumber(707, 867, 5309), "Jenny"); System.out.println(m.get(new PhoneNumber(707, 867, 5309))); } }
通过equals方法比较,两个实例在逻辑上是相等的。
但由于没有覆盖hashCode方法,两个实例返回的hashCode是不同的。
在散列表中,如果散列码不匹配,就不必检查两个实例是否相等。
如果随便提供这样的一个hashCode方法:
public int hashCode(){ return 42; }
这样会让散列表失去优势,退化为链表。
最好的hashCode应该是<不同的对象产生不同的散列码>。
即,散列函数把集合中不同的实例均匀地分布到所有可能的散列值上。
下面是一种简单的思路(也就是上面例子中注释的部分):
- 把一个非零常数值放在result变量中。
- 针对每一个关键的field(假设变量名为f)计算int类型的散列码,不同类型有不同的计算方式。
boolean:f?1:0
byte,short,char:(int)f
long:(int)(f^(f>>>32))
float:Float.floatToIntBits(f)
double:Double.doubleToIntBits(f)
引用:递归调用hashCode
数组:每个元素作为一个field遵循上述规则
- 对计算出的散列码值c进行:result = result*31+c;
- 重复测试。
如果一个类是不可变的,而且计算散列值的开销比较大,我们可以试着将散列值缓存。
或者我们也可以试试延迟初始化,在hashCode第一次被调用时进行初始化:
private volatile int hashCode; // (See Item 71) @Override public int hashCode() { int result = hashCode; if (result == 0) { result = 17; result = 31 * result + areaCode; result = 31 * result + prefix; result = 31 * result + lineNumber; hashCode = result; } return result; }
Effective Item 6 - 覆盖equals方法时不要忘记hashCode方法