為何修改equals方法時還要重寫hashcode方法的原因分析

Posted on 2021-06-09 by WalkonNet

為何修改equals方法時還要重寫hashcode方法

雖然在實際開發中，我們已經使用到散列集合(如HashMap),或也單獨學過散列（Hash）。

但是也會有很多人像我一樣，看到有些時候別人寫的pojo中有對對象內hashcode函數做一個重寫，這就讓我重新思考為什麼要這麼做? 下面就讓我和你一起去探索一下吧!

Hash是什麼?

Hash就是上文說到的散列，是把任意長度的輸入(又叫做預映射pre-image）通過散列算法變換成固定長度的輸出，該輸出就是散列值。它的理論時間復雜度是可以達到O(1),但一般來說，這個散列函數是極難設計的。說到散列值，就是通過散列函數轉化出來的：

如果兩個散列值是不一樣y(x1)!=y(x2)，那麼這兩個散列值的原始輸入一定是不一樣的。

如果兩個散列值出現瞭相等，那麼並不代碼這兩個散列值的原始輸入一定是一樣的，可能是屬於哈希碰撞(不同關鍵字經過散列變換結果是一樣的的現象);

對於哈希函數有哪些我也不再介紹，想瞭解可以直接去查散列函數的。

Hashcode作用

很多情況下我們也許都會用到hash表來做提高查詢效率，那麼這個hash表是如何提高效率的?其實就是基於上面所說的散列函數，根據設計的散列函數，我們對於每一個關鍵字都有唯一的散列值，那麼就能夠直接根據這個散列值直接就能找到元素在集合中的位置，從而獲得其值，這對於集合的一個個對象進行比較來說，是提高瞭很多的。

在這裡插入圖片描述

通過以上操作，我們很容易就能理解為啥散列技術在查詢的復雜度是能達到O(1).

但是一般來說java都會內置瞭hashcode的實現,那為什麼在寫對象的時候，隻要對equals進行重寫，都推薦對hashcode進行重寫呢?

看HashCode的常規協定：

在 Java 應用程序執行期間，在同一對象上多次調用 hashCode 方法時，必須一致地返回相同的整數，前提是對象上 equals 比較中所用的信息沒有被修改。從某一應用程序的一次執行到同一應用程序的另一次執行，該整數無需保持一致。

如果根據 equals(Object) 方法，兩個對象是相等的，那麼在兩個對象中的每個對象上調用 hashCode 方法都必須生成相同的整數結果。

以下情況不是必需的：

如果根據 equals(java.lang.Object) 方法，兩個對象不相等，那麼在兩個對象中的任一對象上調用 hashCode 方法必定會生成不同的整數結果。但是，程序員應該知道，為不相等的對象生成不同整數結果可以提高哈希表的性能。

實際上，由 Object 類定義的 hashCode 方法確實會針對不同的對象返回不同的整數。（這一般是通過將該對象的內部地址轉換成一個整數來實現的，但是 JavaTM 編程語言不需要這種實現技巧。）

當equals方法被重寫時，通常有必要重寫 hashCode 方法，以維護 hashCode 方法的常規協定，該協定聲明相等對象必須具有相等的哈希碼。

根據以上知道，java內部的一個實現是以地址來的，如果對equals進行重寫瞭，也就是對象你判斷相等時不再以java提供的方法，那麼將來在使用hash表的時候，就會存在equals是相等的，但hashcode卻是不相等的!

所以建議：在修改equals的方法時，記得修改hashcode方法!!!

下面做個小例子

/**
 * @author: Kilig
 * @date: 2020/6/22 21:18
 * @description:
 */
public class User {
    private int id;
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof User)) return false;
        User user = (User) o;
        return getId() == user.getId();
    }
//    @Override
//    public int hashCode() {
//        return Objects.hash(getId());
//    }
}

public static void main(String[] args) {
        User a=new User();
        User b=new User();
        a.setId(1);
        b.setId(1);
        System.out.println(a.equals(b));
        System.out.println(a.hashCode() == b.hashCode());
    }

運行結果

在這裡插入圖片描述

嘗試將其放到set集合時

看到這結果顯然不是我們想要的，因為我兩個對象相等，其“`hashcode也應相等,然而結果卻是在不可重復的set集合中存瞭兩個對象，所以我們做一個改進，對User進行重寫hashcode“方法。

  @Override
    public int hashCode() {
        return Objects.hash(getId()); //使用默認的hash函數處理關鍵字，這裡是ID，我們認為Id相等的用戶其就是同一個用戶
    }

然後看看set的結果：

在這裡插入圖片描述

的確符合我們預期結果。

基於以上的學習，我們也基本瞭解為啥在修改equals方法時也要對hashcode進行修改。

Java重寫equals()方法的步驟

Java語言規范要求equals方法具有下面的特性：

自反性：對於任何非空引用x，x.equals(x)應該返回true
對稱性：對於任何引用x和y，當且僅當y.equals(x)返回true，x.equals(y)也應該返回true
傳遞性：對於任何引用x和y和z，如果x.equal(y)返回true，y.equals(z)返回true，x.equals(z)也應該返回true
一致性：如果x和y引用的對象沒有發生變化，反復調用x.equals(y)應該返回同樣的結果
對於任意非空引用x，x.equals(null)應該返回false

重寫equals()方法的步驟：

顯式參數命名為otherObject，稍後需要將它轉換成另一個叫做other的變量

檢測this與otherObject是否引用同一個對象

if (this == otherObject) 
    return true;

檢測otherObject是否為null，是則返回false

if (this == null) 
    return false;

比較this與otherObject是否屬於同一個類。如果equals的語義在每個子類中有所改變，就使用getClass檢測

if (getClass() != otherObject.getClass()) 
    return false;

如果所有的子類都擁有統一的語義，就使用instanceof檢測

if (!(otherObject instanceof ClassName)) 
    return false;

將otherObject轉換成相應的類類型變量

ClassName other = (ClassName) otherObject

將other需要比較的域成員都進行比較，隻要有一個不同都返回false

需要註意的是，如果重新定義瞭equals()方法，就必須重新定義hashCode()方法，以便用戶可以將對象插入到散列表中。

equals()方法與hashCode()方法的定義必須保持一致，即如果equals()返回true，則2個對象的hashCode()必須具有相同的值。

重寫equals()方法中有提到，我們需要將要比較的域成員都進行比較，那麼我們在重寫hashCode()方法時可以將這些域成員的散列值組合起來，這樣就能保證它與equals()方法具有一致性瞭。

假設需被比較的域成員為field_1、field_2與field_3，那麼我們可以編寫一下hashCode()方法：

public int hashCode() {
    return Objects.hash(field_1, field_2, field_3);
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

為何修改equals方法時還要重寫hashcode方法的原因分析