java自定義equals函數和hashCode函數

 

所有類都繼承自Object類，他所有的非final方法：equals，hashCode, toString, clone 和 finalize，它們都有通用約定。 我們在覆蓋這些方法的時候需要遵循這些約定，否則依賴這些約定的類（例如HashMap和HashSet）就無法結合該類一起工作了。

 

一. equals

相等的概念：

• 邏輯相等：例如Integer中包含的數值相等，我們就認為這兩個Integer相等。 再比如AbstractList中如果兩個list包含的所有元素相等則兩個List相等。
• 真正意義上的相等：指向同一個對象。

如果不重載equals函數，那么兩個類的相等只能是真正意義上的equal。如果類想要自己的相等邏輯就需要像Integer/List那樣重載equals函數。

 

java規范中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)應該返回同樣的結果.
• 對任意非空引用x, x.equals(null) 返回false;

下面可以通過兩個不同的情況看待這個問題:

• 如果子類能夠擁有自己的相等概念, 則對稱性需求強制采用getClass進行檢測
• 如果由超類決定相等的概念, 那么就用instanceof進行檢測,這樣可以在不用子類的對象之間進行相等的比較

 

TimeStamp的不對稱性

Date date = new Date();
Timestamp t1 = new Timestamp(date.getTime());

System.out.println("Date equals Timestamp ? : " +  date.equals(t1));// true
System.out.println("Timestamp equals Date ? : " +  t1.equals(date));// false

 

TimeStamp源碼：（使用了instanceof 而不是 getClass()）

    // Timestamp
    @Override
    public boolean equals(java.lang.Object ts) {
        if (ts instanceof Timestamp) {
            return this.equals((Timestamp)ts);
        } else {
            return false;// 非Timestamp 實例直接返回false
        }
    }
    // 省略其他代碼
    public boolean equals(Timestamp ts) {
        if (super.equals(ts)) {
            if  (nanos == ts.nanos) {
                return true;
            } else {
                return false;
            }
        } else {
            return false;
        }
    }

父類Date：

    // Date
    @Override
    public boolean equals(Object obj) {
        return obj instanceof Date && getTime() == ((Date) obj).getTime();
    }

 

備注:

1. 在標准的java庫中包含150多個equals方法的實現,包括instanceof檢測, 調用getClass檢測, 捕獲ClassCastException檢測或者什么都不做. 在java.sql.TimeStamp實現人員指出, Timestamp類繼承Date類,而后者的equals方法使用了一個instanceof檢測,這樣重寫equals方法時,就無法同時做到對稱性.
2. 在由超類決定相等時,可以考慮final關鍵字修改比較函數,若考慮到子類equals方法靈活性,可以不加修飾,例如AbstractSet.equals方法,應該申明為final, 這樣就可以比較子類HashSet和TreeSet, 但是考慮到子類的靈活性,沒有添加任何修飾.

 

編寫equals方法的建議:

1. 顯示參數命名為otherObject, 稍后轉化成other變量

   public boolean equals(Object otherObject)

2. 檢測this和otherObject是否是同一個對象的引用,是,返回true;

   if(this==otherObject){
   return true;
   }

3. 檢測otherObject是否為null, 是, 返回false;

   if(otherObject == null){
   return false;
   }

4. 比較this和otherObject是否屬於同一個類. 如果equals的語義在每個子類中有所改變,就使用getClass檢測:

   if(getClass() != otherObject.getClass()){
   return false;
   }

   如果所以子類語義相同,使用instanceof檢測:

   if(!(otherObject instanceof Employee)){
   return false;
   }

    

5. 將otherObject轉化為相對應的類型變量other

   Employee other = (Employee)otherObject;

6. 對所需要的比較的數據域進行比較. 如果是基本數據類型,使用a==b比較; 如果是對象比較,調用Objects.equals(a, b)進行比較

   return Objects.equals(name, other.name) && salary == other.salary && Objects.equals(hireDay, other.hireDay);

 

二、hashCode()

設計原則中有一條： 覆蓋equals時總要覆蓋hashCode

hashCode編碼原則：

1.只要對象equals方法的比較操作所用到的信息沒有被修改，對同一對象調用多次，hashCode方法都必須返回同一整數。在同一應用程序的多次執行過程中，每次執行返回的整數可以不一致。

2.如果兩個對象根據equals(Object)方法比較是相等的，那么這兩個對象的hashCode返回值相同。

3.如果兩個對象根據equals(Object)方法比較是不等的，那么這兩個對象的hashCode返回值不一定不等，但是給不同的對象產生截然不同的整數結果，能提高散列表的性能。

具體實例

如果一個類覆蓋了equals覆蓋了equals函數，卻沒有覆蓋hashCode會違反上述第二條原則。下面看一下沒有重載hashCode的例子：

public class PhoneNumber {
    private final int areaCode;
    private final int prefix;
    private final int 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 = areaCode;
        this.prefix = prefix;
        this.lineNumber = 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;
    }

}

執行如下代碼：

Map<PhoneNumber, String> map = new HashMap<PhoneNumber, String>();
map.put(new PhoneNumber(707, 867, 5309), "Jenny");
System.out.println(map.get(new PhoneNumber(707, 867, 5309)));

我們期望它返回Jenny，然而它返回的是null。

原因在於違反了hashCode的約定，由於PhoneNumber沒有覆蓋hashCode方法，導致兩個相等的實例擁有不相等的散列碼，put方法把電話號碼對象放在一個散列桶中，get方法從另外一個散列桶中查找這個電話號碼的所有者，顯然是無法找到的。

只要覆蓋hashCode並遵守約定，就能修正這個問題。

 

一個好的散列函數傾向於“為不相等的對象產生不相等的散列碼”，下面有簡單的解決辦法：

1.把某個非零的常數值，如17，保存在一個名為result的int類型的變量中。（為了2.a中計算的散列值為0的初始域會影響到散列值）

2.對於對象中的每個關鍵域f，完成一下步驟：

　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)，然后

  vi.如果該域是一個對象引用，並且該類的equals方法通過遞歸地調用equals的方式來比較這個域，則同樣為這個域遞歸地調用hashCode。如果需要更復雜的比較，則為這個域計算一個“范式”，然后針對這個“范式”調用hashCode。如果域的值為null，則返回0（或其他某個常數，但通常為0）。

　　vii.如果該域是一個數組，則要吧每一個元素當做單獨的域來處理，也就是要遞歸地應用上述規則，對每個重要的元素計算一個散列碼，然后根據2.b把這些散列值組合起來。如果數組域中的每個元素都很重要，可以使用1.5中增加的其中一個Array.hashCode方法。

　b.按照下面的公式，把步驟2.a中計算得到的散列碼c合並到result中：

　　result = 31　* result + c。（選擇31是因為它是一個奇素數，如果乘數是偶數，乘法溢出時會丟失信息，VM可以優化 31 * i == （i << 5） - i）

3.返回result。

編寫完hashCode方法后，編寫單元測試來驗證相同的實例是否有相等的散列碼。

把上面的解決方法應用到PhoneNumber類中：

@Override
public int hashCode() {
    int result = 17;
    result = 31 * result + areaCode;
    result = 31 * result + prefix;
    result = 31 * result + lineNumber;
    return result;
}

現在使用之前的測試代碼，發現能夠返回Jenny了。