你真的了解,equals方法背后的细节吗?

  • 作者
  • 戈寒
  • 2020-06-09 12:15:09
  • 阅读  38

背景

师哥有一个程序员交流群,日常主要是做一些技术交流。某日一位兄弟,给我贴了一段代码。

public class Student {
  private int studentId; //学号
  private String name; //学生姓名
  
  ///get and set

  public Student(int studentId, String name) {
    super();
    this.studentId = studentId;
    this.name = name;
  }
}

public static void main(String... args) {
  Student s1 = new Student(1111, "姓名");
  Student s2 = new Student(1111, "姓名");
  System.out.println("==的结果: "+(s1==s2));
  System.out.println("equals的结果:"+(s1.equals(s2)));
}

然后这位兄弟开始了,他的提问之旅。

这位兄弟:这个==怎么和equals的结果一样都是false呀。不是说==比较地址,equals是比较实际值的么?
师哥:额。。。。
这位兄弟:师哥,怎么才能让这个equals方法,像String的equals方法一样,进行值比较呢
师哥:额。。。。这样吧。。。师哥去给你写篇文章吧。到时候记得去看,去点赞和去关注。(✿◠‿◠)
这位兄弟:(>‿◠)✌

所以,开始吧,言归正传。进入今天的主题。Java语言中,equals方法的作用?何时需要重写equals方法?重写的要求以及如何重写?

equals方法作用

当我们以及上面这个兄弟,在使用equals方法,我期望的结果自然是根据值,去判断当前两个对象是否是同一个对象。即逻辑上是否相等。如上面的两个对象:

Student s1 = new Student(1111, "姓名");
Student s2 = new Student(1111, "姓名");

这两个学生对象,学号相同,姓名相同,在逻辑上,我们都认为他们是相同(相等)的。但是为什么,从上面那位兄弟的测试结果来看,equals好像没有起到这个作用(返回的是false)。

我们思考一下,Student类,并没有equals方法。那么,这个方法是从哪里来的呢? 其实,这个equals方法来自于,Java中最大的父类,Object类。我们到JDK源代码中,去看看Object类的equals方法是如何写的。

public boolean equals(Object obj) {
  return (this == obj);
}

到这里,我们可以来回答,上文提的第一个问题,equals方法的作用。当我们在自定义类中没有重写equals方法时,它的作用与Object类的equals方法作用一致,都是判断两个对象的物理存储地址是否相等。

何时需要重写equals

如果一个类,有其特有的逻辑相等条件。比如上面的Student类,只要学号相等,我们就可以判定,是同一个学生。当我们对一个含有具体值的类,在使用equals方法的时候。我们都是希望判断他们逻辑上是否相等,而不是物理存储地址是否相等。此时,我们就需要重写equals方法。

equals方法的通用要求

Java中Object类的存在,主要是为了方便扩展。Object类中所有非final方法(hashcode,toString,equals,clone...),都是可以被重写的。但这些可以重写的方法,都有一定的约定准则(方法注释上面,就能看到),不能随意发挥。只有这样,才能保证,当这些方法被重写之后,与之相关联的部分,仍能正常运行。equals方法的约定包含以下5点:

1.自反性

任意一个非空(null)的对象obj,那么obj.equals(obj)必须返回true。

2.对称性

任意非空对象obj1和obj2,当且仅当obj2.equals(obj1)返回true时,obj1.equals(obj2)必须返回true。

3.传递性

任意非空对象obj1,obj2,obj3,如果obj1.equals(obj2),并且obj2.equals(obj3),那么obj1.equals(obj3)也必须返回true。

4.一致性

任意非空对象obj1和obj2,如果对象信息没有发生改变,无论调用obj1.equals(obj2)多少次,返回都必须是相同的一致的,要么全是false,要么全是true。

5.任意非空对象,与空对象比较,必须返回false

任意一个非空(null)的对象obj,调用obj.equals(null)必须返回false。

如何优雅的写出equals

了解完equals的约定之后,我们就可以总结出以下几点,使我们重写出来的equals方法更加完善与正确。

1.使用==操作符

如果进行比较的两个对象,物理存储地址相等,那么即是它本身,则可以直接返回true。这样保证了约定的第一条,而且效率较高。

2.使用instanceof操作符

因为,equals方法的传入参数是Object类型,使用instanceof操作符,进行参数的类型的检查。如果不是正确的类型,则可以直接返回false。这里的类型需要注意,在特定的情况下,可以是父类或者接口的类型。

3.将参数强转成正确的类型

上一步使用instanceof,进行了类型检查,所以这一步,一定会成功。同时,也只有将参数转换成正确的类型,才能进行后续的比较判断工作。

