Java
equals 方法和 hashCode 方法是 Object 类中的两个基础方法,它们共同协作来判断两个对象是否相等。为什么要这样设计嘞?原因就出在“性能” 2 字上。
使用过 HashMap 就知道,通过 hash 计算之后,就可以直接定位出某个值存储的位置了,那么试想一下,如果现在要查询某个值是否在集合中?如果不通过 hash 方式直接定位元素(的存储位置),那么就只能按照集合的前后顺序,一个一个的询问比对了,而这种依次比对的效率明显低于 hash 定位的方式。这就是 hash 以及 hashCode 存在的价值。重写 equals 时为什么一定要重写 hashCode? - 图1重写 equals 时为什么一定要重写 hashCode? - 图2当对比两个对象是否相等时,就可以先使用 hashCode 进行比较,如果比较的结果是 true,那么就可以使用 equals 再次确认两个对象是否相等,如果比较的结果是 true,那么这两个对象就是相等的,否则其他情况就认为两个对象不相等。这样就大大的提升了对象比较的效率,这也是为什么 Java 设计使用 hashCode 和 equals 协同的方式,来确认两个对象是否相等的原因。
那为什么不直接使用 hashCode 就确定两个对象是否相等呢?
这是因为不同对象的 hashCode 可能相同;但 hashCode 不同的对象一定不相等,所以使用 hashCode 可以起到快速初次判断对象是否相等的作用。
但即使知道了以上基础知识,依然解决不了这里的问题,也就是:重写 equals 时为什么一定要重写 hashCode?要想了解这个问题的根本原因,还得先从这两个方法开始说起。

1、equals 方法

Object 类中的 equals 方法用于检测一个对象是否等于另外一个对象。在 Object 类中,这个方法将判断两个对象是否具有相同的引用。如果两个对象具有相同的引用,它们一定是相等的。
equals 方法的实现源码如下:

  1. public boolean equals(Object obj) {
  2. return (this == obj);
  3. }

通过上述源码和 equals 的定义可以看出,在大多数情况来说,equals 的判断是没有什么意义的!例如,使用 Object 中的 equals 比较两个自定义的对象是否相等,这就完全没有意义(因为无论对象是否相等,结果都是 false)。
通过以下示例,就可以说明这个问题:

  1. public class EqualsMyClassExample {
  2. public static void main(String[] args) {
  3. Person u1 = new Person();
  4. u1.setName("Java");
  5. u1.setAge(18);
  6. Person u2 = new Person();
  7. u1.setName("Java");
  8. u1.setAge(18);
  9. // 打印 equals 结果
  10. System.out.println("equals 结果:" + u1.equals(u2));
  11. }
  12. }
  13. class Person {
  14. private String name;
  15. private int age;
  16. public String getName() {
  17. return name;
  18. }
  19. public void setName(String name) {
  20. this.name = name;
  21. }
  22. public int getAge() {
  23. return age;
  24. }
  25. public void setAge(int age) {
  26. this.age = age;
  27. }
  28. }

以上程序的执行结果,如下图所示:重写 equals 时为什么一定要重写 hashCode? - 图3因此通常情况下,要判断两个对象是否相等,一定要重写 equals 方法,这就是为什么要重写 equals 方法的原因。

2、hashCode 方法

hashCode 翻译为中文是散列码,它是由对象推导出的一个整型值,并且这个值为任意整数,包括正数或负数。
需要注意的是:散列码是没有规律的。如果 x 和 y 是两个不同的对象,x.hashCode()y.hashCode() 基本上不会相同;但如果 a 和 b 相等,则 a.hashCode() 一定等于 b.hashCode()
hashCode 在 Object 中的源码如下:

  1. public native int hashCode();

从上述源码可以看到,Object 中的 hashCode 调用了一个(native)本地方法,返回了一个 int 类型的整数,当然,这个整数可能是正数也可能是负数。

hashCode 使用

