重写equals 方法的注意事项

java.lang.Object 中的equals方法如下

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

什么时候需要重写equals方法

使用equals方法比较一个类的两个对象，希望能在逻辑上比较这两个对象是否相等，而不是比较这两个对象的引用是否相同，一般这个时候就需要重写equals方法了。

重写equals方法的约定

重写equals方法的注意事项写在了方法说明中，可以点击这里查看。

翻译过来的要点如下

equals方法实现了一个等价关系（equivalence relation）。它有以下这些属性:
• 自反性：对于任何非空引用x，x.equals(x)必须返回true。
• 对称性：对于任何非空引用x和y，如果且仅当y.equals(x)返回true时x.equals(y)必须返回true。
• 传递性：对于任何非空引用x、y、z，如果x.equals(y)返回true，y.equals(z)返回true，则x.equals(z)必须返回true。
• 一致性：对于任何非空引用x和y，如果在equals比较中使用的信息没有修改，则x.equals(y)的多次调用必须始终返回true或始终返回false。
• 非空性: 对于任何非空引用x，x.equals(null)必须返回false。
当重写equals方法时，同时也要重写hashCode方法。

是不是看着有点晕，没错，重写equasl方法看起来很简单，但是有很多种方式会导致重写出错。所以最好的做法是，没有必要不要重写equals方法。

如果一定要重写呢，有没有比较省力不容易出错的方法？答案是有的，那就是使用google 的AutoValue开源框架或者IDE自动生成功能。如果使用AutoValue框架，只需要在类上添加一个注解，框架就会自动帮你生成equals方法。

如果一定要自己重写，在重写之后要问自己三个问题：它是对称的吗?它是传递吗?它是一致的吗?（另外两个属性，自反性和非空性一般都都满足），然后还需要编写单元测试加以验证。下面是一个重写equals方法的例子：

public final class PhoneNumber {

    private final short areaCode, prefix, lineNum;

    public PhoneNumber(int areaCode, int prefix, int lineNum) {
        this.areaCode = rangeCheck(areaCode, 999, "area code");
        this.prefix = rangeCheck(prefix, 999, "prefix");
        this.lineNum = rangeCheck(lineNum, 9999, "line num");
    }

    private static short rangeCheck(int val, int max, String arg) {
        if (val < 0 || val > max)
            throw new IllegalArgumentException(arg + ": " + val);
        
        return (short) val;
    }

    @Override
    public boolean equals(Object o) {
        if (o == this)
            return true;
        if (!(o instanceof PhoneNumber))
            return false;

        PhoneNumber pn = (PhoneNumber) o;

        return pn.lineNum == lineNum && pn.prefix == prefix
                && pn.areaCode == areaCode;
    }

    ... // Remainder omitted
}

另外，重写了equals方法，一定要重写hashCode方法。重写hashCode方法的注意事项，请看这里。

参考文章：

Effective Java 第三版——10. 重写equals方法时遵守通用约定