编写equals方法

共计 3729 个字符，预计需要花费 10 分钟才能阅读完成。

我们知道 List 是一种有序链表：List内部按照放入元素的先后顺序存放，并且每个元素都可以通过索引确定自己的位置。

List还提供了 boolean contains(Object o) 方法来判断 List 是否包含某个指定元素。此外，int indexOf(Object o)方法可以返回某个元素的索引，如果元素不存在，就返回-1。

我们来看一个例子：

import java.util.List;

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

这里我们注意一个问题，我们往 List 中添加的 "C" 和调用 contains("C") 传入的 "C" 是不是同一个实例？

如果这两个 "C" 不是同一个实例，这段代码是否还能得到正确的结果？我们可以改写一下代码测试一下：

import java.util.List;

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

因为我们传入的是new String("C")，所以一定是不同的实例。结果仍然符合预期，这是为什么呢？

因为 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()这些方法，放入的实例必须正确覆写 equals() 方法，否则，放进去的实例，查找不到。我们之所以能正常放入 String、Integer 这些对象，是因为 Java 标准库定义的这些类已经正确实现了 equals() 方法。

我们以 Person 对象为例，测试一下：

import java.util.List;

public class Main {public static void main(String[] args) {
        List<Person> list = List.of(new Person("Xiao Ming"),
            new Person("Xiao Hong"),
            new Person("Bob")
        );
        System.out.println(list.contains(new Person("Bob"))); // false
    }
}

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，y.equals(z)也为 true，那么x.equals(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 p) {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 p) {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 p) {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 类增加 equals 方法，使得调用 indexOf()方法返回正常：

import java.util.List;
import java.util.Objects;

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("Bob", "Smith", 20)
        );
        boolean exist = list.contains(new Person("Bob", "Smith", 20));
        System.out.println(exist ? "测试成功!" : "测试失败!");
    }
}

class Person {
    String firstName;
    String lastName;
    int age;
    public Person(String firstName, String lastName, int age) {this.firstName = firstName;
        this.lastName = lastName;
        this.age = age;
    }
}