一家反欺诈公司的面试经历——4.equals方法的重写

什么时候需要重写equals()?

　　我们知道每一个java类都继承自Object类，equals()是Object类中提供的方法之一。那么，让我们先来看看Object#equals()在Java中的原代码：

public boolean equals(Object obj)

{

　　return (this == obj);

}

可以看出，只有当一个实例等于它本身的时候，equals()才会返回true值。通俗地说，此时比较的是两个引用是否指向内存中的同一个对象，也可以称做是否实例相等。而我们在使用equals()来比较两个指向值对象的引用的时候，往往希望知道它们逻辑上是否相等，而不是它们是否指向同一个对象。在这样的情况下， 如果超类也没有重写equals()以实现期望的行为，这时我们就需要重写equals方法。而且这样做也使得这个类的实例可以被用做映射表(map)的键，或者集合(set)的元素，并使映射表或者集合表现出预期的行为。

怎样重写equals()方法？

　　重写equals()方法看起来非常简单，但是有许多改写的方式会导致错误，并且后果非常严重。要想正确改写equals()方法，你必须要遵守它的通用约定。下面是约定的内容，来自java.lang.Object的规范：

equals方法实现了等价关系(equivalence relation):

1. 自反性：对于任意的引用值x，x.equals(x)一定为true。

2. 对称性：对于任意的引用值x 和 y，当x.equals(y)返回true时，

　　y.equals(x)也一定返回true。

3. 传递性：对于任意的引用值x、y和ｚ，如果x.equals(y)返回true，

　　并且y.equals(z)也返回true，那么x.equals(z)也一定返回true。

4. 一致性：对于任意的引用值x 和 y，如果用于equals比较的对象信息没有被修

　　改，多次调用x.equals(y)要么一致地返回true，要么一致地返回false。

5. 非空性：对于任意的非空引用值x，x.equals(null)一定返回false。

接下来我们通过实例来理解上面的约定。我们首先以一个简单的非可变的二维点类作为开始：

public class Point{
　　private final int x;
　　private final int y;
　　public Point(int x, int y){
　　　　this.x = x;
　　　　this.y = y;
　　}
　　public boolean equals(Object o){
　　　　if(!(o instanceof Point))
　　 　　　return false;
　　　　Point p = (Point)o;
　　　　　　return p.x == x && p.y == y;
　　}
} 

 

假设你想要扩展这个类，为一个点增加颜色信息：

public class ColorPoint extends Point{
　　private Color color;
　　public ColorPoint(int x, int y, Color color){
　　　　super(x, y);
　　　　this.color = color;
　　}
　　//override equasl()
　　public boolean equals(Object o){
　　　　if(!(o instanceof ColorPoint))
　　　　　return false;
　　　　ColorPoint cp = (ColorPoint)o;
　　　　return super.equals(o) && cp.color==color;
　　}
} 

 

　　我们重写了equals方法，只有当实参是另一个有色点，并且具有同样的位置和颜色的时候，它才返回true。可这个方法的问题在于，你在比较一个普通点和一个有色点，以及反过来的情形的时候，可能会得到不同的结果：

public static void main(String[] args){
　　Point p = new Point(1, 2);
　　ColorPoint cp = new ColorPoint(1, 2, Color.RED);
　　System.out.println(p.equals(cp));
　　System.out.println(cp.eqauls(p));
} 

运行结果：

true  

false

这样的结果显然违反了对称性，你可以做这样的尝试来修正这个问题：让ColorPoint.equals在进行“混合比较”的时候忽略颜色信息：

public boolean equals(Object o){
　　if(!(o instanceof Point))
　　　　return false;
　　//如果o是一个普通点，就忽略颜色信息
　　if(!(o instanceof ColorPoint))
　　　　return o.equals(this);
　　//如果o是一个有色点，就做完整的比较
　　ColorPoint cp = (ColorPoint)o;
　　return super.equals(o) && cp.color==color;
} 

这种方法的结果会怎样呢？让我们先来测试一下：

public static void main(String[] args){
　　ColorPoint p1 = new ColorPoint(1, 2, Color.RED);
　　Point p2 = new Point(1, 2);
　　ColorPoint p3 = new ColorPoint(1, 2, Color.BLUE);
　　System.out.println(p1.equals(p2));
　　System.out.println(p2.equals(p1));
　　System.out.println(p2.equals(p3));
　　System.out.println(p1.eqauls(p3));
} 

运行结果：

true

true

true

false

　　这种方法确实提供了对称性，但是却牺牲了传递性(按照约定，p1.equals(p2)和p2.eqauals(p3)都返回true，p1.equals(p3)也应返回true)。要怎么解决呢？事实上，这是面向对象语言中关于等价关系的一个基本问题。要想在扩展一个可实例化的类的同时，既要增加新的特征，同时还要保留equals约定，没有一个简单的办法可以做到这一点。新的解决办法就是不再让ColorPoint扩展Point，而是在ColorPoint中加入一个私有的Point域，以及一个公有的视图(view)方法：

public class ColorPoint{
　　private Point point;
　　private Color color;
　　public ColorPoint(int x, int y, Color color){
　　　　point = new Point(x, y);
　　　　this.color = color;
　　}
　　//返回一个与该有色点在同一位置上的普通Point对象
　　public Point asPoint(){
　　　　return point;
　　}
　　public boolean equals(Object o){
　　　　if(o == this)
　　　　　return true;
　　　　if(!(o instanceof ColorPoint))
　　　　　return false;
　　　　ColorPoint cp = (ColorPoint)o;
　　　　return cp.point.equals(point)&&
　　　　　　　　　　　　　cp.color.equals(color);
　　}
} 

　　还有另外一个解决的办法就是把Point设计成一个抽象的类(abstract class)，这样你就可以在该抽象类的子类中增加新的特征，而不会违反equals约定。因为抽象类无法创建类的实例，那么前面所述的种种问题都不会发生。

重写equals方法的诀窍：

1. 使用==操作符检查“实参是否为指向对象的一个引用”。

2. 使用instanceof操作符检查“实参是否为正确的类型”。

3. 把实参转换到正确的类型。

4. 对于该类中每一个“关键”域，检查实参中的域与当前对象中对应的域值是否匹配。对于既不是float也不是double类型的基本类型的域，可以使用==操作符进行比较；对于对象引用类型的域，可以递归地调用所引用的对象的equals方法；对于float类型的域，先使用Float.floatToIntBits转换成int类型的值，然后使用==操作符比较int类型的值；对于double类型的域，先使用Double.doubleToLongBits转换成long类型的值，然后使用==操作符比较long类型的值。

5. 当你编写完成了equals方法之后，应该问自己三个问题：它是否是对称的、传递的、一致的？(其他两个特性通常会自行满足)如果答案是否定的，那么请找到 这些特性未能满足的原因，再修改equals方法的代码。