相等的值 hashCode 一定相同的示例:

  1. public class HashCodeExample {
  2. public static void main(String[] args) {
  3. String s1 = "Hello";
  4. String s2 = "Hello";
  5. String s3 = "Java";
  6. System.out.println("s1 hashCode:" + s1.hashCode());
  7. System.out.println("s2 hashCode:" + s2.hashCode());
  8. System.out.println("s3 hashCode:" + s3.hashCode());
  9. }
  10. }

以上程序的执行结果,如下图所示:重写 equals 时为什么一定要重写 hashCode? - 图4


不同的值 hashCode 也有可能相同的示例:

  1. public class HashCodeExample {
  2. public static void main(String[] args) {
  3. String s1 = "Aa";
  4. String s2 = "BB";
  5. System.out.println("s1 hashCode:" + s1.hashCode());
  6. System.out.println("s2 hashCode:" + s2.hashCode());
  7. }
  8. }

以上程序的执行结果,如下图所示:重写 equals 时为什么一定要重写 hashCode? - 图5

3、为什么要一起重写?

接下来回到本文的主题,重写 equals 为什么一定要重写 hashCode?
为了解释这个问题,需要从下面的这个例子入手。

3.1 Set 正常使用

Set 集合是用来保存不同对象的,相同的对象就会被 Set 合并,最终留下一份独一无二的数据。
它的正常用法如下:

  1. import java.util.HashSet;
  2. import java.util.Set;
  3. public class HashCodeExample {
  4. public static void main(String[] args) {
  5. Set<String> set = new HashSet();
  6. set.add("Java");
  7. set.add("Java");
  8. set.add("MySQL");
  9. set.add("MySQL");
  10. set.add("Redis");
  11. System.out.println("Set 集合长度:" + set.size());
  12. System.out.println();
  13. // 打印 Set 中的所有元素
  14. set.forEach(d -> System.out.println(d));
  15. }
  16. }

以上程序的执行结果,如下图所示:重写 equals 时为什么一定要重写 hashCode? - 图6从上述结果可以看出,重复的数据已经被 Set 集合“合并”了,这也是 Set 集合最大的特点:去重。

3.2 Set 集合的“异常”

然而,如果在 Set 集合中存储的是,只重写了 equals 方法的自定义对象时,有趣的事情就发生了,如下代码所示:

  1. import java.util.HashSet;
  2. import java.util.Objects;
  3. import java.util.Set;
  4. public class EqualsExample {
  5. public static void main(String[] args) {
  6. // 对象 1
  7. Persion p1 = new Persion();
  8. p1.setName("Java");
  9. p1.setAge(18);
  10. // 对象 2
  11. Persion p2 = new Persion();
  12. p2.setName("Java");
  13. p2.setAge(18);
  14. // 创建 Set 集合
  15. Set<Persion> set = new HashSet<Persion>();
  16. set.add(p1);
  17. set.add(p2);
  18. // 打印 Set 中的所有数据
  19. set.forEach(p -> {
  20. System.out.println(p);
  21. });
  22. }
  23. }
  24. class Persion {
  25. private String name;
  26. private int age;
  27. // 只重写了 equals 方法
  28. @Override
  29. public boolean equals(Object o) {
  30. if (this == o) return true; // 引用相等返回 true
  31. // 如果等于 null,或者对象类型不同返回 false
  32. if (o == null || getClass() != o.getClass()) return false;
  33. // 强转为自定义 Persion 类型
  34. Persion persion = (Persion) o;
  35. // 如果 age 和 name 都相等,就返回 true
  36. return age == persion.age &&
  37. Objects.equals(name, persion.name);
  38. }
  39. public String getName() {
  40. return name;
  41. }
  42. public void setName(String name) {
  43. this.name = name;
  44. }
  45. public int getAge() {
  46. return age;
  47. }
  48. public void setAge(int age) {
  49. this.age = age;
  50. }
  51. @Override
  52. public String toString() {
  53. return "Persion{" +
  54. "name='" + name + '\'' +
  55. ", age=" + age +
  56. '}';
  57. }
  58. }

