目錄

• 一. 基礎: hashCode()和equals()簡介
• 二. 漫談: 引入hashCode()與equals()之間的關係
• 三. 解密: 深入理解hashCode()和equals()之間的關係.
• 四. 驗證: 結合HashMap的原始碼和官方文件, 驗證兩者的關係.

一. 基礎: hashCode()和equals()簡介

在學習hashCode()和equals()之間的關係之前, 我們有必要先單獨瞭解他倆自身的特點.

• equals()方法用於比較兩個物件是否相等, 它與"=="相等比較符有著本質的不同. 在萬物皆物件的Java體系中, 系統把判斷物件是否相等的權力交給程式設計師, 具體的措施是把equals()方法寫入到Object類中, 並讓所有類繼承Object類. 這樣程式設計師就能在類中自定義equals()方法, 從而實現自己的業務邏輯.
• 關於equals()和"=="的區別你可以--參考這篇文章--

• hashCode()的意思是雜湊值, 雜湊值是雜湊函式運算後得到的結果, 雜湊函式能夠保證相同的輸入能夠得到相同的輸出(雜湊值), 但是不能夠保證不同的輸入總是能得出不同的輸出. 當輸入的樣本量足夠大時, 是會產生雜湊衝突的, 也就是不同的輸入產生了相同的輸出.
• 暫且不談衝突, 就相同的輸入能夠產生相同的輸出這點而言, 是及其寶貴的. 它使得系統只需要通過簡單的運算, 在時間複雜度O(1)的情況下就能得出資料的對映關係, 根據這種特性引申出了散列表這種資料結構.
• 一種主流的散列表實現是: 用陣列作為雜湊函式的輸出域, 輸入值經過雜湊函式計算後得到雜湊值, 然後根據雜湊值在陣列種找到對應的儲存單元. 當發生衝突時, 對應的儲存單元以連結串列的形式儲存衝突的資料.

二. 漫談: 引入hashCode()與equals()之間的關係

下面我們從一個巨集觀的角度引入hashCode()和equals()之間的關係

• 在大多數程式設計實踐中, 歸根結底會落實到資料的存取問題上. 在組合語言時代, 你需要老老實實地對每個資料操作編寫存取語句; 隨著時代發展到今天, 我們都用類似Java這樣的高階語言編寫程式碼. Java除了擁有面向物件的核心思想外, 還給我們封裝了一系列操作資料的api, 為程式設計工作提供了極大的便利.
• 但在我們對資料進行操作之前, 首先要把資料按照一定的資料結構儲存到儲存單元中, 否則操作資料將無從談起. 然而不同的資料結構有各自的特點, 我們在儲存資料的時候需要選擇適合自己的資料結構進行儲存. Java根據不同的資料結構提供了豐富的容器類, 方便程式設計師選擇適合業務的容器類進行開發.
• 而Java的容器類被分為Collection和Map兩大類, Collection又可以進一步分為List和Set. 其中Map和Set都是不允許元素重複的, 嚴格來說Map儲存的是鍵值對, 它不允許重複的鍵值. 值得注意的是: Map和Set的絕大多數實現類的底層都會用到散列表結構.
• 講到這裡我們提取兩個關鍵字不允許重複和散列表結構, 回顧hashCode()和equals()的特點, 你是否想到了些什麼東西呢?

三. 解密: 深入理解hashCode()和equals()之間的關係.

• 上面提到Set和Map不存放重複的元素(key), 那麼在儲存元素的時候就必須對元素做出判斷: 在當前的容器中有沒有和新元素相同的元素?.
• 你可能會想: 這容易呀, 直接呼叫元素物件的equals()方法進行比較不就行了嗎? 如果容器中的儲存的物件數量較少, 這確實是個好主意, 但是如果容器中存放的物件達到了一定的規模, 要呼叫容器中所有物件的equals()方法和新元素進行比較就不是一件容易的事情了, 就算equals()方法的比較邏輯簡單無比, 這也是一個時間複雜度為O(n)的操作啊.

• 但在散列表的基礎上判斷"新物件是否和容器中任一物件相同"就容易得多了. 由於每個物件都自帶有hashCode(), 這個hashCode將會用作散列表雜湊函式的輸入, hashCode經過雜湊函式計算後得到雜湊值, 新物件根據雜湊值儲存到相應的記憶體的單元.
• 我們不妨假設兩個相同的物件, hashCode()一定相同, 這麼一來就體現出雜湊函式的威力了, 由於相同的輸入一定會產生相同的輸出, 於是如果新物件和容器中已存在的物件相同, 新物件計算出的雜湊值就會和已存在的物件的雜湊值產生衝突, 這時容器就能判斷: 這個新加入的元素已經存在, 需要另作處理(覆蓋掉原來的元素(key)或捨棄).
• 按照這個思路, 如果這個元素計算出的雜湊值所對應的地址沒有產生衝突, 也就是沒有重複的元素, 那麼它就可以直接插入. 所以當運用hashCode()時, 判斷是否有相同元素的代價只是一次雜湊計算, 時間複雜度為O(1), 這極大地提高了資料的儲存效能.

