关于重写equals同时重写hashcode

1.Object中equals方法和hashcode

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

public native int hashCode();

可以看出Object的equals是使用“==”实现的，即该对象的地址比较而不是内容

2.为什么重写equels需要重写hashcode

当对象的equals()方法被重写时，通常有必要重写 hashCode() 方法，以维护 hashCode 方法的常规协定，该协定声明相等对象必须具有相等的哈希码。

​ （1）两个对象相等，hashcode一定相等

​ （2）两个对象不等，hashcode不一定不等

​ （3）hashcode相等，两个对象不一定相等

​ （4）hashcode不等，两个对象一定不等

3.HashMap中使用自定义类作为Key时，为何要重写HashCode和Equals方法

首先以Person类为键存入Hashmap中

public class Person {

    private String id;

    public Person(String id) {
        this.id = id;
    }
}

main

public static void main(String[] args) {
    HashMap<Person, String> map = new HashMap<Person, String>();

    map.put(new Person("001"), "findingsea");
    map.put(new Person("002"), "linyin");
    map.put(new Person("003"), "henrylin");
    map.put(new Person("003"), "findingsealy");

    System.out.println(map.toString());

    System.out.println(map.get(new Person("001")));
    System.out.println(map.get(new Person("002")));
    System.out.println(map.get(new Person("003")));
}

结果

{Person@6e4d4d5e=henrylin, Person@275cea3=findingsea, Person@15128ee5=findingsealy, Person@4513098=linyin}
null
null
null

我们可以看到，这里出现了两个问题：

1. 在添加的过程中，我们将key=new Person("003")的键值对添加了两次，那么在期望中，HashMap中应该只存在一对这样的键值对，因为key（期望中）是相同的，所以不应该重复添加，第二次添加的value="findingsealy"应该替换掉原先的value="henrylin"。但是在输入中，我们发现期望中的情况并没有出现，而是在HashMap同时存在了value="findingsealy"和value="henrylin"的两个键值对，并且它们的key值还是不相同的，这显然是错误的。
2. 在获取value值时，我们分别用三个Person对象去查找，这三个对象和我们刚刚存入的三个key值（在期望中）是相同的，但是查找出的却是三个null值，这显然也是错误的。

那么，正确的方法其实在很多地方都是被描述过了，直接对Person类进行修改，重写equals和hashCode方法，修改过后的Person类如下：

public class Person {
	private String id;

    public Person(String id) {
        this.id = id;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        Person person = (Person) o;

        if (id != null ? !id.equals(person.id) : person.id != null) return false;

        return true;
    }

    @Override
    public int hashCode() {
        return id != null ? id.hashCode() : 0;
    }
}

相同main方法的结果

{Person@ba31=findingsea, Person@ba32=linyin, Person@ba33=findingsealy}
findingsea
linyin
findingsealy

可以看到，之前指出的亮点错误都得到了改正。那么，为什么会这样呢？

HashMap.put源码

public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {
            Node<K,V> e; K k;
            //先通过hashcode判断再进行equals判断
            //由于“&&”具有短路功能，所以若hashcode相等，则后面的equals也不会调用
            //HashMap中的key所对应的value就会被覆盖
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                for (int binCount = 0; ; ++binCount) {
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

在HashMap中，查找key的比较顺序为：

1. 计算对象的Hash Code，看在表中是否存在。
2. 检查对应Hash Code位置中的对象和当前对象是否相等。

显然，第一步就是要用到hashCode()方法，而第二步就是要用到equals()方法。在没有进行重载时，在这两步会默认调用Object类的这两个方法，而在Object中，Hash Code的计算方法是根据对象的地址进行计算的，那两个Person("003")的对象地址是不同的，所以它们的Hash Code也不同，自然HashMap也不会把它们当成是同一个key了。同时，在Object默认的equals()中，也是根据对象的地址进行比较，自然一个Person("003")和另一个Person("003")是不相等的。

理解了这一点，就很容易搞清楚为什么需要同时重写hashCode()和equals两个方法了。

• 重写()是为了对同一个key，能得到相同的Hash Code，这样HashMap就可以定位到我们指定的key`上。
• 重写equals()是为了向HashMap表明当前对象和key上所保存的对象是相等的，这样我们才真正地获得了这个key所对应的这个键值对。

还有一个细节，在Person类中对于hashCode()的重写方法为：

@Override
public int hashCode() {
    return id != null ? id.hashCode() : 0;
}

这里可能有疑惑的点在于：为什么可以用String类型的变量的Hash Code作为Person类的Hash Code值呢？这样new Person(new String("003"))和new Person(new String("003"))的Hash Code是相等的吗？

来看看以下代码的输出：

System.out.println("findingsea".hashCode());
System.out.println("findingsea".hashCode());
System.out.println(new String("findingsea").hashCode());
System.out.println(new String("findingsea").hashCode());

728795174
728795174
728795174
728795174

可以看到四条语句的输出都是相等的，很直观的合理的猜测就是String类型也重载了hashCode()以根据字符串的内容来返回Hash Code值，所以相同内容的字符串具有相同的Hash Code。

同时，这也说明了一个问题：为什么在已知hashCode()相等的情况下，还需要用equals()进行比较呢？就是因为避免出现上述例子中的出现的情况，因为根据对Person类的hashCode()方法的重载实现，Person类会直接用id这个String类型成员的Hash Code值作为自己的Hash Code值，但是很显然的，一个Person("003")和一个String("003")是不相等的，所以在hashCode()相等的情况下，还需要用equals()进行比较。