?核心問(wèn)題：重寫(xiě)了equals方法，為什么還要重寫(xiě)hashCode方法？

這不僅僅是一道面試題，而且是關(guān)系到我們的代碼是否健壯和正確的問(wèn)題。在前面兩篇文章涉及到了equals方法的底層講解：《說(shuō)說(shuō)==和equals的區(qū)別？你的回答可能是錯(cuò)誤的》和《Integer等號(hào)判斷的內(nèi)幕，你可能不知道？》。

本篇文章，帶大家從底層來(lái)分析一下hashcode方法重寫(xiě)的意義以及如何實(shí)現(xiàn)。

回顧equals方法

我們先回顧一下Object的equals方法實(shí)現(xiàn)，并簡(jiǎn)單匯總一下使用equals方法的規(guī)律。

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

通過(guò)上面Object的源代碼，可以得出一個(gè)結(jié)論：如果一個(gè)類(lèi)未重寫(xiě)equals方法，那么本質(zhì)上通過(guò)“==”和equals方法比較的效果是一樣的，都是比較兩個(gè)對(duì)象的的內(nèi)存地址。

前面兩篇文章講到String和Integer在比較時(shí)的區(qū)別，關(guān)鍵點(diǎn)也是它們對(duì)equals方法的實(shí)現(xiàn)。

面試時(shí)總結(jié)一下就是：默認(rèn)情況下，從Object類(lèi)繼承的equals方法與“==”完全等價(jià)，比較的都是對(duì)象的內(nèi)存地址。但我們可以重寫(xiě)equals方法，使其按照需要進(jìn)行比較，如String類(lèi)重寫(xiě)了equals方法，比較的是字符的序列，而不再是內(nèi)存地址。

與hashCode方法的關(guān)系

那么equals方法與hashCode方法又有什么關(guān)系呢？我們來(lái)看Object上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.

大致意思是：當(dāng)重寫(xiě)equals方法后有必要將hashCode方法也重寫(xiě)，這樣做才能保證不違背hashCode方法中“相同對(duì)象必須有相同哈希值”的約定。

此處只是提醒了我們重寫(xiě)hashCode方法的必要性，那其中提到的hashCode方法設(shè)計(jì)約定又是什么呢？相關(guān)的內(nèi)容定義在hashCode方法的注解部分。

hashCode方法約定

關(guān)于hashCode方法的約定原文比較多，大家直接看源碼即可看到，這里匯總一下，共三條：

（1）如果對(duì)象在使用equals方法中進(jìn)行比較的參數(shù)沒(méi)有修改，那么多次調(diào)用一個(gè)對(duì)象的hashCode()方法返回的哈希值應(yīng)該是相同的。

（2）如果兩個(gè)對(duì)象通過(guò)equals方法比較是相等的，那么要求這兩個(gè)對(duì)象的hashCode方法返回的值也應(yīng)該是相等的。

（3）如果兩個(gè)對(duì)象通過(guò)equals方法比較是不同的，那么也不要求這兩個(gè)對(duì)象的hashCode方法返回的值是不相同的。但是我們應(yīng)該知道對(duì)于不同對(duì)象產(chǎn)生不同的哈希值對(duì)于哈希表(HashMap等)能夠提高性能。

其實(shí)，看到這里我們了解了hashCode的實(shí)現(xiàn)規(guī)約，但還是不清楚為什么實(shí)現(xiàn)equals方法需要重寫(xiě)hashCode方法。但我們可以得出一條規(guī)律：hashCode方法實(shí)際上必須要完成的一件事情就是，為equals方法認(rèn)定為相同的對(duì)象返回相同的哈希值。

其實(shí)在上面規(guī)約中提到了哈希表，這也正是hashCode方法運(yùn)用的場(chǎng)景之一，也是我們?yōu)槭裁匆貙?xiě)的核心。

hashCode應(yīng)用場(chǎng)景

如果了解HashMap的數(shù)據(jù)結(jié)構(gòu)，就會(huì)知道它用到“鍵對(duì)象”的哈希碼，當(dāng)我們調(diào)用put方法或者get方法對(duì)Map容器進(jìn)行操作時(shí)，都是根據(jù)鍵對(duì)象的哈希碼來(lái)計(jì)算存儲(chǔ)位置的。如果我們對(duì)哈希碼的獲取沒(méi)有相關(guān)保證，就可能會(huì)得不到預(yù)期的結(jié)果。

而對(duì)象的哈希碼的獲取正是通過(guò)hashCode方法獲取的。如果自定義的類(lèi)中沒(méi)有實(shí)現(xiàn)該方法，則會(huì)采用Object中的hashCode()方法。