4.使用关键字段进行比较判断

这一步比较好理解,像上面的Student类,就可以使用id是否相等进行判断。另外提供两个小技巧

除了float和double其它基本类型(byte,char,short,int,long)及其包装类,都可直接使用==进行比较; 对于引用类型的判断,则递归调用equals进行比较,如String;

如果有的字段,是允许为null,则建议写成field == null ? obj.field== null : field.equals(obj.field)。

完美的示例

没有想到吧,一个简单的equals方法,背后居然有这么多的坑。这告诉我们,学习不能仅仅只看表面,还得深入理解。这样,我们平时工作,才会更加得心应手,手到擒来,来去自如。最后,师哥附上一个,师哥自己写的equals样例。大家可以留言讨论这段equals写得如何。

package com.dm.test;
public class TestEquals {
  public int id;
  public String name;

  public boolean equals(Object obj){
    if(this == obj){
      return true;
    }
    
    if(obj == null){
      return false;
    }
    
    if(!(obj instanceof TestEquals)){
      return false;
    }

    TestEquals testObj = (TestEquals)obj;
    if(testObj.id != this.id){  
      return false;
    }

    return this.name == null ? testObj.name == null : this.name.equals(testObj.name);
    }
}


你真的了解,equals方法背后的细节吗?

  • 2020-06-09 12:15:09
  • 阅读  38

背景

师哥有一个程序员交流群,日常主要是做一些技术交流。某日一位兄弟,给我贴了一段代码。

public class Student {
  private int studentId; //学号
  private String name; //学生姓名
  
  ///get and set

  public Student(int studentId, String name) {
    super();
    this.studentId = studentId;
    this.name = name;
  }
}

public static void main(String... args) {
  Student s1 = new Student(1111, "姓名");
  Student s2 = new Student(1111, "姓名");
  System.out.println("==的结果: "+(s1==s2));
  System.out.println("equals的结果:"+(s1.equals(s2)));
}

然后这位兄弟开始了,他的提问之旅。

这位兄弟:这个==怎么和equals的结果一样都是false呀。不是说==比较地址,equals是比较实际值的么?
师哥:额。。。。
这位兄弟:师哥,怎么才能让这个equals方法,像String的equals方法一样,进行值比较呢
师哥:额。。。。这样吧。。。师哥去给你写篇文章吧。到时候记得去看,去点赞和去关注。(✿◠‿◠)
这位兄弟:(>‿◠)✌

所以,开始吧,言归正传。进入今天的主题。Java语言中,equals方法的作用?何时需要重写equals方法?重写的要求以及如何重写?

equals方法作用

当我们以及上面这个兄弟,在使用equals方法,我期望的结果自然是根据值,去判断当前两个对象是否是同一个对象。即逻辑上是否相等。如上面的两个对象:

Student s1 = new Student(1111, "姓名");
Student s2 = new Student(1111, "姓名");

这两个学生对象,学号相同,姓名相同,在逻辑上,我们都认为他们是相同(相等)的。但是为什么,从上面那位兄弟的测试结果来看,equals好像没有起到这个作用(返回的是false)。

我们思考一下,Student类,并没有equals方法。那么,这个方法是从哪里来的呢? 其实,这个equals方法来自于,Java中最大的父类,Object类。我们到JDK源代码中,去看看Object类的equals方法是如何写的。

public boolean equals(Object obj) {
  return (this == obj);
}

到这里,我们可以来回答,上文提的第一个问题,equals方法的作用。当我们在自定义类中没有重写equals方法时,它的作用与Object类的equals方法作用一致,都是判断两个对象的物理存储地址是否相等。

何时需要重写equals

如果一个类,有其特有的逻辑相等条件。比如上面的Student类,只要学号相等,我们就可以判定,是同一个学生。当我们对一个含有具体值的类,在使用equals方法的时候。我们都是希望判断他们逻辑上是否相等,而不是物理存储地址是否相等。此时,我们就需要重写equals方法。

equals方法的通用要求

Java中Object类的存在,主要是为了方便扩展。Object类中所有非final方法(hashcode,toString,equals,clone...),都是可以被重写的。但这些可以重写的方法,都有一定的约定准则(方法注释上面,就能看到),不能随意发挥。只有这样,才能保证,当这些方法被重写之后,与之相关联的部分,仍能正常运行。equals方法的约定包含以下5点:

1.自反性

任意一个非空(null)的对象obj,那么obj.equals(obj)必须返回true。

2.对称性

任意非空对象obj1和obj2,当且仅当obj2.equals(obj1)返回true时,obj1.equals(obj2)必须返回true。

3.传递性

