Java中怎麼正確重寫equals方法

1. 什麼是equals方法？

我們首先得知道，Object類別是Java中所有類別的父類別(超類別/基底類別)，也就是說，在Java 中，所有的類別都是預設繼承自Object類別的，換言之，Object類別中所實作的方法我們都可以直接拿來用。而equals方法便是Object類別所實作的眾多方法之一。

以下截圖自Java11 API

#Object類別的所有方法：

1.1 equals方法：

• equals：是Object類別中的方法，只能判斷引用類型，等下可以帶大夥看看jdk原始碼

• 預設判斷的是位址是否相等（因為引用型別變數底層本質就是來儲存物件位址的，有C/C 知識的小夥伴應該很了解），在子類別中往往會重寫該方法，用於判斷物件的內容是否相等。例如等下會簡單了解到的Integer和String(在IDEA裡看原始碼實作)

2. 為什麼要重寫equals方法？

我們有Object類別實作的equals方法能用不就行了？為啥還得重寫equals方法呢？這就要來看看Object類別的equals方法實作機制了。

我們可以清楚地看到，Object類別的equals方法底層是用== 來實現的，也就是說它的用法跟我們平常用來比較基本資料型別的== 用法一致。我們先來看看== 的語法：

• == 只能用來比較基本資料型態是否相等，也就是單純的值比較;

• == 在比較浮點數的時候也可能有失效的情況，這是因為浮點數的儲存機制跟整數家族不一樣，浮點數本身就不能表示一個精確的值（具體原因可自行查看IEEE 754規則，這裡不再展開）

所以我們在單純的進行基本資料型別的值比較時可以用== ，而比較引用資料型別就不能這麼做，前面有提到，引用資料型別本質上是來引用/儲存物件的位址的，所有你完全可以把它當作C/C 的指標來看待（這裡槓一句說Java沒有指標的，個人覺得只是叫法不同罷了）
註： 不要把Java引用跟C 引用搞混了，C 引用其實是指標常數，即int* const，這也是C 的引用只能作為變數的別名的原因。

2.1 舉個例子吧~

比較兩個int時可以直接用== ，當它們相等時結果為true，而當new了兩個屬性完全一樣的物件時，再用== 來進行比較就會出現錯誤，如我們所見，明明我們應該想要得到true的，結果卻是false
源碼：

#運行結果：

到這裡，我們應該大致清楚為啥要在比較物件時重寫equals方法了，因為Object類別提供給我們的不好使~~

3.分析equals原始碼：

在進行重寫之前，我們依舊來看看Java API中的定義：
public boolean equals(Object obj)
作用：指示某個其他物件是否「等於」此物件。

equals方法在非null物件參考上實現等價關係：

• #自反性：對於任何非空的參考值x ， x.equals(x)應該回傳true 。

• 對稱性：對於任何非空參考值x和y ， x.equals(y)應該傳回true當且僅當y.equals(x)回報true 。

• 傳遞性：對於任何非空引用值x ， y和z ，如果x. equals(y)回報true個y.equals(z)回報true ，然後x.equals(z)應該回傳true 。

• 一致性：對於任何非空引用值x和y ，多次呼叫x.equals(y)總是傳回true或始終傳回false ，前提是未修改物件上的equals比較中使用的資訊。

• 對於任何非空的參考值x ，x.equals(null)應該傳回false。

類別Object的equals方法實作了物件上最具區別的可能等價關係; 也就是說，對於任何非空參考值x和y ，當且僅當x和y引用同一物件（ x == y具有值true ）時，此方法傳回true 。

注意：通常需要在重寫此方法時覆寫hashCode方法，以便維護hashCode方法的常規協定，該方法聲明相等物件必須具有相等的雜湊程式碼。

接下來看看在String類別中重寫的equals方法和Integer類別中重寫的equals方法：

//String类equals源代码：
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;
    }

#簡單解讀一下就是當對比的是同一個物件時，直接回傳true，提高效率。當傳進來的物件是當前類別的實例時，進入進一步的判斷，一個for循環依次遍歷字串每一個字符，只要有一個字符不同就返回false。

繼續來看看Integer類別的equals原始程式碼：

//Integer类的equals源代码:
 public boolean equals(Object obj) {
        if (obj instanceof Integer) {
            return value == ((Integer)obj).intValue();
        }
        return false;
    }

Integer類的equals原始碼簡單許多，只要傳入的物件是當前類別的實例，就進行進一步的判斷：當它們的值相等時，就傳回true，不相等就回傳false。

這裡還是來實際示範⑧，就以Integer類別為例：

很明顯，我們知道 Integer類別重寫了equals方法且是引用型別。當直接用 == 來比較引用型別變數時，結果是false，而用equals判斷結果為true。這便很好地說明了重寫equals方法的必要性。 String類別大夥自己去驗證一哈⑧。

4. 正確重寫equals方法：

（先說結論，getClass()比instanceof更安全）

到這裡，我們基本上把equals方法的各種原始碼都分析了一遍，接下來就是我們自己要來實作equals方法了。

這裡提供兩個比較常見的equals重寫方法：

• #用instanceof實作重寫 equals方法

• 用getClass實作重寫equals方法

假設有此場景：

