集合 - 编写equals方法 - 《java》

编写equals
小结

我们知道List是一种有序链表：List内部按照放入元素的先后顺序存放，并且每个元素都可以通过索引确定自己的位置。
List还提供了boolean contains(Object o)方法来判断List是否包含某个指定元素。<br />此外，int indexOf(Object o)方法可以返回某个元素的索引，如果不存在此元素，则返回-1`

public class Main{
    public static void main(String[] args){
        List<String> list = List.of("A","B","C");
        System.out.println(list.contains("C"));
        System.out.println(list.indexOf("C"));//2
    }
}

这里我们注意到一个问题，我们往List中添加的"C"和调用contains("C")传入的"C"是不是同一个实例？
如果这两个"C"不是同一个实例，这段代码是否还能得到正确的结果？

List<String> list = List.of("A","B","C");
System.out.println(list.contains(new String("C"));
System.out.println(list.indexOf(new String("C"));

通过运行可知，返回true。List内部并不是通过==来判断两个元素是否相等，而是使用equals()方法判断两个元素是否相等，例如contains()方法可以实现如下

public class ArrayList{
    Object[] elementData;
    public boolean contains(Object o) {
        for(int i =0; i< elementData.length;i++){
            if(o.equals(elementData[i])) {
             return true;
            }
    }
        return false;
}

因此，要正确使用List的contains() indexOf()这些方法，放入的实例必须正确覆写(override)equals()方法，否则，放进去的实例，查找不到。
我们之所以能正常放入String、Integer 这些对象，是因为Java标准库定义的这些类已经正确实现了equals()方法

以Person对象为例

public class Main{
    public static void main(String[] args){
        List<Person> list = list.of(new Person("xiaoming"),new Person("xiaohong"),new Person("Bob"));
        System.out.println(list.contains(new Person("Bob"));
    }
}
class Person {
    String name;
    public Person(String name){this.name= name;}
}

虽然放入了new Person("Bob")，但是用另一个new Person("Bob")查询不到，原因就是Person类没有覆写equals()方法。

编写`equals`

equals()方法要求我们必须满足以下条件

自反性(Reflexive):对于非null的x来说，x.equals(x)必须返回true。
对称性(Symmetric):对于非null的x和y来说，如果，x.equals(y) 为true，那么y.equals(x)也必须为true。
传递性(Transitive): 对于非null的x、y、z来说，如果x.equals(y) = true,x.equals(z) = true那么y.equlas(z)也必须为true。
一致性(Consistent):对于非null的x 、y来说，只要x 和y的状态不变，则x.equals(y)总是一致地返回true或者false。
对null的比较，x.equals(null)永远返回false

上述规则看上去非常复杂，但其实代码实现equals()方法很简单，我们以Person类为例

public class Person {
    public String name;
  public int age;
}

首先，我们要定义“相等”的逻辑含义。
对于Person类，如果name相等，并且age相等，那么我们就认为两个Person实例相等。
因此，编写equals()方法

public boolean equals(Object o) {
    if(o instanceof Person){
      Person p  =(Person) o;
    return this.name.equals(p.name) && this.age == p.age;
  }
  return false;
}

对于引用字段比较，我们使用equals()，对于基本类型使用==。
如果this.name为null，那么equals()方法会报错，因此，需要继续改写

public boolean equals(Object o) {
    if (o instanceof Person){
        Person p = (Person) o;
        boolean nameEquals = false;
        if(this.name == null && p.name == null){
            nameEquals = true;
        }
        if(this.name != null){
            nameEquals = this.name.equals(p.name);
        }
        return nameEquals && this.age == p.age;
    }
    return false;
}

如果Person有好几个引用类型的字段，上面的写法就太复杂了。要简化此乃类型的比较，我们使用Objects.equals()静态方法。

public boolean equals(Object o) {
    if (o instanceof Person){
        Person p= (Person) o;
        return Objects.equals(this.name,p.name) && this.age == p.age;
    }
    return false;
}

总结一下equals()方法的正确编写方法

先确定实例"相等"的逻辑，即哪些字段相等，就认为实例相等
用instanceof判断传入的待比较的Object是不是当前类型，如果是，继续比较，否则，返回false
对引用类型用Objects.equals()比较，对基本类型直接用==比较。

使用Objects.equals()比较两个引用类型是否相等的目的是活动了判断null的麻烦。两个引用类型都是null时它们也是相等的。
如果不调用List的contains()、indexOf()这些方法，那么放入元素就不需要实现equals()方法。

练习
给Person类增加equalas()方法，使得调用indexOf()方法返回正常

public class Main {
    public static void main(String[] args){
        List<Person> list = list.of(
            new Person("xiao","ming",18);
            new Person("xiao","hong",25);
            new Person("xiao","jun",20);
        );
        boolean exist = list.contains(new Person("xiao","jun",20));
        System.out.println(exist ? "测试成功！" :"测试失败";
    }
}
@getter
@setter                           
class Person{
    private String firstName;
    private String lastName;
    private int age;
    public Person(String firstName, String lastName, int age){
        this.firstName = firstName;
        this.lastName = lastName;
        this.age = age;
    }
    @Override
    public boolean equals(Object o){
        if(o intanceof Person){
            Person p = (Person) o;
            return Objects.equals(this.firstName, p.getFirstName()) && Obejcts.equals(this.lastName, p.getLastName()) && this.age == p.getAge());
        }
    }
}

小结

在List中查找元素时，List的实现类通过元素的equals()方法比较两个元素是否相等，因此，放入的元素必须正确覆写equals()方法，Java标准库提供的String、Integer等已经覆写了equals()方法
编写equals()方法可以借助Objects.equals()判断
如果不在List中查找元素，就不必覆写equals()方法