hashCode() 和 equals()的問題解答及重寫示範

本章的內容主要解決下面幾個問題：

1 equals() 的做用是什麼？

2 equals() 與 == 的區別是什麼？

3 hashCode() 的做用是什麼？

4 hashCode() 和 equals() 之間有什麼聯繫？

4 java 如何重寫equal 和hashcode方法

第1部分 equals() 的做用

equals() 的做用是 用來判斷兩個對象是否相等。

java對equals()的要求。有如下幾點：

1. 對稱性：若是x.equals(y)返回是"true"，那麼y.equals(x)也應該返回是"true"。
2. 反射性：x.equals(x)必須返回是"true"。
3. 類推性：若是x.equals(y)返回是"true"，並且y.equals(z)返回是"true"，那麼z.equals(x)也應該返回是"true"。
4. 一致性：若是x.equals(y)返回是"true"，只要x和y內容一直不變，無論你重複x.equals(y)多少次，返回都是"true"。
5. 非空性，x.equals(null)，永遠返回是"false"；x.equals(和x不一樣類型的對象)永遠返回是"false"。

equals() 定義在JDK的Object.java中。經過判斷兩個對象的地址是否相等(即，是不是同一個對象)來區分它們是否相等。源碼以下：

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

既然Object.java中定義了equals()方法，這就意味着全部的Java類都實現了equals()方法，全部的類均可以經過equals()去比較兩個對象是否相等。 可是，咱們已經說過，使用默認的「equals()」方法，等價於「==」方法。所以，咱們一般會重寫equals()方法：若兩個對象的內容相等，則equals()方法返回true；不然，返回fasle。

下面根據「類是否覆蓋equals()方法」，將它分爲2類。

(01) 若某個類沒有覆蓋equals()方法，當它的經過equals()比較兩個對象時，其實是比較兩個對象是否是同一個對象。這時，等價於經過「==」去比較這兩個對象。

(02) 咱們能夠覆蓋類的equals()方法，來讓equals()經過其它方式比較兩個對象是否相等。一般的作法是：若兩個對象的內容相等，則equals()方法返回true；不然，返回fasle。

下面，舉例對上面的2種狀況進行說明。

1. 「沒有覆蓋equals()方法」的狀況

代碼以下 (EqualsTest1.java)：

import java.util.*;
import java.lang.Comparable;

/**
 * @desc equals()的測試程序。
 *
 * @author skywang
 * @emai kuiwu-wang@163.com
 */
public class EqualsTest1{

    public static void main(String[] args) {
        // 新建2個相同內容的Person對象，
        // 再用equals比較它們是否相等
        Person p1 = new Person("eee", 100);
        Person p2 = new Person("eee", 100);
        System.out.printf("%s\n", p1.equals(p2));
    }

    /**
     * @desc Person類。
     */
    private static class Person {
        int age;
        String name;

        public Person(String name, int age) {
            this.name = name;
            this.age = age;
        }

        public String toString() {
            return name + " - " +age;
        }
    }
}

運行結果：
false

結果分析：
咱們經過 p1.equals(p2) 來「比較p1和p2是否相等時」。實際上，調用的Object.java的equals()方法，即調用的 (p1==p2) 。它是比較「p1和p2是不是同一個對象」。
而由 p1 和 p2 的定義可知，它們雖然內容相同；但它們是兩個不一樣的對象！所以，返回結果是false。

2. "覆蓋equals()方法"的狀況

咱們修改上面的EqualsTest1.java：覆蓋equals()方法。

代碼以下 (EqualsTest2.java)：

import java.util.*;
import java.lang.Comparable;

/**
 * @desc equals()的測試程序。
 *
 * @author skywang
 * @emai kuiwu-wang@163.com
 */
public class EqualsTest2{

    public static void main(String[] args) {
        // 新建2個相同內容的Person對象，
        // 再用equals比較它們是否相等
        Person p1 = new Person("eee", 100);
        Person p2 = new Person("eee", 100);
        System.out.printf("%s\n", p1.equals(p2));
    }

    /**
     * @desc Person類。
     */
    private static class Person {
        int age;
        String name;