以上程序的执行结果,如下图所示:重写 equals 时为什么一定要重写 hashCode? - 图7从上述代码和上述图片可以看出,即使两个对象是相等的,Set 集合竟然没有将二者进行去重与合并。这就是重写了 equals 方法,但没有重写 hashCode 方法的问题所在。

3.3 解决“异常”

为了解决上面的问题,尝试在重写 equals 方法时,把 hashCode 方法也一起重写了,实现代码如下:

  1. import java.util.HashSet;
  2. import java.util.Objects;
  3. import java.util.Set;
  4. public class EqualsToListExample {
  5. public static void main(String[] args) {
  6. // 对象 1
  7. Persion p1 = new Persion();
  8. p1.setName("Java");
  9. p1.setAge(18);
  10. // 对象 2
  11. Persion p2 = new Persion();
  12. p2.setName("Java");
  13. p2.setAge(18);
  14. // 创建 Set 对象
  15. Set<Persion> set = new HashSet<Persion>();
  16. set.add(p1);
  17. set.add(p2);
  18. // 打印 Set 中的所有数据
  19. set.forEach(p -> {
  20. System.out.println(p);
  21. });
  22. }
  23. }
  24. class Persion {
  25. private String name;
  26. private int age;
  27. @Override
  28. public boolean equals(Object o) {
  29. if (this == o) return true; // 引用相等返回 true
  30. // 如果等于 null,或者对象类型不同返回 false
  31. if (o == null || getClass() != o.getClass()) return false;
  32. // 强转为自定义 Persion 类型
  33. Persion persion = (Persion) o;
  34. // 如果 age 和 name 都相等,就返回 true
  35. return age == persion.age &&
  36. Objects.equals(name, persion.name);
  37. }
  38. @Override
  39. public int hashCode() {
  40. // 对比 name 和 age 是否相等
  41. return Objects.hash(name, age);
  42. }
  43. public String getName() {
  44. return name;
  45. }
  46. public void setName(String name) {
  47. this.name = name;
  48. }
  49. public int getAge() {
  50. return age;
  51. }
  52. public void setAge(int age) {
  53. this.age = age;
  54. }
  55. @Override
  56. public String toString() {
  57. return "Persion{" +
  58. "name='" + name + '\'' +
  59. ", age=" + age +
  60. '}';
  61. }
  62. }

以上程序的执行结果,如下图所示:重写 equals 时为什么一定要重写 hashCode? - 图8通过上述结果可以看出,当一起重写了两个方法之后,奇迹的事情又发生了,Set 集合又恢复正常了,这是为什么呢?

3.4 原因分析

出现以上问题的原因是,如果只重写了 equals 方法,那么默认情况下,Set 进行去重操作时,会先判断两个对象的 hashCode 是否相同,此时因为没有重写 hashCode 方法,所以会直接执行 Object 中的 hashCode 方法,而 Object 中的 hashCode 方法对比的是两个不同引用地址的对象,所以结果是 false,那么 equals 方法就不用执行了,直接返回的结果就是 false:两个对象不是相等的,于是就在 Set 集合中插入了两个相同的对象。
但是,如果在重写 equals 方法时,也重写了 hashCode 方法,那么在执行判断时会去执行重写的 hashCode 方法,此时对比的是两个对象的所有属性的 hashCode 是否相同,于是调用 hashCode 返回的结果就是 true,再去调用 equals 方法,发现两个对象确实是相等的,于是就返回 true 了,因此 Set 集合就不会存储两个一模一样的数据了,于是整个程序的执行就正常了。

总结

hashCode 和 equals 两个方法是用来协同判断两个对象是否相等的,采用这种方式的原因是可以提高程序插入和查询的速度,如果在重写 equals 时,不重写 hashCode,就会导致在某些场景下,例如将两个相等的自定义对象存储在 Set 集合时,就会出现程序执行的异常,为了保证程序的正常执行,所以就需要在重写 equals 时,也一并重写 hashCode 方法才行。