编写equals方法

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

我们来看一个例子：

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

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

编写equals方法 - 图2

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

因为List内部并不是通过==判断两个元素是否相等，而是使用equals()方法判断两个元素是否相等，例如contains()方法可以实现如下：

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

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

如何正确编写equals()方法？equals()方法要求我们必须满足以下条件：

  • 自反性（Reflexive）：对于非null的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；
  • 对null的比较：即x.equals(null)永远返回false。

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

首先，我们要定义“相等”的逻辑含义。对于Person类，如果相等，并且age相等，我们就认为两个Person实例相等。

因此，编写equals()方法如下：

对于引用字段比较，我们使用equals()，对于基本类型字段的比较，我们使用==。

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

因此，我们总结一下equals()方法的正确编写方法：

  • 先确定实例“相等”的逻辑，即哪些字段相等，就认为实例相等；
  • 用instanceof判断传入的待比较的Object是不是当前类型，如果是，继续比较，否则，返回false；

如果不调用List的contains()、indexOf()这些方法，那么放入的元素就不需要实现equals()方法。

给Person类增加equals方法，使得调用indexOf()方法返回正常：

编写equals方法 - 图4

下载练习： （推荐使用IDE练习插件快速下载）

在List中查找元素时，List的实现类通过元素的equals()方法比较两个元素是否相等，因此，放入的元素必须正确覆写equals()方法，Java标准库提供的String、Integer等已经覆写了equals()方法；

编写equals()方法可借助Objects.equals()判断。

编写equals方法 - 图6