覆蓋equals方法需要注意的

Effective java讀書筆記 第八條

覆蓋equals方法其實是非常有講究的, 許多覆蓋方式會導致錯誤, 并且帶來非常嚴重的后果. 首先看一下文檔上對equals方法是怎么說的吧

Object類的equals方法

自反性, 對稱性, 傳遞性, 有木有想起離散數學=-=

首先看一下哪些情況是不用覆蓋equals方法的, 這樣的話, 類的每個實例都只與它自己相等.

  • 類的每個實例本質上都是唯一的
    什么意思呢, 就是說這個類表示活動實體, 而不是值, 就不需要去覆蓋equals了, Object提供的實現就已經足夠了. 比如說Thread, GUI的控件等等

  • 不關心類是否提供邏輯相等的測試功能
    比如說java.util.Random覆蓋了equals, 用來檢查兩個Random實例產生的隨機數序列是否相同, 其實這并沒有什么卵用啊, Object對于equals的實現就夠啦

  • 超類已經覆蓋了equals, 對于子類也適用*
    這種情況無需再去實現equals

如果類具有自己特有的邏輯相等概念, 而超類的的equals并不是期望的實現的話, 就需要我們去覆蓋equals了.

需要覆蓋equals的時候就需要遵守上面截圖的規范啦:

  • 自反性
    自反性說明一個對象是等于其自身, 自己和自己相等, Object的也就實現了這個了:
publicbooleanequals(Objectobj){
return(this==obj);
}

我就是我, 是顏色不一樣的煙火

  • 對稱性
    簡單來說, 就是a=b成立的話, 那么b=a必定成立.
    來看個例子, 有一個CaseInsensitiveString類, 這個類比較的時候會忽略大小寫:
final class CaseInsensitiveString{
    private final String s;
    public CaseInsensitiveString(String s) throws NullPointerException{
        if (s == null) {
            throw new NullPointerException();
        }
        this.s = s;
    }

    @Override
    public boolean equals(Object o) {
        if(o instanceof CaseInsensitiveString) {
            return s.equalsIgnoreCase(((CaseInsensitiveString) o).s);
        } 
        if(o instanceof String) {
            return s.equalsIgnoreCase((String) o);
        }
        return false;
    }
}

覆蓋了equals, 判斷s與CaseInsensitiveString類的s或者和String忽略大小后是否相等, 否則就返回false, 然后我們來測試一下,

CaseInsensitiveString cis1 = new CaseInsensitiveString("boom!");
        CaseInsensitiveString cis2 = new CaseInsensitiveString("Boom!");
        String s = "BoOM!";
        System.out.println(cis1.equals(cis2));
        System.out.println(cis1.equals(s));
    }

輸出正如我們所料, 都是true, 但是別忘了自反性啊, cis1.equals(s)輸出true, s.equals(cis1)也應該是輸出true的, 事實上s.equals(cis1)的結果是false. 顯然違反了對稱性, String類的equals并不知道不區分大小寫的CaseInsensitiveString類, 因此s.equals(cis1)返回了false.
為了解決這個問題, 只要將企圖與String互操作的那段代碼從equals中刪除就行了

@Override
    public boolean equals(Object o) {
        return o instanceof CaseInsensitiveString && ((CaseInsensitiveString) o).s.equalsIgnoreCase(s);
    }
  • 傳遞性
    最復雜的就是傳遞性了, 離散中最麻煩的也是求傳遞閉包了.
    傳遞性的意思也很簡單的, 就是a=b, b=c的話, 那么a和c也是相等的.

    有一個Point類, 用來表示坐標點
class Point{
    private final int x;
    private final int y;
    
    public Point(int x, int y) {
        this.x = x;
        this.y = y;
    }

    @Override
    public boolean equals(Object o) {
        if (!(o instanceof Point)) {
            return false;
        }
        Point p = (Point)o;
        return x == p.x && y == p.y;
    }
}

然后又有一個ColorPoint類, 來表示帶顏色的點

class ColorPoint extends Point {
    private final Color color;
    public ColorPoint(int x, int y, Color color) {
        super(x, y);
        this.color = color;
    }
}

