Java hashCode() 和 equals()的若干問題解答

 

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

1 equals() 的作用是什么？

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

3 hashCode() 的作用是什么？

4 hashCode() 和 equals() 之間有什么聯系？

 

 

---

第1部分 equals() 的作用

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

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 [e-mail]
 */
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 [e-mail]
 */
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。

 

講到這里，順便說一下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()的作用：判斷兩個對象是否相等。當我們重寫equals()的時候，可千萬不好將它的作用給改變了！

 

---

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

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

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

 

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

代碼如下： 

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

/**
 * @desc equals()的測試程序。
 *
 * @author skywang
 * @emai [e-mail]
 */
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() 的作用是獲取對象的散列碼，進而確定該對象在散列表中的位置。

 

OK！至此，我們搞清楚了：hashCode()的作用是獲取散列碼。但是，散列碼是用來干什么的呢？為什么散列表需要散列碼呢？要解決這些問題，就需要理解散列表！關於散列表的內容，非三言兩語道的明白；大家可以通過下面幾篇文章來學習：

[轉載] 散列表(Hash Table)從理論到實用（上）

[轉載] 散列表(Hash Table)從理論到實用（中）

[轉載] 散列表(Hash Table)從理論到實用（下） 

 

為了能理解后面的內容，這里簡單的介紹一下散列碼的作用。

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

下面，我們以HashSet為例，來深入說明hashCode()的作用。

        假設，HashSet中已經有1000個元素。當插入第1001個元素時，需要怎么處理？因為HashSet是Set集合，它允許有重復元素。
        “將第1001個元素逐個的和前面1000個元素進行比較”？顯然，這個效率是相等低下的。散列表很好的解決了這個問題，它根據元素的散列碼計算出元素在散列表中的位置，然后將元素插入該位置即可。對於相同的元素，自然是只保存了一個。
        由此可知，若兩個元素相等，它們的散列碼一定相等；但反過來確不一定。在散列表中，
                           1、如果兩個對象相等，那么它們的hashCode()值一定要相同；
                           2、如果兩個對象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 [e-mail]
 */
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 [e-mail]
 */
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 [e-mail]
 */
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被視為不相等。

 

---

更多內容

Java 集合系列目錄

Java 集合系列08之 List總結(LinkedList, ArrayList等使用場景和性能分析)

Java 集合系列10之 HashMap詳細介紹(源碼解析)和使用示例

Java 集合系列11之 Hashtable詳細介紹(源碼解析)和使用示例

Java 集合系列12之 TreeMap詳細介紹(源碼解析)和使用示例 

Java 集合系列18之 Iterator和Enumeration比較