06-hashCode() 和 equals() 之间的关系

上一篇关于介绍Object类下的几种方法时面试题时，提到equals()和hashCode()方法可能引出关于“hashCode() 和 equals() 之间的关系？”的面试题，本篇来解析一下这道基础面试题。

先祭一张图，可以思考一下为什么？

介绍

equals() 的作用是用来判断两个对象是否相等。

hashCode() 的作用是获取哈希码，也称为散列码；它实际上是返回一个int整数。这个哈希码的作用是确定该对象在哈希表中的索引位置。

关系

我们以“类的用途”来将“hashCode() 和 equals()的关系”分2种情况来说明。

1、不会创建“类对应的散列表”

这里所说的“不会创建类对应的散列表”是说：我们不会在HashSet, Hashtable, HashMap等等这些本质是散列表的数据结构中，用到该类。例如，不会创建该类的HashSet集合。

在这种情况下，该类的“hashCode() 和 equals() ”没有半毛钱关系的！equals() 用来比较该类的两个对象是否相等。而hashCode() 则根本没有任何作用。

下面，我们通过示例查看类的两个对象相等 以及 不等时hashCode()的取值。

package demo.java.jiangkd.hashcode_equals;

import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

@Getter
@Setter
@ToString
@Builder
public class Person1 {

    private String name;
    private int age;

    // 重写equals方法
    @Override
    public boolean equals(Object obj) {
        //
        if (null == obj) {
            return false;
        }

        // 判断类型是否相同
        if (!(obj instanceof Person1)) {
            return false;
        }

        // 如果是同一个对象返回true，反之返回false
        if (this == obj) {
            return true;
        }

        Person1 person1 = (Person1)obj;

        return this.getName().equals(person1.getName()) && this.getAge() == person1.getAge();
    }
}

package demo.java.jiangkd.hashcode_equals;

import java.util.Set;

import org.junit.Test;

import cn.hutool.core.collection.CollUtil;
import lombok.extern.slf4j.Slf4j;

/**
 * 
 * @author jiangkd
 * @date 2020/09/10
 */
@Slf4j
public class NormalHashCodeDemo {

    @Test
    public void test() {
        //
        Person1 p1 = Person1.builder().name("jiangkd").age(18).build();
        Person1 p2 = Person1.builder().name("jiangkd").age(18).build();
        Person1 p3 = Person1.builder().name("jiangkd").age(20).build();
        //
        Set<Person1> personSet = CollUtil.newHashSet(p1, p2, p3);

        log.info("p1.equals(p2) -> {}", p1.equals(p2));
        
        log.info("p1 hashCode -> {}", p1.hashCode());
        log.info("p2 hashCode -> {}", p2.hashCode());
        
        log.info("p1.equals(p3) -> {}", p1.equals(p3));
        
        log.info("p1 hashCode -> {}", p1.hashCode());
        log.info("p3 hashCode -> {}", p3.hashCode());
        
        log.info("personSet -> {}", personSet.toString());
    }
}

运行...

14:40:55.277 [main] INFO demo.java.jiangkd.hashcode_equals.NormalHashCodeDemo - p1.equals(p2) -> true
14:40:55.299 [main] INFO demo.java.jiangkd.hashcode_equals.NormalHashCodeDemo - p1 hashCode -> 2125238280
14:40:55.299 [main] INFO demo.java.jiangkd.hashcode_equals.NormalHashCodeDemo - p2 hashCode -> 1092004553
14:40:55.299 [main] INFO demo.java.jiangkd.hashcode_equals.NormalHashCodeDemo - p1.equals(p3) -> false
14:40:55.299 [main] INFO demo.java.jiangkd.hashcode_equals.NormalHashCodeDemo - p1 hashCode -> 2125238280
14:40:55.300 [main] INFO demo.java.jiangkd.hashcode_equals.NormalHashCodeDemo - p3 hashCode -> 1658699134
14:40:55.300 [main] INFO demo.java.jiangkd.hashcode_equals.NormalHashCodeDemo - personSet -> [Person1(name=jiangkd, age=20), Person1(name=jiangkd, age=18), Person1(name=jiangkd, age=18)]

从结果也可以看出：p1和p2equals比较相等的情况下，hashCode()也不一定相等。

也可以看出personSet中有重复的Person1元素, 为什么呢? 继续往下看....

2、会创建“类对应的散列表”

这里所说的“会创建类对应的散列表”是说：我们会在HashSet, Hashtable, HashMap等等这些本质是散列表的数据结构中，用到该类。例如，会创建该类的HashSet集合。

在这种情况下，该类的“hashCode() 和 equals() ”是有关系的：

• 如果两个对象相等，那么它们的hashCode()值一定相同。这里的相等是指，通过equals()比较两个对象时返回true。

• 如果两个对象hashCode()相等，那么两个对象并不一定相等。因为在散列表中，hashCode()相等，即两个键值对的哈希值相等。然而哈希值相等，并不一定能得出键值对相等。补充说一句：“两个不同的键值对，哈希值相等”，这就是哈希冲突。

这是, 若要判断两个对象是否相等，除了要覆盖equals()之外，也要覆盖hashCode()函数。否则，equals()无效。

