[[440030]]

 equals 方法和 hashCode 方法是 Object 類中的兩個基礎(chǔ)方法，它們共同協(xié)作來判斷兩個對象是否相等。為什么要這樣設(shè)計(jì)嘞？原因就出在“性能” 2 字上。

使用過 HashMap 我們就知道，通過 hash 計(jì)算之后，我們就可以直接定位出某個值存儲的位置了，那么試想一下，如果你現(xiàn)在要查詢某個值是否在集合中？如果不通過 hash 方式直接定位元素（的存儲位置），那么就只能按照集合的前后順序，一個一個的詢問比對了，而這種依次比對的效率明顯低于 hash 定位的方式。這就是 hash 以及 hashCode 存在的價值。

當(dāng)我們對比兩個對象是否相等時，我們就可以先使用 hashCode 進(jìn)行比較，如果比較的結(jié)果是 true，那么就可以使用 equals 再次確認(rèn)兩個對象是否相等，如果比較的結(jié)果是 true，那么這兩個對象就是相等的，否則其他情況就認(rèn)為兩個對象不相等。這樣就大大的提升了對象比較的效率，這也是為什么 Java 設(shè)計(jì)使用 hashCode 和 equals 協(xié)同的方式，來確認(rèn)兩個對象是否相等的原因。

那為什么不直接使用 hashCode 就確定兩個對象是否相等呢？

這是因?yàn)椴煌瑢ο蟮?hashCode 可能相同；但 hashCode 不同的對象一定不相等，所以使用 hashCode 可以起到快速初次判斷對象是否相等的作用。

但即使知道了以上基礎(chǔ)知識，依然解決不了本篇的問題，也就是：重寫 equals 時為什么一定要重寫 hashCode？要想了解這個問題的根本原因，我們還得先從這兩個方法開始說起。

 1.equals 方法

Object 類中的 equals 方法用于檢測一個對象是否等于另外一個對象。在 Object 類中，這個方法將判斷兩個對象是否具有相同的引用。如果兩個對象具有相同的引用，它們一定是相等的。

equals 方法的實(shí)現(xiàn)源碼如下： 

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

通過上述源碼和 equals 的定義我們可以看出，在大多數(shù)情況來說，equals 的判斷是沒有什么意義的！例如，使用 Object 中的 equals 比較兩個自定義的對象是否相等，這就完全沒有意義（因?yàn)闊o論對象是否相等，結(jié)果都是 false）。

通過以下示例，就可以說明這個問題： 

public class EqualsMyClassExample {  
    public static void main(String[] args) {  
        Person u1 = new Person();  
        u1.setName("Java");  
        u1.setAge(18);  
        Person u2 = new Person();  
        u1.setName("Java");  
        u1.setAge(18);        
         // 打印 equals 結(jié)果  
        System.out.println("equals 結(jié)果：" + u1.equals(u2));  
    }  
}  
class Person {  
    private String name;  
    private int age;  
    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;  
    }  
} 

以上程序的執(zhí)行結(jié)果，如下圖所示

因此通常情況下，我們要判斷兩個對象是否相等，一定要重寫 equals 方法，這就是為什么要重寫 equals 方法的原因。

2.hashCode 方法

hashCode 翻譯為中文是散列碼，它是由對象推導(dǎo)出的一個整型值，并且這個值為任意整數(shù)，包括正數(shù)或負(fù)數(shù)。

需要注意的是：散列碼是沒有規(guī)律的。如果 x 和 y 是兩個不同的對象，x.hashCode() 與 y.hashCode() 基本上不會相同；但如果 a 和 b 相等，則 a.hashCode() 一定等于 b.hashCode()。

hashCode 在 Object 中的源碼如下：

public native int hashCode(); 

從上述源碼可以看到，Object 中的 hashCode 調(diào)用了一個（native）本地方法，返回了一個 int 類型的整數(shù)，當(dāng)然，這個整數(shù)可能是正數(shù)也可能是負(fù)數(shù)。

