Java集合编写equals方法

我们知道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 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 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 < size; 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 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()⽅法？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) { 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()⽅法的正确编写⽅法：

1. 先确定实例“相等”的逻辑，即哪些字段相等，就认为实例相等；

2. ⽤instanceof判断传⼊的待⽐较的Object是不是当前类型，如果是，继续⽐较，否则，返回false；3. 对引⽤类型⽤Objects.equals()⽐较，对基本类型直接⽤==⽐较。

使⽤Objects.equals()⽐较两个引⽤类型是否相等的⽬的是省去了判断null的⿇烦。两个引⽤类型都是null时它们也是相等的。如果不调⽤List的contains()、indexOf()这些⽅法，那么放⼊的元素就不需要实现equals()⽅法。

⼩结

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