詳解equals()方法和hashCode()方法

程式設計迷思發表於2017-07-16

前言

Java的基類Object提供了一些方法,其中equals()方法用於判斷兩個物件是否相等,hashCode()方法用於計算物件的雜湊碼。equals()和hashCode()都不是final方法,都可以被重寫(overwrite)。

本文介紹了2種方法在使用和重寫時,一些需要注意的問題。

如果覺得文章對你有幫助,歡迎點贊或轉載。文章有疏漏之處,歡迎批評指正。

目錄

一、equal()方法

二、hashCode()方法

  1、Object的hashCode()

  2、hashCode()的作用

三、String中equals()和hashCode()的實現

四、如何重寫hashCode()

  1、重寫hashcode()的原則

  2、hashCode()重寫方法

一、equal()方法

 Object類中equals()方法實現如下:

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

通過該實現可以看出,Object類的實現採用了區分度最高的演算法,即只要兩個物件不是同一個物件,那麼equals()一定返回false。

雖然我們在定義類時,可以重寫equals()方法,但是有一些注意事項;JDK中說明了實現equals()方法應該遵守的約定:

(1)自反性:x.equals(x)必須返回true。

(2)對稱性:x.equals(y)與y.equals(x)的返回值必須相等。

(3)傳遞性:x.equals(y)為true,y.equals(z)也為true,那麼x.equals(z)必須為true。

(4)一致性:如果物件x和y在equals()中使用的資訊都沒有改變,那麼x.equals(y)值始終不變。

(5)非null:x不是null,y為null,則x.equals(y)必須為false。

二、hashCode()方法

1、Object的hashCode()

Object類中hashCode()方法的宣告如下:

public native int hashCode();

可以看出,hashCode()是一個native方法,而且返回值型別是整形;實際上,該native方法將物件在記憶體中的地址作為雜湊碼返回,可以保證不同物件的返回值不同。

與equals()方法類似,hashCode()方法可以被重寫。JDK中對hashCode()方法的作用,以及實現時的注意事項做了說明:

(1)hashCode()在雜湊表中起作用,如java.util.HashMap。

(2)如果物件在equals()中使用的資訊都沒有改變,那麼hashCode()值始終不變。

(3)如果兩個物件使用equals()方法判斷為相等,則hashCode()方法也應該相等。

(4)如果兩個物件使用equals()方法判斷為不相等,則不要求hashCode()也必須不相等;但是開發人員應該認識到,不相等的物件產生不相同的hashCode可以提高雜湊表的效能。

2、hashCode()的作用

總的來說,hashCode()在雜湊表中起作用,如HashSet、HashMap等。

當我們向雜湊表(如HashSet、HashMap等)中新增物件object時,首先呼叫hashCode()方法計算object的雜湊碼,通過雜湊碼可以直接定位object在雜湊表中的位置(一般是雜湊碼對雜湊表大小取餘)。如果該位置沒有物件,可以直接將object插入該位置;如果該位置有物件(可能有多個,通過連結串列實現),則呼叫equals()方法比較這些物件與object是否相等,如果相等,則不需要儲存object;如果不相等,則將該物件加入到連結串列中。

這也就解釋了為什麼equals()相等,則hashCode()必須相等。如果兩個物件equals()相等,則它們在雜湊表(如HashSet、HashMap等)中只應該出現一次;如果hashCode()不相等,那麼它們會被雜湊到雜湊表的不同位置,雜湊表中出現了不止一次。

實際上,在JVM中,載入的物件在記憶體中包括三部分:物件頭、例項資料、填充。其中,物件頭包括指向物件所屬型別的指標和MarkWord,而MarkWord中除了包含物件的GC分代年齡資訊、加鎖狀態資訊外,還包括了物件的hashcode;物件例項資料是物件真正儲存的有效資訊;填充部分僅起到佔位符的作用, 原因是HotSpot要求物件起始地址必須是8位元組的整數倍。

三、String中equals()和hashCode()的實現

String類中相關實現程式碼如下:

    private final char value[];
    private int hash; // Default to 0
    public boolean equals(Object anObject) {
        if (this == anObject) {
            return true;
        }
        if (anObject instanceof String) {
            String anotherString = (String)anObject;
            int n = value.length;
            if (n == anotherString.value.length) {
                char v1[] = value;
                char v2[] = anotherString.value;
                int i = 0;
                while (n-- != 0) {
                    if (v1[i] != v2[i])
                        return false;
                    i++;
                }
                return true;
            }
        }
        return false;
    }
    public int hashCode() {
        int h = hash;
        if (h == 0 && value.length > 0) {
            char val[] = value;

            for (int i = 0; i < value.length; i++) {
                h = 31 * h + val[i];
            }
            hash = h;
        }
        return h;
    }

