为何修改equals方法时还要重写hashcode方法的原因分析

为何修改equals方法时还要重写hashcode方法

虽然在实际开发中，我们已经使用到散列集合(如HashMap),或也单独学过散列（Hash）。

但是也会有很多人像我一样，看到有些时候别人写的pojo中有对对象内hashcode函数做一个重写，这就让我重新思考为什么要这么做? 下面就让我和你一起去探索一下吧!

Hash是什么?

Hash就是上文说到的散列，是把任意长度的输入(又叫做预映射pre-image）通过散列算法变换成固定长度的输出，该输出就是散列值。它的理论时间复杂度是可以达到O(1),但一般来说，这个散列函数是极难设计的。说到散列值，就是通过散列函数转化出来的：

如果两个散列值是不一样y(x1)!=y(x2)，那么这两个散列值的原始输入一定是不一样的。

如果两个散列值出现了相等，那么并不代码这两个散列值的原始输入一定是一样的，可能是属于哈希碰撞(不同关键字经过散列变换结果是一样的的现象);

对于哈希函数有哪些我也不再介绍，想了解可以直接去查散列函数的。

Hashcode作用

很多情况下我们也许都会用到hash表来做提高查询效率，那么这个hash表是如何提高效率的?其实就是基于上面所说的散列函数，根据设计的散列函数，我们对于每一个关键字都有唯一的散列值，那么就能够直接根据这个散列值直接就能找到元素在集合中的位置，从而获得其值，这对于集合的一个个对象进行比较来说，是提高了很多的。

通过以上操作，我们很容易就能理解为啥散列技术在查询的复杂度是能达到O(1).

但是一般来说java都会内置了hashcode的实现,那为什么在写对象的时候，只要对equals进行重写，都推荐对hashcode进行重写呢?

看HashCode的常规协定：

在 Java 应用程序执行期间，在同一对象上多次调用 hashCode 方法时，必须一致地返回相同的整数，前提是对象上 equals 比较中所用的信息没有被修改。从某一应用程序的一次执行到同一应用程序的另一次执行，该整数无需保持一致。

如果根据 equals(Object) 方法，两个对象是相等的，那么在两个对象中的每个对象上调用 hashCode 方法都必须生成相同的整数结果。

以下情况不 是必需的：

如果根据 equals(java.lang.Object) 方法，两个对象不相等，那么在两个对象中的任一对象上调用 hashCode 方法必定会生成不同的整数结果。但是，程序员应该知道，为不相等的对象生成不同整数结果可以提高哈希表的性能。

实际上，由 Object 类定义的 hashCode 方法确实会针对不同的对象返回不同的整数。（这一般是通过将该对象的内部地址转换成一个整数来实现的，但是 JavaTM 编程语言不需要这种实现技巧。）

当equals方法被重写时，通常有必要重写 hashCode 方法，以维护 hashCode 方法的常规协定，该协定声明相等对象必须具有相等的哈希码。

根据以上知道，java内部的一个实现是以地址来的，如果对equals进行重写了，也就是对象你判断相等时不再以java提供的方法，那么将来在使用hash表的时候，就会存在equals是相等的，但hashcode却是不相等的!

所以建议：在修改equals的方法时，记得修改hashcode方法!!!

下面做个小例子

/**
 * @author: Kilig
 * @date: 2020/6/22 21:18
 * @description:
 */
public class User {
    private int id;
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof User)) return false;
        User user = (User) o;
        return getId() == user.getId();
    }
//    @Override
//    public int hashCode() {
//        return Objects.hash(getId());
//    }
}

public static void main(String[] args) {
        User a=new User();
        User b=new User();
        a.setId(1);
        b.setId(1);
        System.out.println(a.equals(b));
        System.out.println(a.hashCode() == b.hashCode());
    }

运行结果

尝试将其放到set集合时

看到这结果显然不是我们想要的，因为我两个对象相等，其```hashcode也应相等,然而结果却是在不可重复的set集合中存了两个对象，所以我们做一个改进，对User进行重写hashcode``方法。

  @Override
    public int hashCode() {
        return Objects.hash(getId()); //使用默认的hash函数处理关键字，这里是ID，我们认为Id相等的用户其就是同一个用户
    }

然后看看set的结果：

的确符合我们预期结果。

基于以上的学习，我们也基本了解为啥在修改equals方法时也要对hashcode进行修改。

Java重写equals()方法的步骤

Java语言规范要求equals方法具有下面的特性：

1. 自反性：对于任何非空引用x，x.equals(x)应该返回true
2. 对称性：对于任何引用x和y，当且仅当y.equals(x)返回true，x.equals(y)也应该返回true
3. 传递性：对于任何引用x和y和z，如果x.equal(y)返回true，y.equals(z)返回true，x.equals(z)也应该返回true
4. 一致性：如果x和y引用的对象没有发生变化，反复调用x.equals(y)应该返回同样的结果
5. 对于任意非空引用x，x.equals(null)应该返回false

重写equals()方法的步骤：

显式参数命名为otherObject，稍后需要将它转换成另一个叫做other的变量

检测this与otherObject是否引用同一个对象

if (this == otherObject)
    return true;

检测otherObject是否为null，是则返回false

if (this == null)
    return false;

比较this与otherObject是否属于同一个类。如果equals的语义在每个子类中有所改变，就使用getClass检测

if (getClass() != otherObject.getClass())
    return false;

如果所有的子类都拥有统一的语义，就使用instanceof检测

if (!(otherObject instanceof ClassName))
    return false;

将otherObject转换成相应的类类型变量

ClassName other = (ClassName) otherObject

将other需要比较的域成员都进行比较，只要有一个不同都返回false

需要注意的是，如果重新定义了equals()方法，就必须重新定义hashCode()方法，以便用户可以将对象插入到散列表中。

equals()方法与hashCode()方法的定义必须保持一致，即如果equals()返回true，则2个对象的hashCode()必须具有相同的值。

重写equals()方法中有提到，我们需要将要比较的域成员都进行比较，那么我们在重写hashCode()方法时可以将这些域成员的散列值组合起来，这样就能保证它与equals()方法具有一致性了。

假设需被比较的域成员为field_1、field_2与field_3，那么我们可以编写一下hashCode()方法：

public int hashCode() {
    return Objects.hash(field_1, field_2, field_3);
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。