举例，创建Person类的HashSet集合，必须同时覆盖Person类的equals() 和 hashCode()方法, 如果只是覆盖了equals()方法, 就会发现equals()方法没有达到我们想要的效果。所以就出现了上面personSet中两个重复元素同时存在的问题...也就是personSet中存在两个Person1(name=jiangkd, age=18), 为什么会出现这种情况呢？

这是因为虽然两个Person1的内容(name和age)相等，但是它们的hashCode()不等；所以，HashSet在添加两个Person1的时候，认为它们不相等。

那同时覆盖equals() 和 hashCode()方法呢？

创建对象Person2, 和上面的Person1相同, 但是比Person1多重写了一个hashCode()方法, 如下...

　// 重写hashcode
  @Override
  public int hashCode() {
      //
      int nameHashCode = name.toUpperCase().hashCode();
      return nameHashCode ^ age;
  }

此时Person2重写了equals和hashCode方法

package demo.java.jiangkd.hashcode_equals;

import java.util.Set;

import org.junit.Test;

import cn.hutool.core.collection.CollUtil;
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class ConflictHashCodeDemo {

    @Test
    public void test() {
        //
        Person2 p1 = Person2.builder().name("jiangkd").age(18).build();
        Person2 p2 = Person2.builder().name("jiangkd").age(18).build();
        Person2 p3 = Person2.builder().name("jiangkd").age(20).build();
        Person2 p4 = Person2.builder().name("JIANGKD").age(18).build();
        //
        Set<Person2> personSet = CollUtil.newHashSet(p1, p2, p3);

        log.info("p1.equals(p2) -> {}", p1.equals(p2));

        log.info("p1 hashCode -> {}", p1.hashCode());
        log.info("p2 hashCode -> {}", p2.hashCode());

        log.info("p1.equals(p3) -> {}", p1.equals(p3));

        log.info("p1 hashCode -> {}", p1.hashCode());
        log.info("p3 hashCode -> {}", p3.hashCode());
        
        log.info("p1.equals(p4) -> {}", p1.equals(p4));
        log.info("p1 hashCode -> {}", p1.hashCode());
        log.info("p4 hashCode -> {}", p4.hashCode());

        log.info("personSet -> {}", personSet.toString());
    }
}

运行结果...

14:57:26.231 [main] INFO demo.java.jiangkd.hashcode_equals.ConflictHashCodeDemo - p1.equals(p2) -> true
14:57:26.240 [main] INFO demo.java.jiangkd.hashcode_equals.ConflictHashCodeDemo - p1 hashCode -> -891853146
14:57:26.240 [main] INFO demo.java.jiangkd.hashcode_equals.ConflictHashCodeDemo - p2 hashCode -> -891853146
14:57:26.240 [main] INFO demo.java.jiangkd.hashcode_equals.ConflictHashCodeDemo - p1.equals(p3) -> false
14:57:26.240 [main] INFO demo.java.jiangkd.hashcode_equals.ConflictHashCodeDemo - p1 hashCode -> -891853146
14:57:26.240 [main] INFO demo.java.jiangkd.hashcode_equals.ConflictHashCodeDemo - p3 hashCode -> -891853152
14:57:26.240 [main] INFO demo.java.jiangkd.hashcode_equals.ConflictHashCodeDemo - p1.equals(p4) -> false
14:57:26.240 [main] INFO demo.java.jiangkd.hashcode_equals.ConflictHashCodeDemo - p1 hashCode -> -891853146
14:57:26.240 [main] INFO demo.java.jiangkd.hashcode_equals.ConflictHashCodeDemo - p4 hashCode -> -891853146
14:57:26.240 [main] INFO demo.java.jiangkd.hashcode_equals.ConflictHashCodeDemo - personSet -> [Person2(name=jiangkd, age=18), Person2(name=jiangkd, age=20)]

结果分析：

这下，equals()生效了，personSet中没有重复元素。

比较p1和p2，我们发现：它们的hashCode()相等，通过equals()比较它们也返回true。所以，p1和p2被视为相等。

比较p1和p4，我们发现：虽然它们的hashCode()相等；但是，通过equals()比较它们返回false。所以，p1和p4被视为不相等。

原则

1.同一个对象（没有发生过修改）无论何时调用hashCode()得到的返回值必须一样。

如果一个key对象在put的时候调用hashCode()决定了存放的位置，而在get的时候调用hashCode()得到了不一样的返回值，这个值映射到了一个和原来不一样的地方，那么肯定就找不到原来那个键值对了

2.hashCode()的返回值相等的对象不一定相等，通过hashCode()和equals()必须能唯一确定一个对象。
不相等的对象的hashCode()的结果可以相等。hashCode()在注意关注碰撞问题的时候，也要关注生成速度问题，完美hash不现实。

3.一旦重写了equals()函数（重写equals的时候还要注意要满足自反性、对称性、传递性、一致性），就必须重写hashCode()函数。

而且hashCode()的生成哈希值的依据应该是equals()中用来比较是否相等的字段。

如果两个由equals()规定相等的对象生成的hashCode不等，对于hashMap来说，他们很可能分别映射到不同位置，没有调用equals()比较是否相等的机会，两个实际上相等的对象可能被插入不同位置，出现错误。其他一些基于哈希方法的集合类可能也会有这个问题