詳解equals()方法和hashCode()方法

前言

Java的基類Object提供了一些方法，其中equals()方法用於判斷兩個對象是否相等，hashCode()方法用於計算對象的哈希碼。equals()和hashCode()都不是final方法，均可以被重寫(overwrite)。

本文介紹了2種方法在使用和重寫時，一些須要注意的問題。

若是以爲文章對你有幫助，歡迎點贊或轉載。文章有疏漏之處，歡迎批評指正。

1、equal()方法

 Object類中equals()方法實現以下：

public boolean equals(Object obj) {
    return (this == obj);
}

經過該實現能夠看出，Object類的實現採用了區分度最高的算法，即只要兩個對象不是同一個對象，那麼equals()必定返回false。

雖然咱們在定義類時，能夠重寫equals()方法，可是有一些注意事項；JDK中說明了實現equals()方法應該遵照的約定：

（1）自反性：x.equals(x)必須返回true。

（2）對稱性：x.equals(y)與y.equals(x)的返回值必須相等。

（3）傳遞性：x.equals(y)爲true，y.equals(z)也爲true，那麼x.equals(z)必須爲true。

（4）一致性：若是對象x和y在equals()中使用的信息都沒有改變，那麼x.equals(y)值始終不變。

（5）非null：x不是null，y爲null，則x.equals(y)必須爲false。

2、hashCode()方法

一、Object的hashCode()

Object類中hashCode()方法的聲明以下：

public native int hashCode();

能夠看出，hashCode()是一個native方法，並且返回值類型是整形；實際上，該native方法將對象在內存中的地址做爲哈希碼返回，能夠保證不一樣對象的返回值不一樣。

與equals()方法相似，hashCode()方法能夠被重寫。JDK中對hashCode()方法的做用，以及實現時的注意事項作了說明：

（1）hashCode()在哈希表中起做用，如java.util.HashMap。

（2）若是對象在equals()中使用的信息都沒有改變，那麼hashCode()值始終不變。

（3）若是兩個對象使用equals()方法判斷爲相等，則hashCode()方法也應該相等。

（4）若是兩個對象使用equals()方法判斷爲不相等，則不要求hashCode()也必須不相等；可是開發人員應該認識到，不相等的對象產生不相同的hashCode能夠提升哈希表的性能。

二、hashCode()的做用

總的來講，hashCode()在哈希表中起做用，如HashSet、HashMap等。

當咱們向哈希表(如HashSet、HashMap等)中添加對象object時，首先調用hashCode()方法計算object的哈希碼，經過哈希碼能夠直接定位object在哈希表中的位置(通常是哈希碼對哈希表大小取餘)。若是該位置沒有對象，能夠直接將object插入該位置；若是該位置有對象(可能有多個，經過鏈表實現)，則調用equals()方法比較這些對象與object是否相等，若是相等，則不須要保存object；若是不相等，則將該對象加入到鏈表中。

這也就解釋了爲何equals()相等，則hashCode()必須相等。若是兩個對象equals()相等，則它們在哈希表(如HashSet、HashMap等)中只應該出現一次；若是hashCode()不相等，那麼它們會被散列到哈希表的不一樣位置，哈希表中出現了不止一次。

實際上，在JVM中，加載的對象在內存中包括三部分：對象頭、實例數據、填充。其中，對象頭包括指向對象所屬類型的指針和MarkWord，而MarkWord中除了包含對象的GC分代年齡信息、加鎖狀態信息外，還包括了對象的hashcode；對象實例數據是對象真正存儲的有效信息；填充部分僅起到佔位符的做用, 緣由是HotSpot要求對象起始地址必須是8字節的整數倍。

3、String中equals()和hashCode()的實現

String類中相關實現代碼以下：

private final char value[];
private int hash; // Default to 0
public boolean equals(Object anObject) {
    if (this == anObject) {
        return true;
    }
    if (anObject instanceof String) {
        String anotherString = (String)anObject;
        int n = value.length;
        if (n == anotherString.value.length) {
            char v1[] = value;
            char v2[] = anotherString.value;
            int i = 0;
            while (n-- != 0) {
                if (v1[i] != v2[i])
                    return false;
                i++;
            }
            return true;
        }
    }
    return false;
}
public int hashCode() {
    int h = hash;
    if (h == 0 && value.length > 0) {
        char val[] = value;
 
        for (int i = 0; i < value.length; i++) {
            h = 31 * h + val[i];
        }
        hash = h;
    }
    return h;
}