任意非空对象obj1,obj2,obj3,如果obj1.equals(obj2),并且obj2.equals(obj3),那么obj1.equals(obj3)也必须返回true。

4.一致性

任意非空对象obj1和obj2,如果对象信息没有发生改变,无论调用obj1.equals(obj2)多少次,返回都必须是相同的一致的,要么全是false,要么全是true。

5.任意非空对象,与空对象比较,必须返回false

任意一个非空(null)的对象obj,调用obj.equals(null)必须返回false。

如何优雅的写出equals

了解完equals的约定之后,我们就可以总结出以下几点,使我们重写出来的equals方法更加完善与正确。

1.使用==操作符

如果进行比较的两个对象,物理存储地址相等,那么即是它本身,则可以直接返回true。这样保证了约定的第一条,而且效率较高。

2.使用instanceof操作符

因为,equals方法的传入参数是Object类型,使用instanceof操作符,进行参数的类型的检查。如果不是正确的类型,则可以直接返回false。这里的类型需要注意,在特定的情况下,可以是父类或者接口的类型。

3.将参数强转成正确的类型

上一步使用instanceof,进行了类型检查,所以这一步,一定会成功。同时,也只有将参数转换成正确的类型,才能进行后续的比较判断工作。

4.使用关键字段进行比较判断

这一步比较好理解,像上面的Student类,就可以使用id是否相等进行判断。另外提供两个小技巧

除了float和double其它基本类型(byte,char,short,int,long)及其包装类,都可直接使用==进行比较; 对于引用类型的判断,则递归调用equals进行比较,如String;

如果有的字段,是允许为null,则建议写成field == null ? obj.field== null : field.equals(obj.field)。

完美的示例

没有想到吧,一个简单的equals方法,背后居然有这么多的坑。这告诉我们,学习不能仅仅只看表面,还得深入理解。这样,我们平时工作,才会更加得心应手,手到擒来,来去自如。最后,师哥附上一个,师哥自己写的equals样例。大家可以留言讨论这段equals写得如何。

package com.dm.test;
public class TestEquals {
  public int id;
  public String name;

  public boolean equals(Object obj){
    if(this == obj){
      return true;
    }
    
    if(obj == null){
      return false;
    }
    
    if(!(obj instanceof TestEquals)){
      return false;
    }

    TestEquals testObj = (TestEquals)obj;
    if(testObj.id != this.id){  
      return false;
    }

    return this.name == null ? testObj.name == null : this.name.equals(testObj.name);
    }
}


诗与远方

  • 请你用慈悲心和温和的态度
    把你的不满与委屈说出来
    别人就容易接受得多地多

诗与远方

  • 诚实的面对你内心的矛盾和缺点
    不要欺骗你自己

诗与远方

  • 成功要爬上梯子才能到达
    双手插在口袋里的人是爬不上去的

诗与远方

  • 良心是每一个人最公正的审判官
    你骗得了别人
    却永远骗不了你自己的良心

诗与远方

  • 不要因为小小的争执
    疏远了你的至亲好友
    也不要因为小小的怨恨
    忘记了别人的恩情

诗与远方

  • 凡是能多站在别人的角度着想
    就能做到,理解,体谅

诗与远方

  • 当幻想和现实面对时
    总是很痛苦的
    要么你被痛苦击倒
    要么你把痛苦踩在脚下

诗与远方

  • 梯子的梯阶从来不是用来搁脚的
    它只是让人们的脚踏上去
    以便让另一只脚能够再往上攀登

诗与远方

  • 毁灭一个人只要一句话
    培植一个人却要千句话
    所以请你多多口下留情

诗与远方

  • 财以不炫为富,官以不显为贵
    名以不彰为誉,施以不报为惠

诗与远方

  • 世界原本就不是属于你
    因此你用不着抛弃
    要抛弃的是一切的执着
    万物皆为我所用,但非我所属

诗与远方

  • 只要自觉心安,东西南北都好
    如有一人未度,切莫自觉逃了

诗与远方

  • 崇高的理想就像生长在高山上的鲜花
    如果要摘下它
    勤奋才是攀登的途径

诗与远方

  • 人之谤我也
    与其能辩,不如能容
    人之侮我也
    与其能防,不如能化

诗与远方

  • 不要在你的智慧中夹杂着傲慢
    不要使你的谦虚缺乏智慧

诗与远方

  • 看透大事者超脱,看不透者执着
    看透小事者豁达,看不透者计较

诗与远方

  • 坚韧是成功的一大要素
    只要在成功之门上敲得够久够大声
    终会把成功唤醒

诗与远方

  • 根本不必回头去看咒骂你的人是谁
    如果有一条疯狗咬了你一口
    难道你也要趴下去反咬它一口吗