在已經建立好的長方形類別中重寫Object類別中的equals方法為當長方形的長和寬相等時，傳回TRUE，同時重寫hashCode方法，重寫toString方法為顯示長方形的長寬資訊。並測試類別。

package com.test10_04;

import java.util.Objects;

class Rectangle {
    private double length;
    private double wide;

    public Rectangle() {
        //空实现
    }
    public Rectangle(double length, double wide) {
        setLength(length);
        setWide(wide);
    }

    public double getLength() {
        return length;
    }

    public void setLength(double length) {
        assert length > 0.0 : "您的输入有误，长方形的长不能小于0";
        this.length = length;
    }

    public double getWide() {
        return wide;
    }

    public void setWide(double wide) {
        assert wide > 0.0 : "您的输入有误，长方形的宽不能小于0";
        this.wide = wide;
    }

    public double area() {
        return this.length * this.wide;

    }
    public double circumference() {
        return 2 * (this.wide + this.length);
    }

    public boolean equals(Object obj) {
        if (this == obj) { //判断一下如果是同一个对象直接返回true，提高效率
            return true;
        }
        if (obj == null || obj.getClass() != this.getClass()) { //如果传进来的对象为null或者二者为不同类，直接返回false
            return false;
        }
        //也可以以下方法：
//        if (obj == null || !(obj instanceof Rectangle)) { //如果传进来的对象为null或者二者为不同类，直接返回false
//            return false;
//        }
        Rectangle rectangle = (Rectangle) obj; //向下转型
        //比较长宽是否相等，注意：浮点数的比较不能简单地用==，会有精度的误差，用Math.abs或者Double.compare
        return Double.compare(rectangle.length, length) == 0 && Double.compare(rectangle.wide, wide) == 0;
    }

    public int hashCode() { //重写equals的同时也要重写hashCode，因为同一对象的hashCode永远相等
        return Objects.hash(length, wide); //调用Objects类，这是Object类的子类
    }

    public String toString() {
        return "Rectangle{" + "length=" + length + ", wide=" + wide + '}';
    }
}

public class TestDemo {
    public static void main(String[] args) {

        Rectangle rectangle1 = new Rectangle(3.0, 2.0);
        Rectangle rectangle2 = new Rectangle(3.0, 2.0);
        
        System.out.println(rectangle1.equals(rectangle2));
        System.out.println("rectangle1哈希码:" + rectangle1.hashCode() +
                "\nrectangle2哈希码:" + rectangle2.hashCode());
        System.out.println("toString打印信息：" + rectangle1.toString());
    }
}

具體實作想法在程式碼中講的很清楚了，我們這裡重點分析一下getClass和instanceof兩種實作方法的優缺點：

將程式碼邏輯簡化一下：
我們就重點看這段簡單的程式碼

//getClass()版本
public class Student {
	private String name;
	
    public void setName(String name) {
        this.name = name;
    }
	@Override
	public boolean equals(Object object){
		if (object == this)
			return true;
		// 使用getClass()判断对象是否属于该类
		if (object == null || object.getClass() != getClass())
			return false;
		Student student = (Student)object;
		return name != null && name.equals(student.name);
}

//instanceof版本
public class Student {
	private String name;
	
    public void setName(String name) {
       this.name = name;
   }
	@Override
	public boolean equals(Object object){
		if (object == this)
			return true;
		// 通过instanceof来判断对象是否属于类
		if (object == null || !(object instanceof Student))
			return false;
		Student student = (Student)object;
		return name!=null && name.equals(student.name);
	}
}

事實上兩個方案都是有效的，差別就是getClass()限制了物件只能是同一個類，而instanceof卻允許物件是同一個類別或其子類，這樣equals方法就變成了父類別與子類也可進行equals操作了，這時候如果子類別重定義了equals方法，那麼就可能變成父類別物件equlas子類別物件為true，但是子類別物件equlas父類別物件就為false了，如下所示:

class GoodStudent extends Student {

    @Override
    public boolean equals(Object object) {
        return false;
    }

    public static void main(String[] args) {
        GoodStudent son = new GoodStudent();
        Student father = new Student();

        son.setName("test");
        father.setName("test");

		// 当使用instance of时
        System.out.println(son.equals(father)); // 这里为false
        System.out.println(father.equals(son)); // 这里为true

		// 当使用getClass()时
        System.out.println(son.equals(father)); // 这里为false
        System.out.println(father.equals(son)); // 这里为false	
    }
}

注意看這裡用的是getClass()

#回傳值兩個都是false ，符合我們的預期，（連類別都不一樣那肯定得為false啊）

#而換成instanceof試試看咯：

運行結果：一個為true一個為false，很明顯出現問題了。

這裡的原因如下：
instanceof的語法是這樣的：
當一個物件為一個類別的實例時，結果才為true。但它還有一個特點就是，如果當這個物件時其子類別的實例時，結果也會為true。這便導致了上述的bug。也就是說當比較的兩個對象，他們的類別是父子關係時，instanceof可能會出現問題。 **需要深究的夥伴可以自己去了解一哈，所以在這裡建議在實作重寫equals方法時，盡量使用getClass來實作。

在重寫equals方法的同時需要重寫hashCode方法。

以上是Java中怎麼正確重寫equals方法的詳細內容。更多資訊請關注PHP中文網其他相關文章！