• 但是前面我們還提到: 當輸入樣本量足夠大時, 不相同的輸入是會產生相同輸出的, 也就是形成雜湊衝突. 這麼一來就麻煩了, 原來我們設定的"如果產生衝突, 就意味著兩個物件相同"的規則瞬間被打破, 產生衝突的很有可能是兩個不同的物件!
• 而令人欣慰的是我們除了hashCode()方法, 還有一張王牌: equals()方法. 也就是說當兩個不相同的物件產生雜湊衝突後, 我們可以用equals()方法進一步判斷兩個物件是否相同. 這時equals()方法就相當重要了, 這個情況下它必須要能判定這兩個物件是不相同的.
• 講到這裡就引出了Java程式設計中一些重要原則:
• 如果兩個物件是相等的, 它們的equals()方法應該要返回true, 它們的hashCode()需要返回相同的結果.
• 但有時候面試題不會問得這麼直接, 它會問你:兩個物件的hashCdoe()相同, 它的equals()方法一定要返回true, 對嗎?
• 那答案肯定不對. 因為我們不能保證每個程式設計者都會遵循編碼規則, 有可能兩個不同物件的hashCode()會返回相同的結果. 如果你理解上面的內容, 這個問題就很好解答: 兩個物件的hashCode()相同, 將來會在散列表中產生雜湊衝突, 但是它們不一定是相同的物件呀. 當產生雜湊衝突時, 我們還得通過equals()方法進一步判斷兩個物件是否相同, equals()方法不一定會返回true.
• 這也是為什麼Java官方推薦我們最好同時重寫hashCode()和equals()方法的原因.

四. 驗證: 結合HashMap的原始碼和官方文件, 驗證兩者的關係.

以上的文字是我經過思考後得出的, 它有一定依據但並非完全可靠, 下面我們根據HashMap的原始碼(JDK1.8)和官方文件來驗證這些推論是否正確.

• 通過閱讀JDK8的官方文件, 我們發現equals()方法介紹的最後有這麼一段話:

  Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

• 官方文件提醒我們當重寫equals方法的時候, 最好也要重寫hashCode()方法. 也就是說如果我們通過重寫equals方法判斷兩個物件相同時, 他們的hash code也應該相同, 這樣才能讓hashCode()方法發揮它的作用.
• 那它究竟能發會怎樣的作用呢? 我們結合部分較為常用的HashMap原始碼進一步分析. (像HashSet底層也是通過HashMap實現)

• 在HashMap中用得最多無疑是put()方法了, 以下是put()的原始碼:

public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}

• 我們可以看到put()方法實際呼叫的是putVal()方法, 繼續跟進:

    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    //在我們建立HashMap物件的時候, 記憶體中並沒有為HashMap分配表的空間, 直到往HashMap中put新增元素的時候才呼叫resize()方法初始化表
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;//同時確定了表的長度
        
    //((n - 1) & hash)確定了要put的元素的位置, 如果要插入的地方是空的, 就可以直接插入.
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    else {//如果發生了衝突, 就要在衝突位置的連結串列末尾插入元素
        Node<K,V> e; K k;
        if (p.hash == hash &&   
            ((k = p.key) == key || (key != null && key.equals(k))))
            //關鍵!!!當判斷新加入的元素是否與已有的元素相同, 首先判斷的是hash值, 後面再呼叫equals()方法. 如果hash值不同是直接跳過的
            e = p;
        else if (p instanceof TreeNode)//如果衝突解決方案已經變成紅黑樹的話, 按紅黑樹的策略新增結點. 
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {//解決衝突的方式仍是連結串列
            for (int binCount = 0; ; ++binCount) {//找到連結串列的末尾, 插入.
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        treeifyBin(tab, hash);//插入之後要判斷連結串列的長度, 如果到達一定的值就可能要轉換為紅黑樹. 
                    break;
                }//在遍歷的過程中仍會不停地判定當前key是否與傳入的key相同, 判斷的第一條件仍然是hash值. 
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;//修改map的次數增加
    if (++size > threshold)//如果hashMap的容量到達了一定值就要進行擴容
        resize();
    afterNodeInsertion(evict);
    return null;
}

• 我們可以看到每當判斷key是否相同的是否, 首先會判斷hash值, 如果hash值相同(產生了衝突), 然後會判斷key引用所指的物件是否相同, 最終會通過equals()方法作最後的判定.
• 如果key的hash值不同, 後面的判斷將不會執行, 直接認定兩個物件不相同.

if (p.hash == hash &&
    ((k = p.key) == key || (key != null && key.equals(k))))
    e = p;

結束

• 講到這裡希望大家對hashCode()與equals()方法能有更深入的理解, 明白背後的設計思想與原理.
• 我之前有一個疑問, 可能大家看完這篇文章後也會有: equals()方法平時我會用到, 所以我知道它除了和hashCode()方法有密切聯絡外, 還有別的用途. 但是hashCode()呢, 它除了和equals()方法有密切聯絡外, 還有其他用途嗎?
• 經過在網際網路上一番搜尋, 我目前給出的答案是沒有. 也就是說hashCode()僅在散列表中才有用，在其它情況下沒用.
• 當然如果這個答案不正確, 或者你還有別的思考, 歡迎留言與我交流~

• 最後歡迎關注我的免費知識星球, 我會在星球中持續更新系統的Java後端面試題分析, 將會囊括Java基礎知識到主流框架原理. 還會分享關於程式設計的趣味漫畫.