如何在Java中避免equals方法的隐藏陷阱（上）
译者注:你可能会觉得Java很简单，Object的equals实现也会非常简单，但是事实并不是你想象的这样，耐心的读完本文，你会发现你对Java了解的是如此的少。如果这篇文章是一份Java程序员的入职笔试，那么不知道有多少人会掉落到这样的陷阱中。
摘要
本文描述重载equals方法的技术，这种技术即使是具现类的子类增加了字段也能保证equal语义的正确性。
在《Effective Java》的第8项中，Josh Bloch描述了当继承类作为面向对象语言中的等价关系的基础问题，要保证派生类的equal正确性语义所会面对的困难。Bloch这样写到：
除非你忘记了面向对象抽象的好处，否则在当你继承一个新类或在类中增加了一个值组件时你无法同时保证equal的语义依然正确。
在《Programming in Scala》中的第28章演示了一种方法，这种方法允许即使继承了新类，增加了新的值组件，equal的语义仍然能得到保证。虽然在这本书中这项技术是在使用Scala类环境中，但是这项技术同样可以应用于Java定义的类中。在本文中的描述来自于Programming in Scala中的文字描述，但是代码被我从scala翻译成了Java
常见的等价方法陷阱
java.lang.Object 类定义了equals这个方法，它的子类可以通过重载来覆盖它。不幸的是，在面向对象中写出正确的equals方法是非常困难的。事实上，在研究了大量的Java代码后，2007 paper的作者得出了如下的一个结论：
几乎所有的equals方法的实现都是错误的！
这个问题是因为等价是和很多其他的事物相关联。例如其中之一，一个的类型C的错误等价方法可能意味着你无法将这个类型C的对象可信赖的放入到容器中。比如说，你有两个元素elem1和elem2他们都是类型C的对象，并且他们是相等，即elem1.equals(elm2)返回ture。但是，只要这个equals方法是错误的实现，那么你有可能会看见如下的一些行为：
| Set hashSet = new java.util.HashSet(); hashSet.add(elem1); hashSet.contains(elem2); // returns false! |
当equals重载时，这里有4个会引发equals行为不一致的常见陷阱：
1、定义了错误的equals方法签名（signature）Defining equals with the wrong signature.
2、重载了equals的但没有同时重载hashCode的方法。Changing equals without also changing hashCode.
3、建立在会变化字域上的equals定义。Defining equals in terms of mutable fields.
4、不满足等价关系的equals错误定义Failing to define equals as an equivalence relation.
在剩下的章节中我们将依次讨论这4中陷阱。
陷阱1：定义错误equals方法签名（signature）
考虑为下面这个简单类Point增加一个等价性方法：
|
public class Point { private final int x; private final int y; public Point(int x， int y) { this.x = x; this.y = y; } public int getX() { return x; } public int getY() { return y; } // ... } |
看上去非常明显，但是按照这种方式来定义equals是错误的。
| // An utterly wrong definition of equals public boolean equals(Point other) { return (this.getX() == other.getX() && this.getY() == other.getY()); } |
这个方法有什么问题呢？初看起来，它工作的非常完美：
|
Point p1 = new Point(1， 2); Point p2 = new Point(1， 2); Point q = new Point(2， 3); System.out.println(p1.equals(p2)); // prints true System.out.println(p1.equals(q)); // prints false |
然而，当我们一旦把这个Point类的实例放入到一个容器中问题出现了：
|
import java.util.HashSet; HashSet coll = new HashSet(); coll.add(p1); System.out.println(coll.contains(p2)); // prints false |
为什么coll中没有包含p2呢？甚至是p1也被加到集合里面，p1和p2是是等价的对象吗？在下面的程序中，我们可以找到其中的一些原因，定义p2a是一个指向p2的对象，但是p2a的类型是Object而非Point类型：
| Object p2a = p2; |
现在我们重复第一个比较，但是不再使用p2而是p2a，我们将会得到如下的结果：
| System.out.println(p1.equals(p2a)); // prints false |
到底是那里出了了问题？事实上，之前所给出的equals版本并没有覆盖Object类的equals方法，因为他的类型不同。下面是Object的equals方法的定义
| public boolean equals(Object other) |
因为Point类中的equals方法使用的是以Point类而非Object类做为参数，因此它并没有覆盖Object中的equals方法。而是一种变化了的重载。在Java中重载被解析为静态的参数类型而非运行期的类型，因此当静态参数类型是Point，Point的equals方法被调用。然而当静态参数类型是Object时，Object类的equals被调用。因为这个方法并没有被覆盖，因此它仍然是实现成比较对象标示。这是为什么虽然p1和p2a具有同样的x，y值，”p1.equals(p2a)”仍然返回了false。这也是会什么HasSet的contains方法返回false的原因，因为这个方法操作的是泛型，他调用的是一般化的Object上equals方法而非Point类上变化了的重载方法equals
一个更好但不完美的equals方法定义如下：
| // A better definition， but still not perfect @Override public boolean equals(Object other) { boolean result = false; if (other instanceof Point) { Point that = (Point) other; result = (this.getX() == that.getX() && this.getY() == that.getY()); } return result; } |
现在equals有了正确的类型，它使用了一个Object类型的参数和一个返回布尔型的结果。这个方法的实现使用instanceof操作和做了一个造型。它首先检查这个对象是否是一个Point类，如果是，他比较两个点的坐标并返回结果，否则返回false。
陷阱2：重载了equals的但没有同时重载hashCode的方法
如果你使用上一个定义的Point类进行p1和p2a的反复比较，你都会得到你预期的true的结果。但是如果你将这个类对象放入到HashSet.contains()方法中测试，你有可能仍然得到false的结果：
|
Point p1 = new Point(1， 2); Point p2 = new Point(1， 2); HashSet coll = new HashSet(); coll.add(p1); System.out.println(coll.contains(p2)); // 打印 false (有可能) |
事实上，这个个结果不是的false，你也可能有返回ture的经历。如果你得到的结果是true的话，那么你试试其他的坐标值，终你一定会得到一个在集合中不包含的结果。导致这个结果的原因是Point重载了equals却没有重载hashCode。
注意上面例子的的容器是一个HashSet，这意味着容器中的元素根据他们的哈希码被被放入到”哈希桶 hash buckets”中。contains方法首先根据哈希码在哈希桶中查找，然后让桶中的所有元素和所给的参数进行比较。现在，虽然后一个Point类的版本重定义了equals方法，但是它并没有同时重定义hashCode。因此，hashCode仍然是Object类的那个版本，即：所分配对象的一个地址的变换。所以p1和p2的哈希码理所当然的不同了，甚至是即时这两个点的坐标完全相同。不同的哈希码导致他们具有极高的可能性被放入到集合中不同的哈希桶中。contains方法将会去找p2的哈希码对应哈希桶中的匹配元素。但是大多数情况下，p1一定是在另外一个桶中，因此，p2永远找不到p1进行匹配。当然p2和p2也可能偶尔会被放入到一个桶中，在这种情况下，contains的结果为true了。
新一个Point类实现的问题是，它的实现违背了作为Object类的定义的hashCode的语义。
如果两个对象根据equals(Object)方法是相等的，那么在这两个对象上调用hashCode方法应该产生同样的值。
事实上，在Java中，hashCode和equals需要一起被重定义是众所周知的。此外，hashCode只可以依赖于equals依赖的域来产生值。对于Point这个类来说，下面的的hashCode定义是一个非常合适的定义。
|
public class Point { private final int x; private final int y; public Point(int x， int y) { this.x = x; this.y = y; } public int getX() { return x; } public int getY() { return y; } @Override public boolean equals(Object other) { boolean result = false; if (other instanceof Point) { Point that = (Point) other; result = (this.getX() == that.getX() && this.getY() == that.getY()); } return result; } @Override public int hashCode() { return (41 * (41 + getX()) + getY()); } } |
这只是hashCode一个可能的实现。x域加上常量41后的结果再乘与41并将结果在加上y域的值。这样做可以以低成本的运行时间和低成本代码大小得到一个哈希码的合理的分布(译者注：性价比相对较高的做法)。
增加hashCode方法重载修正了定义类似Point类等价性的问题。然而，关于类的等价性仍然有其他的问题点待发现。
未完待续......
