通用方法-覆盖 equals 方法时必须覆盖 hashCode 方法

392 阅读4分钟

这是我参与8月更文挑战的第25天,活动详情查看:8月更文挑战

前言

覆盖了equals方法,就必须同时覆盖hashCode,否则HashMap,HashSet,Hashtable 这些集合就没有办法正常使用了。比如我们使用lombok的时候,equals和hashCode就是绑定在一起的,不能单独写一个的。


@Data

@EqualsAndHashCode

public class User {

    private Integer id;

    private String userName;

Object.hashCode规范

在Object类的hashCode()方法前面的注释中,我们可以看到对应的规范

image.png

  • 在应用程序的执行期间,对这同一个对象调用多次,hashCode方法始终如一地返回同一个整数,说明对象的equals方法的比较操作所用到的信息没有被修改。
  • 如果两个对象根据equals(Object)方法比较是相等的。那么调用这两个对象中任意一个对象的hashCode方法都必须产生同样的整数结果。
  • 如果两个对象根据equals(Object)方法比较是不相等的,那么调用这两个对象中的任意一个对象的hashCode方法,则不一定要产生不同的整数结果。然而需要注意到如果不相同的对象产生不同的整数结果,对hashTable之类的效率有提升。

hashCode的写法

一个好的散列函数通常倾向于“为不相等的对象产生不相等的hashCode” ,这样能提升hashTable的效率。

我们首先来看看用@EqualsAndHashCode注解的类


@Data

@EqualsAndHashCode

public class User {

    private Integer id;

    private String userName;

    private boolean isAdmin;

    private long userCode;

    private float accountMoney;

    private double leanMoney;

    public User() {

    }
    public User(Integer id, String userName) {
        this.id = id;
        this.userName = userName;
    }
}

对应生成的hashCode

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        int result = result * 59 + (this.isAdmin() ? 79 : 97);
        long $userCode = this.getUserCode();
        result = result * 59 + (int)($userCode >>> 32 ^ $userCode);
        result = result * 59 + Float.floatToIntBits(this.getAccountMoney());
        long $leanMoney = Double.doubleToLongBits(this.getLeanMoney());
        result = result * 59 + (int)($leanMoney >>> 32 ^ $leanMoney);
        Object $id = this.getId();
        result = result * 59 + ($id == null ? 43 : $id.hashCode());
        Object $userName = this.getUserName();
        result = result * 59 + ($userName == null ? 43 : $userName.hashCode());
        return result;
    }

编写好的hashCode也如下这种简单的方式:

  1. 把某个非零的常数值,比如说上面就将1保存到了名为result的int类型的变量中。
  2. 对于对象中的每个关键域f(指equals方法中涉及的每个域),完成以下步骤:

a. 为该域计算int类型的散列码c:

    1. 如果该域是boolean类型,则计算(f ? 1 : 0),当然上面对boolean是用了(this.isAdmin() ? 79 : 97)
    1. 如果该域是byte、char、short或者int类型,则计算(int)f
    1. 如果该域是long类型,则计算(int)(f^(f>>>32)),比如对上面的userCode,(int)(userCode >>> 32 ^ userCode)。
    1. 如果该域是float类型,则计算Float.floatToIntBits(f),比如上面的accountMoney。
    1. 如果该域是double类型,则计算Double.doubleToLongBits(f),然后按照步 骤2.a.3,为得到的long类型值计算散列值,上面的leanMoney就是如此。
    1. 如果该域是一个对象引用,并且该类的equals方法通过递归地调用equals方式来比较这个域,则同样为这个域递归地调用hashCode。如果需要更复杂的比较,则为这个域计算一个范式,然后针对这个范式调用hashCode。如果这个域的值为null,则返回0(不绝对,但通常是0)。
    1. 如果该域是一个数组,则要把每个元素当做单独的域来处理。也就是说,递归地应用上面的规则,对每个重要的元素计算一个散列码。然后再用2中的方法组合起来。如果数组中的每个元素都很重要,则可以用Arrays.hashCode方法。

b. 按照下面的公式,把步骤2.a计算得到的散列码c合并到result中。

result = 59 * result + c;

  1. 返回result。

总结

别手写了,太累,还是用@EqualsAndHashCode吧

equals方法和hashCode方法一定要一期覆盖,否则会造成基于散列值的集合使用出现问题,如HashMap或者HashSet等;

对象中所有的字段最好都一起使用进来,排除一部分不太可取。 虽然这样可能使计算的速度得到提升,但是效果并不见得会好,可以会导致散列表慢到根本无法使用,因为大量的实例会映射到极少的散列码上,这时候hashMap性能会下降的非常厉害。