JAVA面试题分享八十一：如何实现 hashcode/equals？

一、前言

Java的基类Object提供了一些方法，其中equals()方法用于判断两个对象是否相等，hashCode()方法用于计算对象的哈希码。equals()和hashCode()都不是final方法，都可以被重写(overwrite)。

二、equal()方法

 Object类中equals()方法实现如下：

1 2 3

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

通过该实现可以看出，Object类的实现采用了区分度最高的算法，即只要两个对象不是同一个对象，那么equals()一定返回false。

虽然我们在定义类时，可以重写equals()方法，但是有一些注意事项；JDK中说明了实现equals()方法应该遵守的约定：

（1）自反性：x.equals(x)必须返回true。

（2）对称性：x.equals(y)与y.equals(x)的返回值必须相等。

（3）传递性：x.equals(y)为true，y.equals(z)也为true，那么x.equals(z)必须为true。

（4）一致性：如果对象x和y在equals()中使用的信息都没有改变，那么x.equals(y)值始终不变。

（5）非null：x不是null，y为null，则x.equals(y)必须为false。

三、hashCode()方法

1、Object的hashCode()

Object类中hashCode()方法的声明如下：

1	public native int hashCode();

可以看出，hashCode()是一个native方法，而且返回值类型是整形；实际上，该native方法将对象在内存中的地址作为哈希码返回，可以保证不同对象的返回值不同。

与equals()方法类似，hashCode()方法可以被重写。JDK中对hashCode()方法的作用，以及实现时的注意事项做了说明：

（1）hashCode()在哈希表中起作用，如java.util.HashMap。

（2）如果对象在equals()中使用的信息都没有改变，那么hashCode()值始终不变。

（3）如果两个对象使用equals()方法判断为相等，则hashCode()方法也应该相等。

（4）如果两个对象使用equals()方法判断为不相等，则不要求hashCode()也必须不相等；但是开发人员应该认识到，不相等的对象产生不相同的hashCode可以提高哈希表的性能。

2、hashCode()的作用

总的来说，hashCode()在哈希表中起作用，如HashSet、HashMap等。

当我们向哈希表(如HashSet、HashMap等)中添加对象object时，首先调用hashCode()方法计算object的哈希码，通过哈希码可以直接定位object在哈希表中的位置(一般是哈希码对哈希表大小取余)。如果该位置没有对象，可以直接将object插入该位置；如果该位置有对象(可能有多个，通过链表实现)，则调用equals()方法比较这些对象与object是否相等，如果相等，则不需要保存object；如果不相等，则将该对象加入到链表中。

这也就解释了为什么equals()相等，则hashCode()必须相等。如果两个对象equals()相等，则它们在哈希表(如HashSet、HashMap等)中只应该出现一次；如果hashCode()不相等，那么它们会被散列到哈希表的不同位置，哈希表中出现了不止一次。

实际上，在JVM中，加载的对象在内存中包括三部分：对象头、实例数据、填充。其中，对象头包括指向对象所属类型的指针和MarkWord，而MarkWord中除了包含对象的GC分代年龄信息、加锁状态信息外，还包括了对象的hashcode；对象实例数据是对象真正存储的有效信息；填充部分仅起到占位符的作用, 原因是HotSpot要求对象起始地址必须是8字节的整数倍。

四、String中equals()和hashCode()的实现

String类中相关实现代码如下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

private final char value[]; private int hash; // Default to 0 public boolean equals(Object anObject) {     if (this == anObject) {         return true;     }     if (anObject instanceof String) {         String anotherString = (String)anObject;         int n = value.length;         if (n == anotherString.value.length) {             char v1[] = value;             char v2[] = anotherString.value;             int i = 0;             while (n-- != 0) {                 if (v1[i] != v2[i])                     return false;                 i++;             }             return true;         }     }     return false; } public int hashCode() {     int h = hash;     if (h == 0 && value.length > 0) {         char val[] = value;         for (int i = 0; i < value.length; i++) {             h = 31 * h + val[i];         }         hash = h;     }     return h; }

通过代码可以看出以下几点：

1、String的数据是final的，即一个String对象一旦创建，便不能修改；形如String s = "hello"; s = "world";的语句，当s = "world"执行时，并不是字符串对象的值变为了"world"，而是新建了一个String对象，s引用指向了新对象。

2、String类将hashCode()的结果缓存为hash值，提高性能。

3、String对象equals()相等的条件是二者同为String对象，长度相同，且字符串值完全相同；不要求二者是同一个对象。

4、String的hashCode()计算公式为：s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]

关于hashCode()计算过程中，为什么使用了数字31，主要有以下原因：

1、使用质数计算哈希码，由于质数的特性，它与其他数字相乘之后，计算结果唯一的概率更大，哈希冲突的概率更小。

2、使用的质数越大，哈希冲突的概率越小，但是计算的速度也越慢；31是哈希冲突和性能的折中，实际上是实验观测的结果。

3、JVM会自动对31进行优化：31 * i == (i << 5) - i

五、如何重写hashCode()

本节先介绍重写hashCode()方法应该遵守的原则，再介绍通用的hashCode()重写方法。

1、重写hashcode()的原则

通过前面的描述我们知道，重写hashCode需要遵守以下原则：

（1）如果重写了equals()方法，检查条件“两个对象使用equals()方法判断为相等，则hashCode()方法也应该相等”是否成立，如果不成立，则重写hashCode ()方法。

（2）hashCode()方法不能太过简单，否则哈希冲突过多。

（3）hashCode()方法不能太过复杂，否则计算复杂度过高，影响性能。

2、hashCode()重写方法