hashCode 使用

相等的值 hashCode 一定相同的示例： 

public class HashCodeExample {  
    public static void main(String[] args) {  
        String s1 = "Hello";  
        String s2 = "Hello";  
        String s3 = "Java";  
        System.out.println("s1 hashCode:" + s1.hashCode());  
        System.out.println("s2 hashCode:" + s2.hashCode());  
        System.out.println("s3 hashCode:" + s3.hashCode());  
    }  
} 

以上程序的執(zhí)行結(jié)果，如下圖所示：

不同的值 hashCode 也有可能相同的示例： 

public class HashCodeExample {  
    public static void main(String[] args) {  
        String s1 = "Aa";  
        String s2 = "BB";  
        System.out.println("s1 hashCode:" + s1.hashCode());  
        System.out.println("s2 hashCode:" + s2.hashCode());  
    }  
} 

以上程序的執(zhí)行結(jié)果，如下圖所示：

3.為什么要一起重寫？

接下來回到本文的主題，重寫 equals 為什么一定要重寫 hashCode？

為了解釋這個問題，我們需要從下面的這個例子入手。

3.1 Set 正常使用

Set 集合是用來保存不同對象的，相同的對象就會被 Set 合并，最終留下一份獨(dú)一無二的數(shù)據(jù)。

它的正常用法如下： 

import java.util.HashSet;  
import java.util.Set;  
public class HashCodeExample {  
    public static void main(String[] args) {  
        Set<String> set = new HashSet();  
        set.add("Java");  
        set.add("Java");  
        set.add("MySQL");  
        set.add("MySQL");  
        set.add("Redis");  
        System.out.println("Set 集合長度:" + set.size());  
        System.out.println();  
        // 打印 Set 中的所有元素  
        set.forEach(d -> System.out.println(d));  
    } 
 } 

以上程序的執(zhí)行結(jié)果，如下圖所示：

從上述結(jié)果可以看出，重復(fù)的數(shù)據(jù)已經(jīng)被 Set 集合“合并”了，這也是 Set 集合最大的特點(diǎn)：去重。

3.2 Set 集合的“異常”

然而，如果我們在 Set 集合中存儲的是，只重寫了 equals 方法的自定義對象時，有趣的事情就發(fā)生了，如下代碼所示： 

import java.util.HashSet;  
import java.util.Objects;  
import java.util.Set;  
public class EqualsExample {  
    public static void main(String[] args) {  
        // 對象 1  
        Persion p1 = new Persion();  
        p1.setName("Java");  
        p1.setAge(18);  
        // 對象 2  
        Persion p2 = new Persion();  
        p2.setName("Java");  
        p2.setAge(18);  
        // 創(chuàng)建 Set 集合  
        Set<Persion> set = new HashSet<Persion>();  
        set.add(p1);  
        set.add(p2);  
        // 打印 Set 中的所有數(shù)據(jù)  
        set.forEach(p -> {  
            System.out.println(p);  
        });  
    }  
}  
class Persion {  
    private String name;  
    private int age;  
    // 只重寫了 equals 方法  
    @Override  
    public boolean equals(Object o) {  
        if (this == o) return true; // 引用相等返回 true  
        // 如果等于 null，或者對象類型不同返回 false  
        if (o == null || getClass() != o.getClass()) return false;  
        // 強(qiáng)轉(zhuǎn)為自定義 Persion 類型  
        Persion persion = (Persion) o;  
        // 如果 age 和 name 都相等，就返回 true  
        return age == persion.age &&  
                Objects.equals(name, persion.name);  
    }  
    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;  
    }   
     @Override  
    public String toString() {  
        return "Persion{" +  
                "name='" + name + '\'' +  
                ", age=" + age +  
                '}';  
    }  
} 

以上程序的執(zhí)行結(jié)果，如下圖所示：

