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

  • 作者
  • KING

背景

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

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方法背后的细节吗?

背景

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

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);
    }
}