沒有復寫equals的情況下, 雖然ColorPoint和Point作比較的時候能飯后正確的結果, 但是兩個ColorPoint之間做比較的時候忽略了顏色信息, 這顯然不是我們想要的結果, 于是乎:

@Override
    public boolean equals(Object o) {
        if (!(o instanceof ColorPoint)) {
            return false;
        }
        return super.equals(o) && ((ColorPoint) o).color == color;
    }
}

這樣對了嗎? 抱歉, 問題還是很大, 雖然實現了兩個有色點之間的比較, 但是當普通點和有色點比較的時候, 違反了對稱性, 普通點和有色點比較會忽略顏色, 而有色點和普通點則總是返回false.
繼續改:

@Override
    public boolean equals(Object o) {
        if (!(o instanceof Point)) {
            return false;
        }
        if(!(o instanceof ColorPoint)) {
            return o.equals(this);
        }
        return super.equals(o) && ((ColorPoint) o).color == color;
    }

如果o不是ColorPoint, 就用o去比較this, 這樣就會忽略顏色信息了, 測試一下:

        ColorPoint p1 = new ColorPoint(1, 1, Color.RED);
        Point p2 = new Point(1, 1);
        ColorPoint p3 = new ColorPoint(1, 1, Color.GREEN);
        System.out.println(p1.equals(p2));
        System.out.println(p2.equals(p3));

返回的都是true, 很好, 對稱性的問題解決了, 等等, 這里不是在討論傳遞性嗎!!!按照傳遞性來說, p1=p2, p2=p3, 所以p1和p3肯定是相等啊喂, 但是這里很明顯就是不相等的, 大家又不是色盲.
這樣寫呢

@Override
    public boolean equals(Object o) {
        if (o == null || o.getClass() != getClass()) {
            return false;
        }
        Point p = (Point)o;
        return x == p.x && y == p.y;
    }

只有當對象相同時才 比較, 這樣雖然解決了問題, 但是卻不是我們想要的解決方法, 來看一個更好的實現, 用復合代替繼承:

class ColorPoint {
    private final Color color;
    private final Point point;
    public ColorPoint(int x, int y, Color color) {
        if (color == null) {
            throw new NullPointerException();
        }
        point = new Point(x, y);
        this.color = color;
    }

    public Point asPoint() {
        return point;
    }

    @Override
    public boolean equals(Object o) {
        if(!(o instanceof ColorPoint)) {
            return false;
        }
        ColorPoint cp = (ColorPoint) o;
        return cp.point.equals(point) && cp.color.equals(color);
    }
}
  • 一致性
    如果兩個對象是相等的, 就應該保持一直是相等的, 除非這兩個對象中有一個或者兩個都被修改了, 所以記住: 相等的對象永遠相等, 不相等的對象永遠不相等.

  • 非空性
    所有的對象都不能為null, 盡管很難想象什么情況下o.equals(null)會返回true. 但是意外拋出NullPointerException異常的可能卻不難想象, 所以可以這樣寫來不允許拋出NullPointerException異常

@Override
public boolean equals(Object o) {
    if (o == null) {
        return false;
    }
}
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,702評論 6 534
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,615評論 3 419
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,606評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,044評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,826評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,227評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,307評論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,447評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,992評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,807評論 3 355
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,001評論 1 370
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,550評論 5 361
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,243評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,667評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,930評論 1 287
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,709評論 3 393
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,996評論 2 374

推薦閱讀更多精彩內容

  • 背景 一年多以前我在知乎上答了有關LeetCode的問題, 分享了一些自己做題目的經驗。 張土汪:刷leetcod...
    土汪閱讀 12,762評論 0 33
  • 文章作者:Tyan博客:noahsnail.com | CSDN | 簡書 CHAPTER3 Method...
    SnailTyan閱讀 739評論 1 4
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,785評論 18 139
  • 1. Java基礎部分 基礎部分的順序:基本語法,類相關的語法,內部類的語法,繼承相關的語法,異常的語法,線程的語...
    子非魚_t_閱讀 31,721評論 18 399
  • (一) 糖炒栗子味誘人, 買上幾斤過嘴癮。 想要開懷吃個夠, 那就動手在家炒。 先淘洗,再控水, 熱鍋倒進加鍋蓋。...
    E鍵傾心閱讀 842評論 0 1