在Object中該方法是一個(gè)本地方法，會(huì)返回一個(gè)int類(lèi)型的哈希值?？梢酝ㄟ^(guò)將對(duì)象的內(nèi)部地址轉(zhuǎn)換為整數(shù)來(lái)實(shí)現(xiàn)的，但是Java中沒(méi)有強(qiáng)制要求通過(guò)該方式實(shí)現(xiàn)。

具體實(shí)現(xiàn)網(wǎng)絡(luò)上有不同的說(shuō)法，有說(shuō)通過(guò)內(nèi)置地址轉(zhuǎn)換得來(lái)，也有說(shuō)“OpenJDK8默認(rèn)hashCode的計(jì)算方法是通過(guò)和當(dāng)前線程有關(guān)的一個(gè)隨機(jī)數(shù)+三個(gè)確定值，運(yùn)用Marsaglia's xorshift scheme隨機(jī)數(shù)算法得到的一個(gè)隨機(jī)數(shù)”獲得。

無(wú)論默認(rèn)實(shí)現(xiàn)是怎樣的，大多數(shù)情況下都無(wú)法滿足equals方法相同，同時(shí)hashCode結(jié)果也相同的條件。比如下面的示例重寫(xiě)與否差距很大。

public void test1() {  String s = "ok";  StringBuilder sb = new StringBuilder(s);  System.out.println(s.hashCode() + "  " + sb.hashCode());
  String t = new String("ok");  StringBuilder tb = new StringBuilder(s);  System.out.println(t.hashCode() + "  " + tb.hashCode());}

上面這段代碼打印的結(jié)果為：

3548  1833638914
3548  1620303253

String實(shí)現(xiàn)了hashCode方法，而StringBuilder并沒(méi)有實(shí)現(xiàn)，這就導(dǎo)致即使值是一樣的，hashCode也不同。

上個(gè)示例中問(wèn)題還不太明顯，下面我們以HashMap為例，看看如果沒(méi)有實(shí)現(xiàn)hashCode方法會(huì)導(dǎo)致什么嚴(yán)重的后果。

@Testpublic void test2() {  String hello = "hello";
  Map map1 = new HashMap<>();  String s1 = new String("key");  String s2 = new String("key");  map1.put(s1, hello);  System.out.println("s1.equals(s2):" + s1.equals(s2));  System.out.println("map1.get(s1):" + map1.get(s1));  System.out.println("map1.get(s2):" + map1.get(s2));

  Map map2 = new HashMap<>();  Key k1 = new Key("A");  Key k2 = new Key("A");  map2.put(k1, hello);  System.out.println("k1.equals(k2):" + s1.equals(s2));  System.out.println("map2.get(k1):" + map2.get(k1));  System.out.println("map2.get(k2):" + map2.get(k2));}
class Key {
  private String k;
  public Key(String key) {    this.k = key;  }
  @Override  public boolean equals(Object obj) {    if (obj instanceof Key) {      Key key = (Key) obj;      return k.equals(key.k);    }    return false;  }}

實(shí)例中定義了內(nèi)部類(lèi)Key，其中實(shí)現(xiàn)了equals方法，但未實(shí)現(xiàn)hashCode方法。存放于Map中的value值都是字符串“hello”。

代碼分兩段，第一段演示當(dāng)Map的key通過(guò)實(shí)現(xiàn)了hashCode的String時(shí)是什么效果；第二段演示了當(dāng)Map的key通過(guò)未實(shí)現(xiàn)hashCode方法的Key對(duì)象時(shí)是什么效果。

執(zhí)行上述代碼，打印結(jié)果如下：

s1.equals(s2):true
map1.get(s1):hello
map1.get(s2):hello
k1.equals(k2):true
map2.get(k1):hello
map2.get(k2):null

分析結(jié)果可以看出，對(duì)于String作為key的s1和s2來(lái)說(shuō)，通過(guò)equals比較相等是自然的，獲得的值也是相同的。但k1和k2通過(guò)equals比較是相等，但為什么在Map中獲得的結(jié)果卻不一樣？本質(zhì)上就是因?yàn)闆](méi)有重寫(xiě)hashCode方法導(dǎo)致Map在存儲(chǔ)和獲取過(guò)程中調(diào)用hashCode方法獲得的值不一致。

此時(shí)在Key類(lèi)中添加hashCode方法：

@Override
public int hashCode(){
	return k.hashCode();
}

再次執(zhí)行，便可正常獲得對(duì)應(yīng)的值。

