在Java里重写equals和hashCode要注意什么问题

问题：在Java里重写equals和hashCode要注意什么问题

重写equals和hashCode有哪些问题或者陷阱需要注意？

回答一

理论（对于语言律师或比较倾向于数学的人）：

equals() (javadoc) 必须定义为一个相等关系（它必须是自发的，对称的并且是传递的），另外它一定是一致的（如果一个对象没有被修改，那么它一定返回相同的值）。而且 o.equals(null)一定要返回false

hashCode() (javadoc)一定要是一致的（如果一个对象没有按照equals修改的话，它一定保证返回一个相同的值）

这两个方法的关系是：

无论如何 a.equals(b)，那么a.hashCode() 必须等于b.hashCode().

实际上：

如果你重写了其他一个，那么你必须要重写另外那个

使用计算equals（）的一组相同字段去计算hashcode（）

使用来自于Apache Commons Lang library的优秀工具类 EqualsBuilder and HashCodeBuilder

例如

public class Person {
    private String name;
    private int age;
    // ...

    @Override
    public int hashCode() {
        return new HashCodeBuilder(17, 31). // two randomly chosen prime numbers
            // if deriving: appendSuper(super.hashCode()).
            append(name).
            append(age).
            toHashCode();
    }

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

        Person rhs = (Person) obj;
        return new EqualsBuilder().
            // if deriving: appendSuper(super.equals(obj)).
            append(name, rhs.name).
            append(age, rhs.age).
            isEquals();
    }
}

同时也要记住：

当你使用基于哈希的集合或者Map的时候例如：HashSet, LinkedHashSet, HashMap, Hashtable, or WeakHashMap，确定你放进去集合的key对象的hashcode（）的值，在被放进去了集合以后就不再改变。确保这一点的可靠方法就是你的key保证不变，这也会带来其他好处的

文章翻译自Stack Overflow：https://stackoverflow.com/questions/27581/what-issues-should-be-considered-when-overriding-equals-and-hashcode-in-java