Java中 equals() 和 hashCode()的关系

用此blog记录我学习的过程，文中若有不恰当的地方，还望友情指出互相学习。

---

上篇文章谈到了==与equals()的区别，关于equals()方法与hashCode()方法网上有很多教程，这里我翻译一篇国外作者写的文章（文末会注明出处），我觉得写得很棒，分享给大家

Java equals()

在Object类中定义了equals()方法，源码如下：

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

根据java文档中对equals()方法的说明，该方法的实现要满足以下原则：

• 自反性 ：对于任何非空的引用值x ， x.equals(x)应该返回true
• 对称性：对于任何非空引用值x和y ， x.equals(y)应该返回true当且仅当y.equals(x)返回true
• 传递性 ：对于任何非空引用值x ，y和z ，如果x.equals(y)返回true且y.equals(z)返回rue ，那么x.equals(z)应该返回true
• 一致性 ：除非对equals()方法实现中使用的任何对象属性进行修改，否则x.equals(y)的多次调用应返回相同的结果（true or false）
• 对于任何非空的引用值x ， x.equals(null)应该返回false

Java hashCode()

Java hashCode()是一种native方法，它返回对象的整数哈希码值， hashCode()方法的常规协定为：

• 除非对equals（）方法中使用的object属性进行修改，否则hashCode（）的多次调用应返回相同的整数值
• 对象的哈希码值可以在同一应用程序的多次执行中更改
• 如果根据equals（）方法，两个对象相等，则它们的哈希码相同，即x.equals(y)返回true, 则，x.hashCode()==y.hashCode()返回true
• 如果根据equals（）方法，两个对象不相等，则它们的哈希码值可能相等也可能不相等

equals() and hashCode() 方法的原则

Java hashCode（）和equals（）方法基于哈希表的实现，用于存储和检索数据。
equals（）和hashCode（）的实现应遵循以下规则：

• If o1.equals(o2), then o1.hashCode() == o2.hashCode() should always be true.
• If o1.hashCode() == o2.hashCode is true, it doesn’t mean that o1.equals(o2) will be true.

何时重写equals() 和hashCode() 方法

当我们重写equals()方法时，几乎肯定要重写hashCode()方法了，以免我们的代码实现违反其规则
请注意，如果违反了equals（）和hashCode（）合约，则程序不会引发任何异常；如果你不打算将此类用作哈希表键，则不会造成任何问题
但如果你打算将此类用作hash表键，那么必须同时重写equals()与hashCode()方法
我们先举个例字看看将一个类作为hash表键，但并不重写equals()与hashCode()方法会发生什么：

public class Student {
    private String name;
    private Integer age;

	//getter and setter methods
	
    @Override
    public String toString() {
        return "Student{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

public class HashingTest {
    public static void main(String[] args) {
        Map<Student, Integer> map = getAllData();
        Student student = new Student();
        student.setAge(1);
        student.setName("世银");
        System.out.println(student.hashCode());
        Integer value = map.get(student);
        System.out.println(value);  //null
    }

    private static Map<Student, Integer> getAllData() {
        Map<Student, Integer> map = new HashMap<>();
        Student student = new Student();
        student.setAge(1);
        student.setName("世银");
        System.out.println(student.hashCode());
        map.put(student, 10);
        return map;
    }
}

当我们运行程序时，会打印输出null。这是因为当使用Object的 hashCode（）方法来查找存储区以查找key，我们再次创建该key以检索数据，因此你会注意到两个对象的哈希码值不同，因此找不到该值

重写 equals() and hashCode() 方法

我们可以定义自己的equals（）和hashCode（）方法实现，但是如果我们不仔细实现它们，则在运行时可能会出现奇怪的问题，幸运的是，如今，大多数IDE提供了自动实现它们的方法，并且如果需要，我们可以根据需要进行更改。以下以IDEA为例，鼠标右键即可：

下面是自动生成的equals()方法与hashCode()方法：

@Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Student student = (Student) o;
        return Objects.equals(name, student.name) &&
                Objects.equals(age, student.age);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, age);
    }

注意到equals（）和hashCode（）方法都使用相同的字段进行计算，再次运行上面的测试程序会发现输出结果为10

什么是 Hash 碰撞

简单来说，Java Hash表使用以下逻辑来实现对数据的获取和放置操作：

1. 首先使用key的hash码来确定要使用的存储桶
2. 如果存储桶中不存在具有相同哈希码的对象，则添加该对象以进行放置操作，并返回空值以进行获取操作
3. 如果存储桶中还有其他具有相同哈希码的对象，则键的equals()方法开始起作用：

• 如果equals（）返回true且是放置操作，则对象值将被覆盖
• 如果equals（）返回false且是放置操作，则新entry将添加到存储桶中
• 如果equals（）返回true并且是get操作，则返回对象值
• 如果equals（）返回false并且是get操作，则返回null

下图显示了HashMap的存储桶项以及它们的equals（）和hashCode（）是如何关联的
两个键具有相同哈希码的现象称为哈希冲突，上图中K1、K2和K3都具有相同的哈希码，因此发生了哈希冲突。如果hashCode（）方法未正确实现，则哈希冲突数量将更多，并且映射条目将无法正确分布，从而导致get和put操作变慢。这就是在生成哈希码时使用质数的原因，以便映射条目正确分布在所有存储桶中。（感觉这都是数据结构中的内容哈）

如果不同时实现equals()方法和hashCode()方法会怎样

• 上面我们已经看到，如果未实现hashCode（），我们将无法检索该值，因为HashMap使用哈希码来查找存储桶以查找数据
• 如果我们仅使用hashCode（）而未实现equals（），那么由于equals（）方法将返回false，因此也不会检索到value

实现equals()和hashCode()方法的最佳实践

• 在equals（）和hashCode（）方法实现中使用相同的属性，以便在更新任何属性时都不会违反其合同
• 最好将不可变的对象用作哈希表键，以便我们可以缓存哈希码，而不是在每次调用时都对其进行计算。这就是为什么String是哈希表键的理想选择的原因，因为它是不可变的，并且可以缓存哈希码值
• 实现hashCode（）方法，以使发生最少数量的哈希冲突，并且条目在所有存储桶中均匀分布

---

注：总之就是equals()方法与hashCode()方法要一起重写，尽量用String来作为哈希表键

原文出处：
https://www.journaldev.com/21095/java-equals-hashcode