【Java筆記】高級教程之常見的數據結構的Java實現2 HashCode

參考博客：關於hashCode方法的作用

目的：HashCode是用來解決Java集合中的元素不可重複的問題。

Java中的集合（Collection）有兩類，一類是List，再有一類是Set。 你知道它們的區別嗎？前者集合內的元素是有序的，元素可以重複；後者元素無序，但元素不可重複。

那麼這裏就有一個比較嚴重的問題了：要想保證元素不重複，可兩個元素是否重複應該依據什麼來判斷呢？
這就是Object.equals方法了。但是，如果每增加一個元素就檢查一次，那麼當元素很多時，後添加到集合中的元素比較的次數就非常多了。
也就是說，如果集合中現在已經有1000個元素，那麼第1001個元素加入集合時，它就要調用1000次equals方法。這顯然會大大降低效率。
於是，Java採用了哈希表的原理。哈希（Hash）實際上是個人名，由於他提出一哈希算法的概念，所以就以他的名字命名了。
哈希算法也稱爲散列算法，是將數據依特定算法直接指定到一個地址上。如果詳細講解哈希算法，那需要更多的文章篇幅，我在這裏就不介紹了。
初學者可以這樣理解，hashCode方法實際上返回的就是對象存儲的物理地址（實際可能並不是）。
這樣一來，當集合要添加新的元素時，先調用這個元素的hashCode方法，就一下子能定位到它應該放置的物理位置上。
如果這個位置上沒有元素，它就可以直接存儲在這個位置上，不用再進行任何比較了；如果這個位置上已經有元素了，
就調用它的equals方法與新元素進行比較，相同的話就不存了，不相同就散列其它的地址。
所以這裏存在一個衝突解決的問題。這樣一來實際調用equals方法的次數就大大降低了，幾乎只需要一兩次。

具體執行順序可以看我的上一篇博客中的思維導圖：執行順序

根據官方文檔的定義，我們可以抽出成以下幾個關鍵點：

1、hashCode的存在主要是用於查找的快捷性，如Hashtable，HashMap等，hashCode是用來在散列存儲結構中確定對象的存儲地址的；

2、如果兩個對象相同，就是適用於equals(Java.lang.Object) 方法，那麼這兩個對象的hashCode一定要相同；

3、如果對象的equals方法被重寫，那麼對象的hashCode也儘量重寫，並且產生hashCode使用的對象，一定要和equals方法中使用的一致，否則就會違反上面提到的第2點；

4、兩個對象的hashCode相同，並不一定表示兩個對象就相同，也就是不一定適用於equals(java.lang.Object) 方法，只能夠說明這兩個對象在散列存儲結構中，如Hashtable，他們“存放在同一個籃子裏”。

再歸納一下就是hashCode是用於查找使用的，而equals是用於比較兩個對象的是否相等的。

1.hashcode是用來查找的，如果你學過數據結構就應該知道，在查找和排序這一章有
例如內存中有這樣的位置
0  1  2  3  4  5  6  7  
而我有個類，這個類有個字段叫ID,我要把這個類存放在以上8個位置之一，如果不用hashcode而任意存放，那麼當查找時就需要到這八個位置裏挨個去找，或者用二分法一類的算法。
但如果用hashcode那就會使效率提高很多。
我們這個類中有個字段叫ID,那麼我們就定義我們的hashcode爲ID％8，然後把我們的類存放在取得得餘數那個位置。比如我們的ID爲9，9除8的餘數爲1，那麼我們就把該類存在1這個位置，如果ID是13，求得的餘數是5，那麼我們就把該類放在5這個位置。這樣，以後在查找該類時就可以通過ID除 8求餘數直接找到存放的位置了。

2.但是如果兩個類有相同的hashcode怎麼辦那（我們假設上面的類的ID不是唯一的），例如9除以8和17除以8的餘數都是1，那麼這是不是合法的，回答是：可以這樣。那麼如何判斷呢？在這個時候就需要定義 equals了。
也就是說，我們先通過 hashcode來判斷兩個類是否存放某個桶裏，但這個桶裏可能有很多類，那麼我們就需要再通過 equals 來在這個桶裏找到我們要的類。
那麼。重寫了equals()，爲什麼還要重寫hashCode()呢？
想想，你要在一個桶裏找東西，你必須先要找到這個桶啊，你不通過重寫hashcode()來找到桶，光重寫equals()有什麼用啊

具體示例：

public class HashTest {
    private int i;

    public int getI() {
        return i;
    }

    public void setI(int i) {
        this.i = i;
    }

    public int hashCode() {
        return i % 10;
    }

    public final static void main(String[] args) {
        HashTest a = new HashTest();
        HashTest b = new HashTest();
        a.setI(1);
        b.setI(1);
        Set<HashTest> set = new HashSet<HashTest>();
        set.add(a);
        set.add(b);
        System.out.println(a.hashCode() == b.hashCode());
        System.out.println(a.equals(b));
        System.out.println(set);
    }
}

結果：

true
false
[com.ubs.sae.test.HashTest@1, com.ubs.sae.test.HashTest@1]

以上這個示例，我們只是重寫了hashCode方法，從上面的結果可以看出，雖然兩個對象的hashCode相等，但是實際上兩個對象並不是相等；，我們沒有重寫equals方法，那麼就會調用object默認的equals方法，是比較兩個對象的引用是不是相同，顯示這是兩個不同的對象，兩個對象的引用肯定是不定的。這裏我們將生成的對象放到了HashSet中，而HashSet中只能夠存放唯一的對象，也就是相同的（適用於equals方法）的對象只會存放一個，但是這裏實際上是兩個對象a,b都被放到了HashSet中，這樣HashSet就失去了他本身的意義了。
此時我們把equals方法給加上：

public class HashTest {
    private int i;

    public int getI() {
        return i;
    }

    public void setI(int i) {
        this.i = i;
    }

    public boolean equals(Object object) {
        if (object == null) {
            return false;
        }
        if (object == this) {
            return true;
        }
        if (!(object instanceof HashTest)) {
            return false;
        }
        HashTest other = (HashTest) object;
        if (other.getI() == this.getI()) {
            return true;
        }
        return false;
    }

    public int hashCode() {
        return i % 10;
    }

    public final static void main(String[] args) {
        HashTest a = new HashTest();
        HashTest b = new HashTest();
        a.setI(1);
        b.setI(1);
        Set<HashTest> set = new HashSet<HashTest>();
        set.add(a);
        set.add(b);
        System.out.println(a.hashCode() == b.hashCode());
        System.out.println(a.equals(b));
        System.out.println(set);
    }
}

結果

true
true
[com.ubs.sae.test.HashTest@1]

從結果我們可以看出，現在兩個對象就完全相等了，HashSet中也只存放了一份對象。