读《Effective Java》笔记之 第八条：覆盖equals时请遵守通用约定

不应覆盖equals的情况

equals方法有许多覆盖方式都会导致错误，避免这种错误最简单的办法就是不覆盖equals方法。以下几种情况适合不去覆盖equals

• 类的每个实例本质上都是唯一的
• 不需要“逻辑相等”的概念
• 超类已经覆盖了equals，从超类继承过来的行为对子类也是合适的
• 类是私有或包级私有的，可以确定它的equals方法永远不会被调用；不过这种情况，显然应该覆盖equals方法，并在其中抛出异常，以防被意外调用

需要覆盖equals的情况

• 类是一个仅仅表示值的类，不关心两个引用是否指向同一个对象，只关心两者的值是否相等

注：有一种特殊的值类，不需要覆盖equals方法，即用实例受控确保每个值至多只存在一个对象实例。枚举类型就属于这种类。对于这样的类来说，逻辑相等和实例相等是同一回事。因此Object的equals方法等同于逻辑意义上的equals方法。

覆盖equals需要遵循的通用约定

• 自反性：对于非null的x，x.equals(x)必须返回true
• 对称性：对于非null的x和y，x.equals(y)必须和y.equals(x)相等
• 传递性：对于非null的x、y和z，如果x.equals(y)返回true，并且y.equals(z)返回true，那么x.equals(z)也必须返回true
• 一致性：对于非null的x和y，只要equals的比较操作在对象中所用的信息没有被修改，多次调用x.equals(y)的返回值不会改变。
• 对于任何非null的x，x.equals(null)必须返回false

通常容易犯错的地方

违反对称性

例如想要实现一个不区分大小写的String类

// Broken - violates symmetry
public final class CaseInsensitiveString {
    private final String s;

    public CaseInsensitiveString(String s) {
        if (s == null) throw new NullPointerException();
        this.s = s;
    }

    // Broken - violates symmetry!
    @Override
    public boolean equals(Object o) {
        if (o instanceof CaseInsensitiveString)
            return s.equalsIgnoreCase(((CaseInsensitiveString) o).s);
        if (o instanceof String) // One-way interoperability!
            return s.equalsIgnoreCase((String) o);
        return false;
    }
    
    ...
}

如果写出一下代码，并使用了一个List，则会遇到问题：

CaseInsensitiveString cis = new CaseInsensitiveString("Polish");
String s = "polish";

List<CaseInsensitiveString> list = new ArrayList<>();
list.add(cis);

list.contains(s);    // 此处返回值不确定

为了解决这一问题，只需要把企图与String互操作的代码去掉就可以了。

违反传递性

＝＝＝＝＝＝＝＝＝没写完＝＝＝＝＝＝