        public Person(String name, int age) {
            this.name = name;
            this.age = age;
        }

        public String toString() {
            return name + " - " +age;
        }

        /** 
         * @desc 覆蓋equals方法 
         */  
        @Override
        public boolean equals(Object obj){  
            if(obj == null){  
                return false;  
            }  
              
            //若是是同一個對象返回true，反之返回false  
            if(this == obj){  
                return true;  
            }  
              
            //判斷是否類型相同  
            if(this.getClass() != obj.getClass()){  
                return false;  
            }  
              
            Person person = (Person)obj;  
            return name.equals(person.name) && age==person.age;  
        } 
    }
}

運行結果：
true

結果分析：
咱們在EqualsTest2.java 中重寫了Person的equals()函數：當兩個Person對象的 name 和 age 都相等，則返回true。
所以，運行結果返回true。

第2部分 equals() 與 == 的區別是什麼？

== : 它的做用是判斷兩個對象的地址是否是相等。即，判斷兩個對象是不試同一個對象。

equals() : 它的做用也是判斷兩個對象是否相等。但它通常有兩種使用狀況(前面第1部分已詳細介紹過)：
狀況1，類沒有覆蓋equals()方法。則經過equals()比較該類的兩個對象時，等價於經過「==」比較這兩個對象。
狀況2，類覆蓋了equals()方法。通常，咱們都覆蓋equals()方法來兩個對象的內容相等；若它們的內容相等，則返回true(即，認爲這兩個對象相等)。

下面，經過示例比較它們的區別。

代碼以下：

import java.util.*;
import java.lang.Comparable;

/**
 * @desc equals()的測試程序。
 *
 * @author skywang
 * @emai kuiwu-wang@163.com
 */
public class EqualsTest3{

    public static void main(String[] args) {
        // 新建2個相同內容的Person對象，
        // 再用equals比較它們是否相等
        Person p1 = new Person("eee", 100);
        Person p2 = new Person("eee", 100);
        System.out.printf("p1.equals(p2) : %s\n", p1.equals(p2));
        System.out.printf("p1==p2 : %s\n", p1==p2);
    }

    /**
     * @desc Person類。
     */
    private static class Person {
        int age;
        String name;

        public Person(String name, int age) {
            this.name = name;
            this.age = age;
        }

        public String toString() {
            return name + " - " +age;
        }

        /** 
         * @desc 覆蓋equals方法 
         */  
        @Override
        public boolean equals(Object obj){  
            if(obj == null){  
                return false;  
            }  
              
            //若是是同一個對象返回true，反之返回false  
            if(this == obj){  
                return true;  
            }  
              
            //判斷是否類型相同  
            if(this.getClass() != obj.getClass()){  
                return false;  
            }  
              
            Person person = (Person)obj;  
            return name.equals(person.name) && age==person.age;  
        } 
    }
}

運行結果：
p1.equals(p2) : true
p1==p2 : false

結果分析：
在EqualsTest3.java 中：

(01) p1.equals(p2)
這是判斷p1和p2的內容是否相等。由於Person覆蓋equals()方法，而這個equals()是用來判斷p1和p2的內容是否相等，偏偏p1和p2的內容又相等；所以，返回true。

(02) p1==p2
這是判斷p1和p2是不是同一個對象。因爲它們是各自新建的兩個Person對象；所以，返回false。

第3部分 hashCode() 的做用

hashCode() 的做用是獲取哈希碼，也稱爲散列碼；它其實是返回一個int整數。這個哈希碼的做用是肯定該對象在哈希表中的索引位置。