經過代碼能夠看出如下幾點：

一、String的數據是final的，即一個String對象一旦建立，便不能修改；形如String s = "hello"; s = "world";的語句，當s = "world"執行時，並非字符串對象的值變爲了"world"，而是新建了一個String對象，s引用指向了新對象。

二、String類將hashCode()的結果緩存爲hash值，提升性能。

三、String對象equals()相等的條件是兩者同爲String對象，長度相同，且字符串值徹底相同；不要求兩者是同一個對象。

四、String的hashCode()計算公式爲：s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]

關於hashCode()計算過程當中，爲何使用了數字31，主要有如下緣由：

一、使用質數計算哈希碼，因爲質數的特性，它與其餘數字相乘以後，計算結果惟一的機率更大，哈希衝突的機率更小。

二、使用的質數越大，哈希衝突的機率越小，可是計算的速度也越慢；31是哈希衝突和性能的折中，其實是實驗觀測的結果。

三、JVM會自動對31進行優化：31 * i == (i << 5) - i

 4、如何重寫hashCode()

本節先介紹重寫hashCode()方法應該遵照的原則，再介紹通用的hashCode()重寫方法。

一、重寫hashcode()的原則

經過前面的描述咱們知道，重寫hashCode須要遵照如下原則：

（1）若是重寫了equals()方法，檢查條件「兩個對象使用equals()方法判斷爲相等，則hashCode()方法也應該相等」是否成立，若是不成立，則重寫hashCode ()方法。

（2）hashCode()方法不能太過簡單，不然哈希衝突過多。

（3）hashCode()方法不能太過複雜，不然計算複雜度太高，影響性能。

二、hashCode()重寫方法

《Effective Java》中提出了一種簡單通用的hashCode算法
A、初始化一個整形變量，爲此變量賦予一個非零的常數值，好比int result = 17;
B、選取equals方法中用於比較的全部域（之因此只選擇equals()中使用的域，是爲了保證上述原則的第1條），而後針對每一個域的屬性進行計算：
(1) 若是是boolean值，則計算f ? 1:0
(2) 若是是byte\char\short\int,則計算(int)f
(3) 若是是long值，則計算(int)(f ^ (f >>> 32))
(4) 若是是float值，則計算Float.floatToIntBits(f)
(5) 若是是double值，則計算Double.doubleToLongBits(f)，而後返回的結果是long,再用規則(3)去處理long,獲得int
(6) 若是是對象應用，若是equals方法中採起遞歸調用的比較方式，那麼hashCode中一樣採起遞歸調用hashCode的方式。不然須要爲這個域計算一個範式，好比當這個域的值爲null的時候，那麼hashCode 值爲0
(7) 若是是數組，那麼須要爲每一個元素當作單獨的域來處理。java.util.Arrays.hashCode方法包含了8種基本類型數組和引用數組的hashCode計算，算法同上。 
C、最後，把每一個域的散列碼合併到對象的哈希碼中。

下面經過一個例子進行說明。在該例中，Person類重寫了equals()方法和hashCode()方法。由於equals()方法中只使用了name域和age域，因此hashCode()方法中，也只計算name域和age域。

對於String類型的name域，直接使用了String的hashCode()方法；對於int類型的age域，直接用其值做爲該域的hash。

public class Person {
    private String name;
    private int age;
    private boolean gender;
 
    public Person() {
        super();
    }
 
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public boolean isGender() {
        return gender;
    }
    public void setGender(boolean gender) {
        this.gender = gender;
    }
 
    @Override
    public boolean equals(Object another) {
        if (this == another) {
            return true;
        }
        if (another instanceof Person) {
            Person anotherPerson = (Person) another;
            if (this.getName().equals(anotherPerson.getName()) && this.getAge() == anotherPerson.getAge()) {
                return true;
            } else {
                return false;
            }
        }
        return false;
    }
 
    @Override
    public int hashCode() {
        int hash = 17;
        hash = hash * 31 + getName().hashCode();
        hash = hash * 31 + getAge();
        return hash;
    }
}