为什么重写equals方法时一定要重写hashCode方法

发布时间 2023-10-29 20:33:06作者: sunny123456

为什么重写equals方法时一定要重写hashCode方法

在每个类中,在重写equals方法的时侯,一定要重写hashcode方法。

根据Object规范,规范约定:

  1. 如果两个对象通过equals方法比较是相等的,那么它们的hashCode方法结果值也是相等的。
  2. 如果两个对象通过equals方法比较是不相等的,那么不要求它们的hashCode方法结果值是相等的。
  3. 当在一个应用程序执行过程中, 如果equals方法比较中没有修改任何信息,那么在同一个对象上重复调用hashCode方法时,它必须始终返回相同的值。但如果从一个应用程序到了另一个应用程序,两个应用程序汇中调用hashCode方法的返回值可以是不一致的。

Object类中的默认的equals和hashCode方法:

  • equals:比较的是对象的内存地址是否相同(相当于==操作符);
  • hashCode:hashCode方法的返回值符合上述规范。

因此,当只重写equals方法,不重写hashCode时,违反规定:equals相等的对象必须具有相等的哈希码(因为hashCode的返回值还是按照Object类的规范:同一对象的hashCode值相同)。

如果不这样做,你的类违反了hashCode的通用约定,对于HashSet, HashMap, HashTable等基于hash值的类就会出现问题。

以HashMap为例,当集合要添加新的对象时,先调用这个对象的hashCode方法,得到对应的hashcode值,实际上在HashMap的具体实现中会用一个table保存已经存进去的对象的hashcode值,如果table中没有该hashcode值,它就可以直接存进去,不用再进行任何比较了;如果存在该hashcode值,就调用它的equals方法与新元素进行比较,相同的话就不存了,不相同就散列其它的地址。
这样解决了向含有大量数据的集合中添加元素时,大量频繁的操作equals方法的问题。

下面举个例子说明:
创建一个Point类,有两个成员变量x和y,并重写了equals方法。

public class Point {
	private final int x, y;
public Point(int x, int y) {
    this.x = x;
    this.y = y;
}
@Override
public boolean equals(Object obj) {
    if (this == obj) return true;
    if (!(obj instanceof Point)) return false;
    Point point = (Point) obj;
    return x == point.x && y == point.y;
}
public static void main(String[] args) {
	Point p1 = new Point(1, 2);
	Point p2 = new Point(1, 2);
	System.out.println(p1.equals(p2));// true
	
	Map<Point, String> map = new HashMap<>();
	map.put(p1, "p1");
	System.out.println(map.get(p2)); // null
}

}

你可能觉得 map.get(p2) 应该返回字符串 p1, 但是却返回null, 这是因为Point类并没有重写hashCode方法,导致两个相等的实例p1和p2返回了不同的哈希码,违反了hashCode的约定,put方法把实例p1放到了一个哈希桶(hash bucket)中,但因为p2的哈希码不等于p1的哈希码,所以get方法会从其它哈希桶中去查找。

解决这个方法很简单,只需要重写Point类的hashCode方法。

	@Override
	public int hashCode() {
	    int result = Integer.hashCode(x);
	    result = 31 * result + Integer.hashCode(y);
	    return result;
	}
	public static void main(String[] args) {
		Point p1 = new Point(1, 2);
		Point p2 = new Point(1, 2);
		System.out.println(p1.equals(p2));// true
	Map<Point, String> map = new HashMap<>();
	map.put(p1, "p1");
	System.out.println(map.get(p2)); // p1
}

这次你会发现map.get(p2) 返回的就是字符串p1了, 因为hashCode这个方法会返回一个简单的确定性计算的结果,它的唯一的输入是 Point实例中的两个重要的属性x和y,所以显然相等的 Point实例具有相同的哈希码。

此外Objects 类有一个静态方法,它接受任意数量的对象并为它们返回一个哈希码。这个名为 hash 的方法可以 让你编写一行 hashCode 方法,其质量与根据这个项目中的上面编写的方法相当。

	@Override
	public int hashCode() {
		return Objects.hash(x, y);
	}

注意事项

  1. 当你写完 hashCode 方法后,请一定问一下自己是否满足相等的实例有相同的哈希码这一条件。
  2. hashCode中涉及到的属性应与equals中保持一致,不要试图从哈希码计算中排除重要的属性来提高性能。

总之,每次重写 equals 方法时都必须重写 hashCode 方法,否则程序将无法正常运行。你的 hashCode 方 法必须遵从 Object 类指定的常规约定,并且必须执行合理的工作,将不相等的哈希码分配给不相等的实例

原文链接:https://juejin.im/post/5e0226bb6fb9a0165936f44b