hashCode() 定義在JDK的Object.java中，這就意味着Java中的任何類都包含有hashCode() 函數。
雖然，每一個Java類都包含hashCode() 函數。可是，僅僅當建立並某個「類的散列表」(關於「散列表」見下面說明)時，該類的hashCode() 纔有用(做用是：肯定該類的每個對象在散列表中的位置；其它狀況下(例如，建立類的單個對象，或者建立類的對象數組等等)，類的hashCode() 沒有做用。
上面的散列表，指的是：Java集合中本質是散列表的類，如HashMap，Hashtable，HashSet。

也就是說：hashCode() 在散列表中才有用，在其它狀況下沒用。在散列表中hashCode() 的做用是獲取對象的散列碼，進而肯定該對象在散列表中的位置。

至此，咱們搞清楚了：hashCode()的做用是獲取散列碼。

爲了能理解後面的內容，這裏簡單的介紹一下散列碼的做用。

咱們都知道，散列表存儲的是鍵值對(key-value)，它的特色是：能根據「鍵」快速的檢索出對應的「值」。這其中就利用到了散列碼！
散列表的本質是經過數組實現的。當咱們要獲取散列表中的某個「值」時，其實是要獲取數組中的某個位置的元素。而數組的位置，就是經過「鍵」來獲取的；更進一步說，數組的位置，是經過「鍵」對應的散列碼計算獲得的。

下面，咱們以HashSet爲例，來深刻說明hashCode()的做用。

假設，HashSet中已經有1000個元素。當插入第1001個元素時，須要怎麼處理？由於HashSet是Set集合，它容許有重複元素。
    「將第1001個元素逐個的和前面1000個元素進行比較」？顯然，這個效率是相等低下的。散列表很好的解決了這個問題，它根據元素的散列碼計算出元素在散列表中的位置，而後將元素插入該位置便可。對於相同的元素，天然是隻保存了一個。
    由此可知，若兩個元素相等，它們的散列碼必定相等；但反過來確不必定。在散列表中，
                       一、若是兩個對象相等，那麼它們的hashCode()值必定要相同；
                       二、若是兩個對象hashCode()相等，它們並不必定相等。
                       注意：這是在散列表中的狀況。在非散列表中必定如此！

對「hashCode()的做用」就談這麼多。

第4部分 hashCode() 和 equals() 的關係

接下面，咱們討論另一個話題。網上不少文章將 hashCode() 和 equals 關聯起來，有的講的不透徹，有誤導讀者的嫌疑。在這裏，我本身梳理了一下 「hashCode() 和 equals()的關係」。

咱們以「類的用途」來將「hashCode() 和 equals()的關係」分2種狀況來講明。

1. 第一種 不會建立「類對應的散列表」

這裏所說的「不會建立類對應的散列表」是說：咱們不會在HashSet, Hashtable, HashMap等等這些本質是散列表的數據結構中，用到該類。例如，不會建立該類的HashSet集合。

    在這種狀況下，該類的「hashCode() 和 equals() 」沒有半毛錢關係的！
    這種狀況下，equals() 用來比較該類的兩個對象是否相等。而hashCode() 則根本沒有任何做用，因此，不用理會hashCode()。

下面，咱們經過示例查看類的兩個對象相等 以及 不等時hashCode()的取值。

源碼以下 (NormalHashCodeTest.java)：

import java.util.*;
import java.lang.Comparable;

/**
 * @desc 比較equals() 返回true 以及 返回false時， hashCode()的值。
 *
 * @author skywang
 * @emai kuiwu-wang@163.com
 */
public class NormalHashCodeTest{

    public static void main(String[] args) {
        // 新建2個相同內容的Person對象，
        // 再用equals比較它們是否相等
        Person p1 = new Person("eee", 100);
        Person p2 = new Person("eee", 100);
        Person p3 = new Person("aaa", 200);
        System.out.printf("p1.equals(p2) : %s; p1(%d) p2(%d)\n", p1.equals(p2), p1.hashCode(), p2.hashCode());
        System.out.printf("p1.equals(p3) : %s; p1(%d) p3(%d)\n", p1.equals(p3), p1.hashCode(), p3.hashCode());
    }

    /**
     * @desc Person類。
     */
    private static class Person {
        int age;
        String name;

        public Person(String name, int age) {
            this.name = name;
            this.age = age;
        }

        public String toString() {
            return name + " - " +age;
        }

        /** 
         * @desc 覆蓋equals方法 
         */  
        public boolean equals(Object obj){  
            if(obj == null){  
                return false;  
            }  
              
            //若是是同一個對象返回true，反之返回false  
            if(this == obj){  
                return true;  
            }  
              
            //判斷是否類型相同  
            if(this.getClass() != obj.getClass()){  
                return false;  
            }  
              
            Person person = (Person)obj;  
            return name.equals(person.name) && age==person.age;  
        } 
    }
}

運行結果：
p1.equals(p2) : true; p1(1169863946) p2(1901116749)
p1.equals(p3) : false; p1(1169863946) p3(2131949076)

從結果也能夠看出：p1和p2相等的狀況下，hashCode()也不必定相等。

2. 第二種 會建立「類對應的散列表」

這裏所說的「會建立類對應的散列表」是說：咱們會在HashSet, Hashtable, HashMap等等這些本質是散列表的數據結構中，用到該類。例如，會建立該類的HashSet集合。

    在這種狀況下，該類的「hashCode() 和 equals() 」是有關係的：
    1)、若是兩個對象相等，那麼它們的hashCode()值必定相同。
          這裏的相等是指，經過equals()比較兩個對象時返回true。
    2)、若是兩個對象hashCode()相等，它們並不必定相等。
           由於在散列表中，hashCode()相等，即兩個鍵值對的哈希值相等。然而哈希值相等，並不必定能得出鍵值對相等。補充說一句：「兩個不一樣的鍵值對，哈希值相等」，這就是哈希衝突。

    此外，在這種狀況下。若要判斷兩個對象是否相等，除了要覆蓋equals()以外，也要覆蓋hashCode()函數。不然，equals()無效。

