equals方法和hashCode方法均是Object對象的方法。Object中關于hashCode約定的規范如下:
- 在應用程序的執行期間,只要對象的equals方法的比較操作所用到的信息沒有被修改,那么對同一個對象調用多次,hashCode方法都必須始終如一地返回同一個整數。在同一個應用程序的多次執行過程中,每次執行所返回的整數可以不一致。
2.如果兩個對象根據equals(Object)方法比較是相等的,那么調用這兩個對象中任意一個對象的hashCode方法都必須產生同樣的整數結果。
3.如果兩個對象根據equals(Object)方法比較是不相等的,那么調用這兩個對象中任意一個對象的hashCode方法,則不一定要產生不同的整數結果。但是程序員應該知道,給不相等的對象產生截然不同的整數結果,有可能提高散列表(hash table)的性能。
如果某個類違反Object的hashCode的通用約定,會導致該類無法結合所有基于散列的集合一起正常運轉,如:HashMap、HashSet和HashTable。
覆蓋equals方法而沒有覆蓋hashCode方法違反了約定的第2條:相等的對象必須具有相等的散列碼。
如下示例:
package com.wuyafu.java.effective.hashcode;
import java.util.HashMap;
import java.util.Map;
public 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, "lineNumber");
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;
}
/**
* @param args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub
Map<PhoneNumber, String> m =
new HashMap<PhoneNumber, String>();
m.put(new PhoneNumber(408, 867, 5309), "Jenny");
System.out.println(m.get(new PhoneNumber(408, 867, 5309)));
}
}
由于PhoneNumber類沒有覆蓋hashCode方法,從而導致兩個相等的實例具有不相等的散列碼,違反了hashCode的約定。
為解決這個問題,只需為PhoneNumber類提供一個適當的hashCode方法即可。
如下:
@Override
public int hashCode(){return 42;}
該方法確保了相等的對象總是具有同樣的散列碼。但是它也極為惡劣,因為它使得每個對象都具有同樣的散列碼。因此每個對象都被映射到同一個散列桶中,使散列表退化為鏈表。
一個好的散列函數通常傾向于“為不相等的對象產生不相等的散列碼”,散列函數應該把集合中不相等的實例均勻地分布到所有可能的散列值上。實現這種理想狀態很難,但如下方法可以接近理想狀態:
在散列碼的計算過程中,可以把冗余域排除在外。
在公式中result不能為0,17為任意選的值。
31為奇素數,有更好的性能
利用上述接近辦法,修改PhoneNumber類的hashCode方法如下:
@Override
public int hashCode(){
int result = 17;
result = 31 * result + areaCode;
result = 31 * result + prefix;
result = 31 * result + lineNumber;
return result;
}
如果一個類是不可變的,并且計算散列碼的開銷也比較大,就應該考慮把散列碼緩存在對象內部,而不是每次請求的時候都重新計算散列碼。可以通過“延遲初始化”散列碼的方式來實現,修改PhoneNumber類的hashCode方法如下:
private volatile int hashCode;
@Override
public int hashCode(){
int result = hashCode;
if (result == 0) {
result = 17;
result = 31* result + areaCode;
result = 31* result + prefix;
result = 31* result + lineNumber;
}
}
總結:當覆蓋equals方法時,要覆蓋hashCode方法,并且采用公式來將對象的關鍵域參與到散列碼的計算中,確保不相同的對象在不同的散列桶中。若該類是不可變的,可以考慮使用“延遲初始化”散列碼的方式。