s1.equals(s2):true
map1.get(s1):hello
map1.get(s2):hello
k1.equals(k2):true
map2.get(k1):hello
map2.get(k2):hello

通過(guò)上面的典型實(shí)例演示了不重寫(xiě)hashCode方法的潛在后果。簡(jiǎn)單看一下HashMap中的put方法。

public V put(K key, V value) {    return putVal(hash(key), key, value, false, true);}
static final int hash(Object key) {    int h;    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);}
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,               boolean evict) {    Node[] tab; Node p; int n, i;    if ((tab = table) == null || (n = tab.length) == 0)        n = (tab = resize()).length;    // 通過(guò)哈希值來(lái)查找底層數(shù)組位于該位置的元素p，如果p不為null，則使用新的鍵值對(duì)來(lái)覆蓋舊的鍵值對(duì)    if ((p = tab[i = (n - 1) & hash]) == null)        tab[i] = newNode(hash, key, value, null);    else {        Node e; K k;        // (二者哈希值相等)且(二者地址值相等或調(diào)用equals認(rèn)定相等)。        if (p.hash == hash &&            ((k = p.key) == key || (key != null && key.equals(k))))            e = p;        else if (p instanceof TreeNode)            e = ((TreeNode)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;                }                if (e.hash == hash &&                    ((k = e.key) == key || (key != null && key.equals(k))))                    break;                p = e;            }        }        // 如果底層數(shù)組中存在傳入的Key，那么使用新傳入的覆蓋掉查到的        if (e != null) { // existing mapping for key            V oldValue = e.value;            if (!onlyIfAbsent || oldValue == null)                e.value = value;            afterNodeAccess(e);            return oldValue;        }    }    ++modCount;    if (++size > threshold)        resize();    afterNodeInsertion(evict);    return null;}

在上述方法中，put方法在拿到key的第一步就對(duì)key對(duì)象調(diào)用了hashCode方法。暫且不看后面的代碼，如果沒(méi)有重寫(xiě)hashCode方法，就無(wú)法確保key的hash值一致，后續(xù)操作就是兩個(gè)key的操作了。

重寫(xiě)hashCode方法

了解了重寫(xiě)hashCode方法的重要性，也了解了對(duì)應(yīng)的規(guī)約，那么下面我們就聊聊如何優(yōu)雅的重寫(xiě)hashCode方法。

首先，如果使用IDEA的話，那么直接使用快捷鍵即可。

生成的效果如下：

@Overridepublic boolean equals(Object o) {  if (this == o) {    return true;  }  if (o == null || getClass() != o.getClass()) {    return false;  }  Key key = (Key) o;  return Objects.equals(k, key.k);}
@Overridepublic int hashCode() {  return Objects.hash(k);}

根據(jù)需要可對(duì)生成的方法內(nèi)部實(shí)現(xiàn)進(jìn)行修改。在上面的實(shí)例中用到了java.util.Objects類(lèi)，它的hash方法的優(yōu)點(diǎn)是如果參數(shù)為null，就只返回0，否則返回對(duì)象參數(shù)調(diào)用的hashCode的結(jié)果。Objects.hash方法源碼如下：

public static int hash(Object... values) {    return Arrays.hashCode(values);}

其中Arrays.hashCode方法源碼如下：

public static int hashCode(Object a[]) {    if (a == null)        return 0;
    int result = 1;
    for (Object element : a)        result = 31 * result + (element == null ? 0 : element.hashCode());
    return result;}

當(dāng)然此處只有一個(gè)參數(shù)，也可以直接使用Objects類(lèi)hashCode方法：

public static int hashCode(Object o) {    return o != null ? o.hashCode() : 0;}

如果是多個(gè)屬性都參與hash值的情況建議可使用第一個(gè)方法。只不過(guò)需要注意，在類(lèi)結(jié)構(gòu)（成員變量）變動(dòng)時(shí)，同步增減方法里面的參數(shù)值。

小結(jié)

當(dāng)我們準(zhǔn)備面試時(shí)，一直在背誦“實(shí)現(xiàn)equals方法的同時(shí)也要實(shí)現(xiàn)hashCode方法”，牢記這些結(jié)論并沒(méi)有錯(cuò)。但我們也不能因?yàn)榇颐?zhǔn)備面試題，而忘記了這些面試題之所以頻繁出現(xiàn)的原因是什么。當(dāng)深入探索之后，會(huì)發(fā)現(xiàn)在那些枯燥的結(jié)論背后還有這么多不容忽視的知識(shí)點(diǎn)，還有這么多有意思的設(shè)計(jì)與陷阱。