例如，建立Person類的HashSet集合，必須同時覆蓋Person類的equals() 和 hashCode()方法。
若是單單只是覆蓋equals()方法。咱們會發現，equals()方法沒有達到咱們想要的效果。

參考代碼 (ConflictHashCodeTest1.java)：

import java.util.*;
import java.lang.Comparable;

/**
 * @desc 比較equals() 返回true 以及 返回false時， hashCode()的值。
 *
 * @author skywang
 * @emai kuiwu-wang@163.com
 */
public class ConflictHashCodeTest1{

    public static void main(String[] args) {
        // 新建Person對象，
        Person p1 = new Person("eee", 100);
        Person p2 = new Person("eee", 100);
        Person p3 = new Person("aaa", 200);

        // 新建HashSet對象 
        HashSet set = new HashSet();
        set.add(p1);
        set.add(p2);
        set.add(p3);

        // 比較p1 和 p2， 並打印它們的hashCode()
        System.out.printf("p1.equals(p2) : %s; p1(%d) p2(%d)\n", p1.equals(p2), p1.hashCode(), p2.hashCode());
        // 打印set
        System.out.printf("set:%s\n", set);
    }

    /**
     * @desc Person類。
     */
    private static class Person {
        int age;
        String name;

        public Person(String name, int age) {
            this.name = name;
            this.age = age;
        }

        public String toString() {
            return "("+name + ", " +age+")";
        }

        /** 
         * @desc 覆蓋equals方法 
         */  
        @Override
        public boolean equals(Object obj){  
            if(obj == null){  
                return false;  
            }  
              
            //若是是同一個對象返回true，反之返回false  
            if(this == obj){  
                return true;  
            }  
              
            //判斷是否類型相同  
            if(this.getClass() != obj.getClass()){  
                return false;  
            }  
              
            Person person = (Person)obj;  
            return name.equals(person.name) && age==person.age;  
        } 
    }
}

運行結果：
p1.equals(p2) : true; p1(1169863946) p2(1690552137)
set:[(eee, 100), (eee, 100), (aaa, 200)]

結果分析：

咱們重寫了Person的equals()。可是，很奇怪的發現：HashSet中仍然有重複元素：p1 和 p2。爲何會出現這種狀況呢？

    這是由於雖然p1 和 p2的內容相等，可是它們的hashCode()不等；因此，HashSet在添加p1和p2的時候，認爲它們不相等。

下面，咱們同時覆蓋equals() 和 hashCode()方法。

參考代碼 (ConflictHashCodeTest2.java)：

import java.util.*;
import java.lang.Comparable;

/**
 * @desc 比較equals() 返回true 以及 返回false時， hashCode()的值。
 *
 * @author skywang
 * @emai kuiwu-wang@163.com
 */