從上述代碼和上述圖片可以看出，即使兩個對象是相等的，Set 集合竟然沒有將二者進(jìn)行去重與合并。這就是重寫了 equals 方法，但沒有重寫 hashCode 方法的問題所在。

3.3 解決“異常”

為了解決上面的問題，我們嘗試在重寫 equals 方法時，把 hashCode 方法也一起重寫了，實(shí)現(xiàn)代碼如下： 

import java.util.HashSet;  
import java.util.Objects;  
import java.util.Set;  
public class EqualsToListExample {  
    public static void main(String[] args) {  
        // 對象 1  
        Persion p1 = new Persion();  
        p1.setName("Java");  
        p1.setAge(18);  
        // 對象 2  
        Persion p2 = new Persion();  
        p2.setName("Java");  
        p2.setAge(18);  
        // 創(chuàng)建 Set 對象  
        Set<Persion> set = new HashSet<Persion>();  
        set.add(p1);  
        set.add(p2);  
        // 打印 Set 中的所有數(shù)據(jù)  
        set.forEach(p -> {  
            System.out.println(p);  
        });  
    }  
}  
class Persion {  
    private String name;  
    private int age;  
    @Override  
    public boolean equals(Object o) {  
        if (this == o) return true; // 引用相等返回 true  
        // 如果等于 null，或者對象類型不同返回 false  
        if (o == null || getClass() != o.getClass()) return false;  
        // 強(qiáng)轉(zhuǎn)為自定義 Persion 類型  
        Persion persion = (Persion) o;  
        // 如果 age 和 name 都相等，就返回 true  
        return age == persion.age &&  
                Objects.equals(name, persion.name);  
    }  
    @Override  
    public int hashCode() {  
        // 對比 name 和 age 是否相等  
        return Objects.hash(name, age);  
    }  
    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;  
    }     
    @Override  
    public String toString() {  
        return "Persion{" +  
                "name='" + name + '\'' +  
                ", age=" + age +  
                '}';  
    }  
} 

以上程序的執(zhí)行結(jié)果，如下圖所示：

通過上述結(jié)果可以看出，當(dāng)我們一起重寫了兩個方法之后，奇跡的事情又發(fā)生了，Set 集合又恢復(fù)正常了，這是為什么呢？

3.4 原因分析

出現(xiàn)以上問題的原因是，如果只重寫了 equals 方法，那么默認(rèn)情況下，Set 進(jìn)行去重操作時，會先判斷兩個對象的 hashCode 是否相同，此時因?yàn)闆]有重寫 hashCode 方法，所以會直接執(zhí)行 Object 中的 hashCode 方法，而 Object 中的 hashCode 方法對比的是兩個不同引用地址的對象，所以結(jié)果是 false，那么 equals 方法就不用執(zhí)行了，直接返回的結(jié)果就是 false：兩個對象不是相等的，于是就在 Set 集合中插入了兩個相同的對象。

但是，如果在重寫 equals 方法時，也重寫了 hashCode 方法，那么在執(zhí)行判斷時會去執(zhí)行重寫的 hashCode 方法，此時對比的是兩個對象的所有屬性的 hashCode 是否相同，于是調(diào)用 hashCode 返回的結(jié)果就是 true，再去調(diào)用 equals 方法，發(fā)現(xiàn)兩個對象確實(shí)是相等的，于是就返回 true 了，因此 Set 集合就不會存儲兩個一模一樣的數(shù)據(jù)了，于是整個程序的執(zhí)行就正常了。

 總結(jié)

hashCode 和 equals 兩個方法是用來協(xié)同判斷兩個對象是否相等的，采用這種方式的原因是可以提高程序插入和查詢的速度，如果在重寫 equals 時，不重寫 hashCode，就會導(dǎo)致在某些場景下，例如將兩個相等的自定義對象存儲在 Set 集合時，就會出現(xiàn)程序執(zhí)行的異常，為了保證程序的正常執(zhí)行，所以我們就需要在重寫 equals 時，也一并重寫 hashCode 方法才行。