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

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

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

在寫這個篇文章的時候,我自認為這個東西應該沒啥技術含量旁蔼。實際上也是如此锨苏。

但是這里強調的是對于這個方法我們看到的本質:思考!

就和之前看到有個問題 :

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

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

還是老薛一直強調了學習!=記憶 限佩,代碼能力 != 會寫 葵诈。更多時候多些思考,和恍然大悟這才是核心祟同。

那么我們一起來看看關于equals方法有什么值得我們思考的點驯击。

如何生成equals方法

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

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

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

我們思考一個邏輯几睛,按道理而言,不管是用工具自帶的關鍵件也好粤攒,或者是組件的生成也罷所森。

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

產生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)]

最核心的代碼就在這里掩幢,左側是IDEA自動生成的使用getClass比較,右側是通過lombok生成的使用instanceof比較上鞠。

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

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經理類驼唱。

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

我們認為兩個員工的姓名相同玫恳、年齡相同辨赐,在這樣的情況下的我們就認為他們是相等的。

所以我們的代碼大致應該是這樣的:

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

那么我們如何判定兩個emp對象是否相等呢?

我們編寫方法如下:

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

}

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

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

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

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

啥财饥?沒理解换吧? 看代碼!T啃恰沾瓦!

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

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

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

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 最后的結果是false
  • 使用instanceof最后的結果是true;

你沒有看錯乖篷,原因估計你也猜到了就是因為instanceof 判定會把子類判定父類類型得到的結果也是true响驴。

所以導致的結果就是:

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

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

那么到底什么時候用instanceof鲸沮,什么時候用getClass呢琳骡?

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

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

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

后面的一些彩蛋炫狱,關于上面的員工和經理的例子中,假設我們判定是否相等是查看當前員工的編號剔猿,那么此時* equals****方法應該就聲明為****final****视译,并且內部只需要通過****instanceof****來進行判定;但是如果經理中姓名归敬、年齡酷含、獎金都相等我們才認為這兩個經理相等,那么就需要通過****getClass****進行判定汪茧。*

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

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

  • (1)自反性:對于任何非空引用,x.equals(x)應該返回true舱污;
  • (2)對稱性:對于任何引用x和y呀舔,當且僅當y.equals(x)返回true,x.equals(y)也應該返回true扩灯;
  • (3)傳遞性:對于任何引用x别威、y和z,如果x.equals(y)返回true驴剔,y.equals(z)返回true,x.equals(z)也應該返回true粥庄;
  • (4)一致性:如果x和y引用的對象沒有發(fā)生變化丧失,反復調用x.equals(y)應該返回同樣的結果;
  • (5)對于任意非空引用x惜互,x.equals(null)應該返回false布讹。

當然這個東西都很好理解琳拭,其實關于我們上文說的內容,最核心的就是 :

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

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

總結一下

好了彭谁,關于編寫equals方法吸奴,你學會了嗎?

大致流程總共就這幾步:

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

  • 檢測傳入對象是否為null

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

    • 如果是每個子類都需要重新定義自己的比較功能 使用getClass比較则奥;
    • 如果子類可以交由父類直接進行判定,則使用instanceof比較狭园;
  • 進行類型轉換

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

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

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

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末揖赴,一起剝皮案震驚了整個濱河市馆匿,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌燥滑,老刑警劉巖渐北,帶你破解...
    沈念sama閱讀 211,265評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異铭拧,居然都是意外死亡赃蛛,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,078評論 2 385
  • 文/潘曉璐 我一進店門搀菩,熙熙樓的掌柜王于貴愁眉苦臉地迎上來呕臂,“玉大人,你說我怎么就攤上這事肪跋∑缃” “怎么了?”我有些...
    開封第一講書人閱讀 156,852評論 0 347
  • 文/不壞的土叔 我叫張陵,是天一觀的道長谜洽。 經常有香客問我萝映,道長,這世上最難降的妖魔是什么阐虚? 我笑而不...
    開封第一講書人閱讀 56,408評論 1 283
  • 正文 為了忘掉前任序臂,我火速辦了婚禮,結果婚禮上实束,老公的妹妹穿的比我還像新娘奥秆。我一直安慰自己,他們只是感情好磕洪,可當我...
    茶點故事閱讀 65,445評論 5 384
  • 文/花漫 我一把揭開白布吭练。 她就那樣靜靜地躺著,像睡著了一般析显。 火紅的嫁衣襯著肌膚如雪鲫咽。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,772評論 1 290
  • 那天谷异,我揣著相機與錄音分尸,去河邊找鬼。 笑死歹嘹,一個胖子當著我的面吹牛箩绍,可吹牛的內容都是我干的。 我是一名探鬼主播尺上,決...
    沈念sama閱讀 38,921評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼材蛛,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了怎抛?” 一聲冷哼從身側響起卑吭,我...
    開封第一講書人閱讀 37,688評論 0 266
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎马绝,沒想到半個月后豆赏,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經...
    沈念sama閱讀 44,130評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡富稻,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,467評論 2 325
  • 正文 我和宋清朗相戀三年掷邦,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片椭赋。...
    茶點故事閱讀 38,617評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡抚岗,死狀恐怖,靈堂內的尸體忽然破棺而出哪怔,到底是詐尸還是另有隱情宣蔚,我是刑警寧澤廷痘,帶...
    沈念sama閱讀 34,276評論 4 329
  • 正文 年R本政府宣布,位于F島的核電站件已,受9級特大地震影響,放射性物質發(fā)生泄漏元暴。R本人自食惡果不足惜篷扩,卻給世界環(huán)境...
    茶點故事閱讀 39,882評論 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望茉盏。 院中可真熱鬧鉴未,春花似錦、人聲如沸鸠姨。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,740評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽讶迁。三九已至连茧,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間巍糯,已是汗流浹背啸驯。 一陣腳步聲響...
    開封第一講書人閱讀 31,967評論 1 265
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留祟峦,地道東北人罚斗。 一個月前我還...
    沈念sama閱讀 46,315評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像宅楞,于是被迫代替她去往敵國和親针姿。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 43,486評論 2 348

推薦閱讀更多精彩內容