public class ConflictHashCodeTest2{

    public static void main(String[] args) {
        // 新建Person對象，
        Person p1 = new Person("eee", 100);
        Person p2 = new Person("eee", 100);
        Person p3 = new Person("aaa", 200);
        Person p4 = new Person("EEE", 100);

        // 新建HashSet對象 
        HashSet set = new HashSet();
        set.add(p1);
        set.add(p2);
        set.add(p3);

        // 比較p1 和 p2， 並打印它們的hashCode()
        System.out.printf("p1.equals(p2) : %s; p1(%d) p2(%d)\n", p1.equals(p2), p1.hashCode(), p2.hashCode());
        // 比較p1 和 p4， 並打印它們的hashCode()
        System.out.printf("p1.equals(p4) : %s; p1(%d) p4(%d)\n", p1.equals(p4), p1.hashCode(), p4.hashCode());
        // 打印set
        System.out.printf("set:%s\n", set);
    }

    /**
     * @desc Person類。
     */
    private static class Person {
        int age;
        String name;

        public Person(String name, int age) {
            this.name = name;
            this.age = age;
        }

        public String toString() {
            return name + " - " +age;
        }

        /** 
         * @desc重寫hashCode 
         */  
        @Override
        public int hashCode(){  
            int nameHash =  name.toUpperCase().hashCode();
            return nameHash ^ age;
        }

        /** 
         * @desc 覆蓋equals方法 
         */  
        @Override
        public boolean equals(Object obj){  
            if(obj == null){  
                return false;  
            }  
              
            //若是是同一個對象返回true，反之返回false  
            if(this == obj){  
                return true;  
            }  
              
            //判斷是否類型相同  
            if(this.getClass() != obj.getClass()){  
                return false;  
            }  
              
            Person person = (Person)obj;  
            return name.equals(person.name) && age==person.age;  
        } 
    }
}

運行結果：
p1.equals(p2) : true; p1(68545) p2(68545)
p1.equals(p4) : false; p1(68545) p4(68545)
set:[aaa - 200, eee - 100]

結果分析：

這下，equals()生效了，HashSet中沒有重複元素。
    比較p1和p2，咱們發現：它們的hashCode()相等，經過equals()比較它們也返回true。因此，p1和p2被視爲相等。
    比較p1和p4，咱們發現：雖然它們的hashCode()相等；可是，經過equals()比較它們返回false。因此，p1和p4被視爲不相等。

第5部分 java 如何重寫equal 和hashcode方法

重寫方法

實現高質量的equals方法的訣竅包括

• 使用==操做符檢查「參數是否爲這個對象的引用」；
• 使用instanceof操做符檢查「參數是否爲正確的類型」；
• 對於類中的關鍵屬性，檢查參數傳入對象的屬性是否與之相匹配；
• 編寫完equals方法後，問本身它是否知足對稱性、傳遞性、一致性；
• 重寫equals時老是要重寫hashCode；
• 不要將equals方法參數中的Object對象替換爲其餘的類型，在重寫時不要忘掉@Override註解。