通過程式碼可以看出以下幾點:

1、String的資料是final的,即一個String物件一旦建立,便不能修改;形如String s = "hello"; s = "world";的語句,當s = "world"執行時,並不是字串物件的值變為了"world",而是新建了一個String物件,s引用指向了新物件。

2、String類將hashCode()的結果快取為hash值,提高效能。

3、String物件equals()相等的條件是二者同為String物件,長度相同,且字串值完全相同;不要求二者是同一個物件。

4、String的hashCode()計算公式為:s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]

 

關於hashCode()計算過程中,為什麼使用了數字31,主要有以下原因:

1、使用質數計算雜湊碼,由於質數的特性,它與其他數字相乘之後,計算結果唯一的概率更大,雜湊衝突的概率更小。

2、使用的質數越大,雜湊衝突的概率越小,但是計算的速度也越慢;31是雜湊衝突和效能的折中,實際上是實驗觀測的結果。

3、JVM會自動對31進行優化:31 * i == (i << 5) - i

 四、如何重寫hashCode()

本節先介紹重寫hashCode()方法應該遵守的原則,再介紹通用的hashCode()重寫方法。

1、重寫hashcode()的原則

通過前面的描述我們知道,重寫hashCode需要遵守以下原則:

(1)如果重寫了equals()方法,檢查條件“兩個物件使用equals()方法判斷為相等,則hashCode()方法也應該相等”是否成立,如果不成立,則重寫hashCode ()方法。

(2)hashCode()方法不能太過簡單,否則雜湊衝突過多。

(3)hashCode()方法不能太過複雜,否則計算複雜度過高,影響效能。

2、hashCode()重寫方法

《Effective Java》中提出了一種簡單通用的hashCode演算法
A、初始化一個整形變數,為此變數賦予一個非零的常數值,比如int result = 17;
B、選取equals方法中用於比較的所有域(之所以只選擇equals()中使用的域,是為了保證上述原則的第1條),然後針對每個域的屬性進行計算:
(1) 如果是boolean值,則計算f ? 1:0
(2) 如果是byte\char\short\int,則計算(int)f
(3) 如果是long值,則計算(int)(f ^ (f >>> 32))
(4) 如果是float值,則計算Float.floatToIntBits(f)
(5) 如果是double值,則計算Double.doubleToLongBits(f),然後返回的結果是long,再用規則(3)去處理long,得到int
(6) 如果是物件應用,如果equals方法中採取遞迴呼叫的比較方式,那麼hashCode中同樣採取遞迴呼叫hashCode的方式。否則需要為這個域計算一個正規化,比如當這個域的值為null的時候,那麼hashCode 值為0
(7) 如果是陣列,那麼需要為每個元素當做單獨的域來處理。java.util.Arrays.hashCode方法包含了8種基本型別陣列和引用陣列的hashCode計算,演算法同上。
C、最後,把每個域的雜湊碼合併到物件的雜湊碼中。

 

下面通過一個例子進行說明。在該例中,Person類重寫了equals()方法和hashCode()方法。因為equals()方法中只使用了name域和age域,所以hashCode()方法中,也只計算name域和age域。

對於String型別的name域,直接使用了String的hashCode()方法;對於int型別的age域,直接用其值作為該域的hash。

public class Person {
	private String name;
	private int age;
	private boolean gender;

	public Person() {
		super();
	}

	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 isGender() {
		return gender;
	}
	public void setGender(boolean gender) {
		this.gender = gender;
	}

	@Override
	public boolean equals(Object another) {
		if (this == another) {
			return true;
		}
		if (another instanceof Person) {
			Person anotherPerson = (Person) another;
			if (this.getName().equals(anotherPerson.getName()) && this.getAge() == anotherPerson.getAge()) {
				return true;
			} else {
				return false;
			}
		}
		return false;
	}

	@Override
	public int hashCode() {
		int hash = 17;
		hash = hash * 31 + getName().hashCode();
		hash = hash * 31 + getAge();
		return hash;
	}
}

 

相關文章