覆盖equals时请遵守通用约定

阅读经典——《Effective Java》04

通常我们不必覆盖equals方法，而是沿用Object类为我们提供的实现：

public boolean equals(Object obj) {
  return (this == obj);
}

在这种情况下，类的每个实例只与它自己相等。

那么，什么时候我们应该覆盖equals方法呢？

如果类具有自己特有的“逻辑相等”概念，我们就应该重写equals方法。通常这是一个表示值的类，例如Integer或者Date。此时，我们使用equals方法来判断两个对象的值是否相等，而不管它们是否指向同一个对象。

1. Equals的通用约定

2. 实现高质量equals的步骤

Equals的通用约定

为了保证类拥有正确的行为，我们必须遵守如下的约定（来自Object规范[JavaSE6]）：

• 自反性（reflexive）：对于任何非null的引用值x，x.equals(x)必须返回true。
• 对称性（symmetric）：对于任何非null的引用值x和y，当且仅当y.equals(x)返回true时，x.equals(z)必须返回true。
• 传递性（transitive）：对于任何非null的引用值x、y和z，如果x.equals(y)返回true，并且y.equals(z)也返回true，那么x.equals(z)也必须返回true。
• 一致性（consistent）：对于任何非null的引用值x和y，只要equals的比较操作在对象中所用的信息没有被修改，多次调用x.equals(y)就会一致地返回true，或者一致地返回false。
• 对于任何非null的引用值x，x.equals(null)必须返回false。

虽然这些规定看起来没什么特别，但一旦违反了它们，你的程序将会表现不正常，甚至崩溃，而且很难找到失败的根源。有许多类，包括所有的集合类在内，都依赖于传递给它们的对象是否遵守了equals约定。

违反某一条约定会造成怎样严重的后果，是个复杂的课题，我们不再一一叙述，感兴趣的朋友可以阅读本书原文或查看第一篇参考资料。接下来我们着眼于如何实现高质量的equals方法。

实现高质量equals的步骤

按照如下步骤实现equals方法：

1. 使用==操作符检查“参数是否为这个对象的引用”。如果是，则返回true。这只不过是一种性能优化，以尽可能避免后面的比较。
2. 使用instanceof操作符检查“参数是否为正确的类型”。如果不是，则返回false。
3. 把参数转换成正确的类型。
4. 对于该类中的每个“关键域”，检查参数中的域是否与该对象中的对应域相匹配。全部成功则返回true，否则返回false。特别的，关键域比较时需要考虑类型，如果是普通基本类型，可以直接使用==操作符比较；如果是float类型，应该使用Float.compare方法比较；如果是double类型，应该使用Double.compare方法比较；如果是对象引用，应该递归调用该对象的equals方法；如果是数组，则要把以上这些原则应用到每一个数组元素上。域的比较顺序可能会影响到equals方法的性能，应该最先比较最有可能不一致的域，或者是开销最低的域。

使用以上步骤实现的equals方法满足Java规范，可以很好地与其它类协作。我们举一个实际的例子，Point类表示二维平面上的一个点。

public class Point {
  private final int x;
  private final int y;
  public Point(int x, int y) {
    this.x = x;
    this.y = y;
  }

  @Override
  public boolean equals(Object o) {
    if (o == this) return true;
    if (!(o instanceof Point)) return false;
    Point p = (Point) o;
    return p.x == x && p.y == y;
  }
}

最后，给出一些忠告：

• 覆盖equals时总要覆盖hashCode。
• 不要企图让equals方法过于智能。过度寻求等价关系很容易使自己陷入麻烦。
• 不要将equals声明中的的Object对象替换为其它类型。下面的代码会使程序员花费数个小时都搞不清楚为什么它不能正常工作。

public boolean equals(MyClass o) {
  //...
}

问题在于，这个方法并没有覆盖Object.equals，因为它们的函数签名并不一致，反而形成了重载关系。使用@Override注解可以避免这类错误，编译器会拒绝编译下面的代码。

@Override
public boolean equals(MyClass o) {
  //...
}

关注作者或文集《Effective Java》，第一时间获取最新发布文章。

参考资料

《Effective Java》读书笔记07--覆盖equals时要遵守通用约定 JavaDynamic
The Java® Language Specification Java SE 8 Edition ORACLE