public boolean equals(Object otherObject){       //測試兩個對象是不是同一個對象，是的話返回true
           if(this == otherObject) {  //測試檢測的對象是否爲空，是就返回false
               return true;   
           } 
           if(otherObject == null) {  //測試兩個對象所屬的類是否相同，不然返回false
               return false;       
           }
           if(getClass() != otherObject.getClass()) {  //對otherObject進行類型轉換以便和類A的對象進行比較
               return false; 
           }       
           A other=(A)otherObject; 
           return Object.equals(類A對象的屬性A，other的屬性A）&&類A對象的屬性B==other的屬性B……;
    }

例子

public class TestEquals {

    public static void main(String[] args) {
        Person2 p1 = new Person2("aa", 13);
        Person2 p2 = new Person2("aa", 13);
        Person2 p3 = new Person2("bb", 13);
        System.out.println(p1.equals(p2)); // true
        System.out.println(p1.equals(p3)); // false
    }

}

class Person2 {
    private String name;
    private int age;
 
    public Person2(String name, int age) {
        this.name = name;
        this.age = 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;
    }
 
    public boolean equals(Object another) {
 
        //先判斷是否是本身,提升運行效率
        if (this == another)
            return true;
 
        //再判斷是否是Person類,提升代碼的健壯性
        if (another instanceof Person2) {
 
            //向下轉型,父類沒法調用子類的成員和方法
            Person2 anotherPerson = (Person2) another;
 
            //最後判斷類的全部屬性是否相等，其中String類型和Object類型能夠用相應的equals()來判斷
            if ((this.getName().equals(anotherPerson.getName())) && (this.getAge() == anotherPerson.getAge()))
                return true;
        } else {
            return false;
        }
 
        return false;
    }
}

hashCode相關

實現hashCode方法的通用約定

在應用程序的執行期間，只要對象的equals方法的比較操做所用到的信息沒有被修改，那麼對這個同一對象調用屢次，hashCode方法必須始終如一地返回同一個整數。在同一個應用程序的屢次執行過程當中，每次執行所返回的整數能夠不一致。

若是兩個對象根據equals(Object)方法比較是相等的，那麼調用這兩個對象中任意一個對象的hashCode方法都必須產生一樣的整數結果。反之，若是兩個對象hashCode方法返回整數結果同樣，則不表明兩個對象相等，由於equals方法能夠被重載。

若是兩個對象根據equals(Object)方法比較是不相等的，那麼調用這兩個對象中任意一個對象的hashCode方法，則不必定要產生不一樣的整數結果。但，若是能讓不一樣的對象產生不一樣的整數結果，則有可能提升散列表的性能。

hashCode散列碼計算（來自：Effective Java）

把某個非零的常數值，好比17，保存在一個名爲result的int類型的變量中。

對於對象中每一個關鍵域f(指equals方法中涉及的每一個域)，完成如下步驟：

爲該域計算int類型的散列碼c：

若是該域是boolean類型，則計算(f?1:0)。

若是該域是byte，char，short或者int類型，則計算(int)f。

若是該域是long類型，則計算(int)(f^(f>>>32))。

若是該域是float類型，則計算Float.floatToIntBits(f)。

若是該域是double類型，則計算Double.doubleToLongBits(f)，而後按照步驟2.1.3，爲獲得的long類型值計算散列值。

若是該域是一個對象引用，而且該類的equals方法經過遞歸地調用equals的方式來比較這個域，則一樣爲這個域遞歸地調用hashCode。若是須要更復雜的比較，則爲這個域計算一個範式(canonical representation)，而後針對這個範式調用hashCode。若是這個域的值爲null，則返回0(其餘常數也行)。

若是該域是一個數組，則要把每個元素當作單獨的域來處理。也就是說，遞歸地應用上述規則，對每一個重要的元素計算一個散列碼，而後根據步驟2.2中的作法把這些散列值組合起來。若是數組域中的每一個元素都很重要，能夠利用發行版本1.5中增長的其中一個Arrays.hashCode方法。

按照下面的公式，把步驟2.1中計算獲得的散列碼c合併到result中：result = 31 * result + c; //此處31是個奇素數，而且有個很好的特性，即用移位和減法來代替乘法，能夠獲得更好的性能：`31*i == (i<<5) - i， 現代JVM能自動完成此優化。

返回result

檢驗並測試該hashCode實現是否符合通用約定。

@Override
   public int hashCode() {
        int result = 17;
        result = 31 * result + mInt;
        result = 31 * result + (mBoolean ? 1 : 0);
        result = 31 * result + Float.floatToIntBits(mFloat);
        result = 31 * result + (int)(mLong ^ (mLong >>> 32));
        long mDoubleTemp = Double.doubleToLongBits(mDouble);
        result =31 * result + (int)(mDoubleTemp ^ (mDoubleTemp >>> 32));
        result = 31 * result + (mString == null ? 0 : mMsgContain.hashCode());
        result = 31 * result + (mObj == null ? 0 : mObj.hashCode());
        return result;
    }

參考：

https://www.cnblogs.com/skywang12345/p/3324958.html

https://www.cnblogs.com/myseries/p/10977868.html