诗与远方

  • 交有道之人,莫结无义之友
    饮清净之茶,莫贪花色之酒
    开方便之门,闲是非之口

诗与远方

  • 谦虚但不自卑
    自信但不自大
    自由但不放纵
    人一生很难做到这三点

诗与远方

  • 活着一天,就是有福气,就该珍惜
    当我哭泣没有鞋子穿的时候
    我发现有人没有脚……

诗与远方

  • 不要让追求之舟停泊在幻想的港湾
    而应扬起奋斗的风帆
    驶向现实生活的大海

诗与远方

  • 不要刻意去猜测他人的想法
    如果你没有智慧与经验的正确判断
    通常都会有偏差的

诗与远方

  • 心中装满自己的看法与想法的人
    是听不见别人的声音的

诗与远方

  • 要了解一个人
    只需要看他的出发点与目的地是否相同
    就可以知道他是否真心

诗与远方

  • 一个人如果不能从内心去原谅别人
    那他就放不下怨恨,得不到快乐的生活

诗与远方

  • 你不要一直不满人家
    你应该一直检讨自己才是
    不满人家,是苦了你自己

诗与远方

  • 你硬要把单纯的事情看得很复杂
    那你会很痛苦

诗与远方

  • 当你劝告别人时
    若不顾及别人的自尊心
    那么再好的言语都是没有用的

诗与远方

  • 一份耕耘,一份收获,付出就会有回报
    不曾遭遇过失败,因为一直往成功方向发展
    所碰到的都是暂时的挫折

诗与远方

  • 同样的瓶子
    你为什么要装毒药呢
    同样的心理
    你为什么要充满着烦恼呢

诗与远方

  • 把气氛的心境转化为柔和
    把柔和的心境转化为爱
    如此,这个世间将更加完美

诗与远方

  • 说话不要有攻击性
    不要有杀伤力
    不夸已能,勿扬人恶,自然能化敌为友

诗与远方

  • 如果你不给自己烦恼
    别人也永远不可能给你烦恼
    因为你不会放在自己的心上

诗与远方

  • 懦弱的人只会裹足不前
    莽撞的人只能引火烧身
    只有真正勇敢的人才能所向披靡

诗与远方

  • 多一分心力去注意别人
    就少一分心力反省自己

诗与远方

  • 有时候我们要冷静问问自己
    我们再追求什么
    我们活着为了什么

诗与远方

  • 彩云飘在空中,自然得意洋洋
    但最多智能换取几声赞美
    唯有化作雨并倾注于土壤之中
    才能给世界创造芳菲

诗与远方

  • 当你快乐时你要想,这快乐不是永恒的
    当你痛苦时你要想,这痛苦也不是永恒的

诗与远方

  • 快乐是一份自然
    做自己想做的事
    做好自己选择的事
    自然地做人,自然地笑,自然地生活

诗与远方

  • 狂妄的人有救
    自卑的人没有救
    认识自己,相信自己,改变自己
    才能改变别人对你的态度

诗与远方

  • 只要永不放弃,持之以恒
    每次挫折,都是你进步的阶梯
    如果你逃避退缩,那就等于自毁前途

诗与远方

  • 用伤害别人的手段来掩饰自己缺点的人是可耻的

诗与远方

  • 玩像玩的,干像干的
    人生苦短,能享受时就享受,能轻松时就轻松
    不要跟自己过不去,要保持一种良好的心境

诗与远方

  • 责人要含蓄,忌太尽
    劝人要委婉,忌太直
    警人要疑似,忌太真

诗与远方

  • 你一定要宽恕众生
    不论他有多坏,甚至伤害过你
    你只有放下了,才能得到真正的快乐

诗与远方

  • 要是面前有一堵墙
    不要轻易退缩逃避
    要想办法绕过去,超越过去
    即使有困难也不要轻易放弃

诗与远方

  • 势不可使尽,聪明不可用尽
    福不可享尽,便宜不可占尽

诗与远方

  • 当你对自己诚实的时候
    世界上没有人能够欺骗得了你

诗与远方

  • 心是最大的骗子
    别人能骗你一时
    而它却会骗你一辈子

诗与远方

  • 大多数的人一辈子只做了三件事
    自欺,欺人,被人欺

诗与远方

  • 一个人如果没有感受过苦难
    就不会体会到他人的苦难
    你要学救苦救难的精神,就得先受苦受难

诗与远方

  • 每一个人都拥有生命
    但并非每个人都懂得生命,珍惜生命
    不了解生命的人,体会不到生命的价值

诗与远方

  • 生活可以是甜的,也可以是苦的
    但不能是没味的
    你可以胜利,也可以失败
    但你不能屈服

随意打赏