你真的會寫equals方法嗎? 我輸麻了~

本來要休息了,結(jié)果看到了一篇文章,讀完之后大(shi)受(mian)震(le)撼。

本月的第22篇原創(chuàng)文章,努力加油!

在寫這個篇文章的時候,我自認(rèn)為這個東西應(yīng)該沒啥技術(shù)含量。實際上也是如此。

但是這里強調(diào)的是對于這個方法我們看到的本質(zhì):思考!

就和之前看到有個問題 :

你是什么時候感覺到自己的代碼能力開始提升的?

其實代碼能力的提升并不是會寫代碼了,而是一些書寫習(xí)慣你再不斷的優(yōu)化。這種優(yōu)化就是在提升代碼能力了。

還是老薛一直強調(diào)了學(xué)習(xí)!=記憶 ,代碼能力 != 會寫 。更多時候多些思考,和恍然大悟這才是核心。

那么我們一起來看看關(guān)于equals方法有什么值得我們思考的點。

如何生成equals方法

大家現(xiàn)在寫這個方法,會怎么做呢?

  • 快捷鍵自動生成;
  • 通過使用lombok@EquaksAndHashCode注解
  • 在代碼中使用Objects.equals(this,other)完成;
  • 直接return,比較幾個對應(yīng)的屬性結(jié)束;

對于這些其實都沒有問題的。我想帶大家看的是,通過IDEA生成的equals方法和使用lombok生成的equals方法竟然邏輯不太一樣。另外你如果注意觀察看Java API的源碼,你會發(fā)現(xiàn)他們也有所區(qū)別。

我們思考一個邏輯,按道理而言,不管是用工具自帶的關(guān)鍵件也好,或者是組件的生成也罷。

既然能自動生成,那么一定是有一個對應(yīng)的范式來規(guī)范代碼內(nèi)容。那么為什么API中還會有不同的呢?

產(chǎn)生equals方法大PK

針對于我們編寫的一個類

class User{
    private String name;
    private Integer score;
    private String school;
}

IDEA自動生成的equals方法

@Override
public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    User user = (User) o;
    return Objects.equals(name, user.name) && Objects.equals(score, user.score)
         && Objects.equals(school, user.school);
}

lombok生成的equals方法

public boolean equals(Object o) {
    if (o == this) {
        return true;
    } else if (!(o instanceof User)) {
        return false;
    } else {
        User other = (User)o;
        if (!other.canEqual(this)) {
            return false;
        } else {
            label47: {
                Object this$score = this.score;
                Object other$score = other.score;
                if (this$score == null) {
                    if (other$score == null) {
                        break label47;
                    }
                } else if (this$score.equals(other$score)) {
                    break label47;
                }

                return false;
            }

            Object this$name = this.name;
            Object other$name = other.name;
            if (this$name == null) {
                if (other$name != null) {
                    return false;
                }
            } else if (!this$name.equals(other$name)) {
                return false;
            }

            Object this$school = this.school;
            Object other$school = other.school;
            if (this$school == null) {
                if (other$school != null) {
                    return false;
                }
            } else if (!this$school.equals(other$school)) {
                return false;
            }

            return true;
        }
    }
}

protected boolean canEqual(Object other) {
    return other instanceof User;
}

大家看的時候,因為可能比較長,所以看起來稍微有點不痛快,我把不重要的代碼修改一下,然后看:

[圖片上傳失敗...(image-b62e7f-1692762840105)]

最核心的代碼就在這里,左側(cè)是IDEA自動生成的使用getClass比較,右側(cè)是通過lombok生成的使用instanceof比較。

這只是一個例子,我們在看一個在Java API中也不太一樣的例子。有一個很奇怪的例子,在java.sql.Timestamp這個類中,你會發(fā)現(xiàn)竟然有兩個equals方法,而這兩個方法的參數(shù)竟然是父子關(guān)系。

public boolean equals(Timestamp ts) {
    if (super.equals(ts)) {
        if  (nanos == ts.nanos) {
            return true;
        } else {
            return false;
        }
    } else {
        return false;
    }
}

public boolean equals(java.lang.Object ts) {
  if (ts instanceof Timestamp) {
    return this.equals((Timestamp)ts);
  } else {
    return false;
  }
}

這都是為什么呢? 為什么一個簡單的equals方法會如此的奇怪? 到底是為什么出現(xiàn)了這樣的變化呢?

說明問題

instanceof和getClass到底怎么用?

為了更好的說明問題,我們這里通過一些代碼的例子來說明這個問題。

我們現(xiàn)在有兩個類,一個類是父類emp員工類,還有一個類是manager經(jīng)理類。

在這樣的情況下,我們知道對于任意兩個相同的對象比如emp,判定他們相等是一個很簡單的過程。

我們認(rèn)為兩個員工的姓名相同、年齡相同,在這樣的情況下的我們就認(rèn)為他們是相等的。

所以我們的代碼大致應(yīng)該是這樣的:

@Getter
@Setter
public class Emp{
    protected String name;
    protected Integer age;
}
@Getter
@Setter
public class Manager extends Emp{
    protected Integer bonus;
}

那么我們?nèi)绾闻卸▋蓚€emp對象是否相等呢?

我們編寫方法如下:

@Override
public boolean equals(Object obj){
    // 如果兩個對象的地址相同 則直接返回true
    if (this == obj)
        return true;
    // 因為要進(jìn)行比較 所以判定傳入對象是否為null 不為null 往下走
    // 如果為null 則直接返回false
    if (obj == null)
        return false;
    // 繼續(xù)判定傳入對象的class對象是否一致 不一致則直接返回false
    if (this.getClass() != obj.getClass())
        return false;
    // 接下來能夠確定傳入的對象就是一個emp對象
    Emp otherObj = (Emp)obj;
    // 判定對應(yīng)的每個屬性的值
    return this.name.equals(otherObj.name)
            &&this.age == otherObj.age;

}

這個代碼最后的返回結(jié)果還是有些小瑕疵,因為每次都需要考慮對象屬性為null的情況,所以建議修改為如下:

return Objects.equals(this.name,otherObj.name)
            &&Objects.equals(this.age,otherObj.age);

針對與這個代碼,我們一起來考慮一下,為什么這里比較的使用getClass 而不是使用instanceof?

這里原因就在與如果出現(xiàn)了父子類的情況呢?

啥?沒理解? 看代碼!??!

[圖片上傳失敗...(image-c3e958-1692762840105)]

我們只需要把紅色框框的代碼互相掉個個,然后測試即可。

你會發(fā)現(xiàn)我們通過下面的代碼進(jìn)行測試,但是得到的結(jié)果是不同的。

Emp emp = new Emp();
emp.name = "zhangsan";
emp.age = 123;
Manager manager = new Manager();
manager.name = "zhangsan";
manager.age = 123;

System.out.println(emp.equals(manager));
  • 使用getClass 最后的結(jié)果是false;
  • 使用instanceof最后的結(jié)果是true;

你沒有看錯,原因估計你也猜到了就是因為instanceof 判定會把子類判定父類類型得到的結(jié)果也是true

所以導(dǎo)致的結(jié)果就是:

Instanceof 不光沒有解決傳入對象是子類的問題,并且還引出來了程序的其他問題。

如果你習(xí)慣性的在代碼中使用instanceof來判定的話,是不是需要注意了呢?

那么到底什么時候用instanceof,什么時候用getClass呢?

在《Java核心技術(shù)卷 卷1》中給出的是:

1: 如果子類能夠擁有自己相等概念,則對稱性需求需要強制采用getClass進(jìn)行檢測;

2: 如果通過父類來確定相等的概念,則使用instanceof來進(jìn)行檢測,這樣可以在不同的子類對象中進(jìn)行相等比較。

后面的一些彩蛋,關(guān)于上面的員工和經(jīng)理的例子中,假設(shè)我們判定是否相等是查看當(dāng)前員工的編號,那么此時* equals****方法應(yīng)該就聲明為****final****,并且內(nèi)部只需要通過****instanceof****來進(jìn)行判定;但是如果經(jīng)理中姓名、年齡、獎金都相等我們才認(rèn)為這兩個經(jīng)理相等,那么就需要通過****getClass****進(jìn)行判定。*

為什么會出現(xiàn)兩個equals方法

關(guān)于equals方法,Java語言規(guī)范要求:

  • (1)自反性:對于任何非空引用,x.equals(x)應(yīng)該返回true;
  • (2)對稱性:對于任何引用x和y,當(dāng)且僅當(dāng)y.equals(x)返回true,x.equals(y)也應(yīng)該返回true;
  • (3)傳遞性:對于任何引用x、y和z,如果x.equals(y)返回true,y.equals(z)返回true,x.equals(z)也應(yīng)該返回true;
  • (4)一致性:如果x和y引用的對象沒有發(fā)生變化,反復(fù)調(diào)用x.equals(y)應(yīng)該返回同樣的結(jié)果;
  • (5)對于任意非空引用x,x.equals(null)應(yīng)該返回false。

當(dāng)然這個東西都很好理解,其實關(guān)于我們上文說的內(nèi)容,最核心的就是 :

父類.equals(子類) 和子類.equals(父類) 的對稱性一定要滿足。

但是在Timestamp類中,因為它繼承了Date,而在Date中使用了instanceof就像我們上文說的,就會出現(xiàn)對稱性得不到滿足。所以為了保證這一點,不得不在自己的類中,聲明了兩個equals方法,以達(dá)到我們想要的目的。

總結(jié)一下

好了,關(guān)于編寫equals方法,你學(xué)會了嗎?

大致流程總共就這幾步:

  • 先判定兩個對象地址是否相等;

  • 檢測傳入對象是否為null

  • 判定來年各個對象是否是同一個類

    • 如果是每個子類都需要重新定義自己的比較功能 使用getClass比較;
    • 如果子類可以交由父類直接進(jìn)行判定,則使用instanceof比較;
  • 進(jìn)行類型轉(zhuǎn)換

  • 使用==比較基本數(shù)據(jù)類型,使用Objects.equals來比較兩個對象的引用類型的屬性;

如果覺得不錯,請各位記得點贊、點個在看哦!!!

版權(quán)聲明:本站所有文章除特別聲明外,均采用 CC BY-NC-ND 4.0
轉(zhuǎn)載請注明來自 kengwanglaoxue
當(dāng)前文章作者名:kengwanglaoxue
當(dāng)前文章標(biāo)題:你真的會寫equals方法嗎?
當(dāng)前文章原創(chuàng)地址:https://997coder.com/equals.html

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容