《Effective Java》中提出了一种简单通用的hashCode算法
A、初始化一个整形变量，为此变量赋予一个非零的常数值，比如int result = 17;
B、选取equals方法中用于比较的所有域（之所以只选择equals()中使用的域，是为了保证上述原则的第1条），然后针对每个域的属性进行计算：
(1) 如果是boolean值，则计算f ? 1:0
(2) 如果是byte\char\short\int,则计算(int)f
(3) 如果是long值，则计算(int)(f ^ (f >>> 32))
(4) 如果是float值，则计算Float.floatToIntBits(f)
(5) 如果是double值，则计算Double.doubleToLongBits(f)，然后返回的结果是long,再用规则(3)去处理long,得到int
(6) 如果是对象应用，如果equals方法中采取递归调用的比较方式，那么hashCode中同样采取递归调用hashCode的方式。否则需要为这个域计算一个范式，比如当这个域的值为null的时候，那么hashCode 值为0
(7) 如果是数组，那么需要为每个元素当做单独的域来处理。java.util.Arrays.hashCode方法包含了8种基本类型数组和引用数组的hashCode计算，算法同上。
C、最后，把每个域的散列码合并到对象的哈希码中。

六、二者的问题

平时在开发中，相信你多多少少都使用过HashMap，而当你用自定义对象作为key时，很多人会告诉你：你必须要同时实现自定义对象的hashCode、equals方法，否者可能会出问题，于是你就实现了...

可是为什么呢？比如这里有自定义对象Person，构造如下：

1 2 3 4 5

public class Person {     private String name;     private int age;     private float height; }

欲将Person作为HashMap的key，放入哈希表中存储信息。我们来探讨一下，为什么要同时实现hashCode、equals方法吧~

1 2 3 4 5

Person p1 = new Person("ciusyan", 21, 1.8f); Person p2 = new Person("ciusyan", 21, 1.8f); Map<Person, String> map = new HashMap<>(); map.put(p1, "Ciusyan"); map.put(p2, "Zhiyan");

首先要明确：

• hashCode方法用于计算出对象的哈希值
• equlas方法用于比较两个对象是否相等

1、hashCode、equals方法都未实现

倘若你了解哈希表的基本构造，可以画出一个草图：

我们并没有实现hashCode、equals方法，为什么还能放入哈希表中呢？

• 因为JDK会有默认实现

在默认的实现中：

• 利用hashCode方法计算出的哈希值是不同的
• 利用equals方法比较，p1和p2不是一个对象
• 所以放入哈希表中的大致结构如上图所示：
  • 可能会被放入两个桶（不同哈希值计算出的索引不一样）
  • 也可能会被放入一个桶（不同哈希值也可能会计算出相同的索引），又因为是不同对象，所以会被串起来

2、只实现hashCode方法

如果我们实现了hashCode方法，会有什么不同呢？

1 2 3 4 5 6 7

@Override public int hashCode() {     int hash = Integer.hashCode(age);     hash = hash * 31 + Float.hashCode(height);     hash = hash * 31 + (name == null ? 0 : name.hashCode());     return hash; }

如上实现，既满足了尽量用的所有信息，也使计算的值尽量唯一了

如果是现在，我们再来画一幅草图：

现在只实现了hashCode方法：

• 利用hashCode方法计算出的哈希值是相同的
• equals方法是默认实现，p1和p2不是一个对象
• 所以放入哈希表中的大致结构如上图所示：
  • 只会被放入一个桶（相同的哈希值计算出的索引相同），又因为是不同对象，所以会被串起来

3、只实现equals方法

如果我们实现了equals方法，会有什么不同呢？

1 2 3 4 5 6 7

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

如上实现，如果两个对象的age、name、height都相等，那么可以认为是同一个对象

如果是现在：

现在只实现了equals方法：

• hashCode方法是默认实现，计算出的哈希值是不同的
• 利用equals方法比较，p1和p2是同一个对象
• 所以放入哈希表中的大致结构如上图所示：
  • 可能会被放入两个桶（计算出的索引不一样）
  • 也可能会被放入一个桶（不同哈希值也可能会计算出相同的索引），又因为是同一对象，所以p2的键和值会覆盖掉p1的

4、hashCode、equals方法都实现

倘若我们用上面的实现方式，将hashCode和equals方法都实现了

来看看最终的结构：

现在hashCode、equals方法都实现了：

• 利用hashCode方法计算出的哈希值是相同的
• 利用equals方法比较，p1和p2是同一个对象

所以放入哈希表中的大致结构如上图所示：

• 只会被放入一个桶中（相同的哈希值计算出的索引相同），又因为是同一对象，所以p2的键和值会覆盖掉p1

 七、总结

如果你想要用自定义对象作为HashMap的key，为什么hashCode、equals方法都要实现？

• 先利用hashCode方法计算出哈希值：
  • 如果哈希值相同，在哈希表中计算出的索引肯定相同，会被放入一个桶中。这时候用equals方法查看是否是相同的对象。
    • 如果是，用新的键和值覆盖掉旧的；
    • 如果不是就用链地址法将对象串起来
  • 如果哈希值不同，在哈希表中计算的索引也可能相同，也就是可能会被放入一个桶，也可能会被放入两个桶。
    • 如果被放入一个桶中，同上一样，检查equlas方法；
    • 如果放入两个桶中，则不需要查看是否equals

一般的开发需求会是第四种，想要用p1和p2作为key存储数据，会认为它们是同一个对象，它们是同一个key，也就只会存储一份数据。所以如果不同时实现hashCode、equals方法，会有图中的种种问题。

以上就是Java开发HashMap key必须实现hashCode equals方法原理的详细内容。