为什么重写了equals()还要重写hashcode()?

equals和hashcode间的关系：
1.如果两个对象相同（即equals比较返回true），那么他们的hashcode一定要相等
2.如果他们的hashcode相等，他们的equals不一定相等
为什么重写equals
我们比较两个对象，不需要他们的地址相同才能相等的，只需要他们的各个属性相同，我们就认为他们是相等的。
hashCode（）方法用于返回调用该方法的对象的散列码值，此方法返回整数类型的散列码值。
为什么重写equals还要重写hashcode
假设两个对象，重写了其equals方法，其相等条件是属性相等，equals比较之后返回true说明假设的两个对象相等，如果没有重写hashcode的话，其返回的依然是两个对象的内存地址，那么他们的hashcode不相同，这和上面的equals和hashcode间的关系相矛盾！所以如果根据equals(Object)方法，两个对象是相等的，那么在两个对象中的每个对象上调用hashCode()方法必须生成相同的整数结果。
注意：相等的对象必须有相同的散列码，反之散列码相同则不一定对象相等，而且不相等的对象并不一定需要有不同的散列码。
————————————————
版权声明：本文为CSDN博主「Hai-Yang-code」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/weixin_45007916/article/details/106011397

我所了解的应用场景是当我们写了一个类，如果要使用这个类的对象作为HashMap或者HashSet的key值的话，那么我们需要重写这个类的equals方法和hashcode方法，阅读本文需要一些Hashmap的源码分析能力

自定义类

先来自定义一个类user

import java.util.HashSet;

/**
 * Created by 此生辽阔 on 2021/7/20 22:27
 */
public class testRewriteHashCode {
    public static void main(String[] args) {
        HashSet hashSet = new HashSet();
        hashSet.add(new user("tom"));
        hashSet.add(new user("tom"));
        System.out.println( hashSet);
    }
   static class user{
        String name;

        public user(String name) {
            this.name = name;
        }
    }
}

从执行结果可以看到，两个user对象都被存进了 hashSet，但这并不是我们希望的结果，因为这两个对象的字段值完全相同，我们无法进行区分，我们更希望在hashSet中把字段值完全相同(user类的字段只有name)的对象视作同一个对象。

重写equals,不重写hashcode

  @Override
       public boolean equals(Object obj) {
           if(obj == null){
               return false;
           }
           user obj1 = (user)obj;
           if(this.name.equals(obj1.name) ){
               return true;
           }
           return false;
       }

运行结果
从结果可以看到，还是存进了两个对象，并不是我们想要的结果

我们打断点进入调试

可以看到，下图这里判断p=null,因为后插入的user对象跟先插入的user对象的hash值不一样，所以把新的user对象插入了数组中的另一个索引位置

我们可以看到此时的内存排列

这是hash值的计算代码，可以看到跟key的hashCode()方法有关，这里的key就是我们自定义的类user

 static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

为了让两个user对象判断为重复插入，我们需要重写hashCode()函数，使得字段值相同的user对象的哈希值计算相等

重写hashcode不重写equals

 @Override
       public int hashCode() {
           return name.hashCode();
       }

从下图结果可以看出，只重写hashcode不重写equals依然会把两个字段值相同的user对象都存进hashSet.

Debug分析

从添加完数据的内存布局我们可以看到，两个user对象都存进了数组中索引为3的位置。即形成了一条链表，可以看到这两个user对象的hashcode值一样，为了避免碰撞，从而形成了一条链表（先插入的user对象的next指针指向后插入的user对象）

调试过程中，我们发现下面这个if条件是不满足的

if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))

我们来分析一下，(k = p.key) == key这个肯定是不满足的，因为key是user对象，而对于引用类型，双等于比较的是对象地址，两个对象都是new出来的，地址肯定不一样

但是我们还可以寄希望于key.equals(k)，如果这个条件满足，那么整个if条件还是满足的

但是我们并没有重写user类的equals方法，那么这个equals方法就是沿用的父类的equals方法，父类即Object类

我们看看父类的equals方法

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

可以看到，父类的equals方法调用的是==，那么我们没有重写equals的情况下，还是比较的是两个对象的地址，所以key.equals(k)为false

整个if语句不成立

接下来会判断p是否是 TreeNode，可以看到现在还没有转化成红黑树，所以判断条件也不成立
于是执行了下面的代码，将新插入的user对象挂载到之前的user对象后面形成了一条链表

重写equals和hashcode

import java.util.HashSet;

/**
 * Created by 此生辽阔 on 2021/7/20 22:27
 */
public class testRewriteHashCode {
    public static void main(String[] args) {
        HashSet hashSet = new HashSet();
        hashSet.add(new user("tom"));
        hashSet.add(new user("tom"));
        System.out.println( hashSet);
    }
   static class user{
        String name;

        public user(String name) {
            this.name = name;
        }

       @Override
       public int hashCode() {
           return name.hashCode();
       }

       @Override
       public boolean equals(Object obj) {
           if(obj == null){
               return false;
           }
           user obj1 = (user)obj;
           if(this.name.equals(obj1.name) ){
               return true;
           }
           return false;
       }
   }
}

从结果可以看到，虽然添加了两次元素，但是hashSet里面只有一个元素，这是因为重写了hashcode和equals方法之后，两个字段值相同的user对象的hash值计算相等且equals判断相等，经过debug分析，这种情况下，后插入的user对象会覆盖之前插入的user对象的value值（因为HashMap是key -value形式的，HashSet只是用了HashMap的key，HashSet的value默认为PRESENT，是HashSet的一个属性）

HashSet的value默认为PRESENT，是HashSet的一个属性，如下，准确地说是HashSet里面的map的每一个value都是PRESENT

  private transient HashMap<E,Object> map;
 private static final Object PRESENT = new Object();
public boolean add(E e) {
        return map.put(e, PRESENT)==null;
    }

Debug分析

经过debug分析，在user对象的字段值相等的情况下，且user类重写了hashcode和equals方法的情况下后插入的user对象会覆盖之前插入的user对象的value值，两个对象被判断为相同元素，不能重复插入HashSet

总结

当我们把自定义类的对象作为HashMap或者HashSet的key值的时候，我们应该重写自定义类的hashcode()方法和equals方法

如果不重写hashcode()方法和equals方法，我们将能够插入两个字段值完全相同的对象，这不利于我们再去HashMap或者HashSet中查找元素

如果只重写equals方法不重写hashcode方法，当两个对象的字段值完全一样时，计算出来的hashcode不一样，会将这两个对象插入到HashMap底层数组的不同位置（因为元素在数组中的索引是根据hash值计算的）

如果只重写hashcode方法不重写equals方法，则两个对象的字段值完全一样时，会在HashMap底层数组中形成一个链表

建议小伙伴们自己去Debug跑一下

附上HashMap的putVal方法的实现

 /**
     * Implements Map.put and related methods
     *
     * @param hash hash for key
     * @param key the key
     * @param value the value to put
     * @param onlyIfAbsent if true, don't change existing value
     * @param evict if false, the table is in creation mode.
     * @return previous value, or null if none
     */
    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;
            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;
    }

推荐阅读

为什么重写了equals方法后还需要重写hashCode方法