【Java】hashCode()

Posted by 西维蜀黍 on 2019-03-18, Last Modified on 2021-09-21

背景

哈希表(Hash Table)这个数据结构想必大多数人都不陌生,而且在很多地方都会利用到哈希表(Hash Table)来提高查找效率。在Java的Object类中有一个方法:

public native int hashCode();

根据这个方法的声明可知,该方法返回一个int类型的数值,并且是本地方法,因此在Object类中并没有给出具体的实现。

为何Object类需要这样一个方法?它有什么作用呢?今天我们就来具体探讨一下hashCode方法。

hashCode() 的作用

对于包含容器类型的程序设计语言来说,基本上都会涉及到hashCode。

在Java中也一样,hashCode()方法的主要作用,是为了配合基于散列的集合一起正常运行,这样的散列集合包括HashSet、HashMap以及HashTable。

为什么这么说呢?考虑一种情况,当向散列集合中插入一个对象时,如何判别在集合中是否已经存在该对象了?

注意:散列集合中不允许重复的元素存在

也许大多数人都会想,到调用equals()方法来逐个进行比较。

这个方法确实可行。但是如果集合中已经存在一万条数据或者更多的数据,如果采用equals()方法去逐一比较,效率必然是一个问题。


此时,hashCode() 方法的作用就体现出来了。

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

所以,这里存在一个冲突解决的问题,这样一来实际调用equals方法的次数就大大降低了,说通俗一点:Java中的hashCode方法就是根据一定的规则将与对象相关的信息(比如对象的存储地址,对象的字段等)映射成一个数值,这个数值称作为散列值。

下面这段代码是java.util.HashMap的中put方法的具体实现:

public V put(K key, V value) {
        if (key == null)
            return putForNullKey(value);
        int hash = hash(key.hashCode());
        int i = indexFor(hash, table.length);
        for (Entry<K,V> e = table[i]; e != null; e = e.next) {
            Object k;
            if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue;
            }
        }
 
        modCount++;
        addEntry(hash, key, value, i);
        return null;
}

put方法是用来向HashMap中添加新的元素。

从put方法的具体实现可知,会先调用hashCode方法得到该元素的hashCode值,然后查看table中是否存在该hashCode值,如果存在则调用equals方法重新确定是否存在该元素,如果存在,则更新value值,否则将新的元素添加到HashMap中。

从这里可以看出,hashCode方法的存在是为了减少equals方法的调用次数,从而提高程序效率。

根据hashcode值判断对象相等

有人可能会问,可以直接根据hashcode值判断两个对象是否相等吗?

肯定是不可以的。

因为不同的对象可能会生成相同的hashcode值,这时发生了哈希碰撞(hash collision)

虽然不能根据hashcode值判断两个对象是否相等,但是可以直接根据hashcode值判断两个对象不等

如果两个对象的hashcode值不等,则必定是两个不同的对象。如果要判断两个对象是否真正相等,必须通过equals方法。


也就是说,对于两个对象:

  • 如果调用equals方法得到的结果为true,则两个对象的hashcode值必定相等;
  • 如果equals方法得到的结果为false,则两个对象的hashcode值不一定不同;
  • 如果两个对象的hashcode值不等,则equals方法得到的结果必定为false;
  • 如果两个对象的hashcode值相等,则equals方法得到的结果未知。

equals方法和hashCode方法

在有些情况下,程序设计者在设计一个类的时候为需要重写equals方法,比如String类。

但是千万要注意,在重写equals方法的同时,必须重写hashCode方法。

为什么这么说呢?

下面看一个例子:

class People {
    private String name;
    private int age;

    public People(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public boolean equals(Object obj) {
        // TODO Auto-generated method stub
        return this.name.equals(((People) obj).name) && this.age == ((People) obj).age;
    }
}

public class Test {

    public static void main(String[] args) {

        People p1 = new People("Jack", 12);
        System.out.println(p1.hashCode());

        HashMap<People, Integer> hashMap = new HashMap<People, Integer>();
        hashMap.put(p1, 1);

      	People p2 = new People("Jack", 12);
        System.out.println(hashMap.get(p2));
    }
}

分析

在这里我只重写了equals方法,也就说如果两个People对象,如果它的姓名和年龄相等,则认为是同一个人。

这段代码本来的意愿是想这段代码输出结果为“1”,但是事实上它输出的是“null”。

为什么呢?原因就在于重写equals方法的同时忘记重写hashCode方法。

虽然通过重写equals方法使得逻辑上姓名和年龄相同的两个对象被判定为相等的对象(跟String类类似),但是要知道默认情况下,hashCode方法是将对象的存储地址进行映射。那么上述代码的输出结果为“null”就不足为奇了。原因很简单,p1指向的对象和p2指向的对象,它们的存储地址肯定不同。

所以在hashmap进行get操作时,因为得到的hashcdoe值不同(注意,上述代码也许在某些情况下会得到相同的hashcode值,不过这种概率比较小,因为虽然两个对象的存储地址不同也有可能得到相同的hashcode值),所以导致在get方法中for循环不会执行,直接返回null。

因此如果想上述代码输出结果为“1”,很简单,只需要重写hashCode方法,让equals方法和hashCode方法始终在逻辑上保持一致性。

比如,在 People 类中,这样增加对hashCode() 方法的重写。

class People{
		...
		
    @Override
    public int hashCode() {
        // TODO Auto-generated method stub
        return name.hashCode()*37+age;
    }
}

这样一来的话,输出结果就为“1”了。

覆写(overwrite)equals()时的准则

  • 自反性(reflexive)。对于任意不为null的引用值x,x.equals(x)一定是true
  • 对称性(symmetric)。对于任意不为null的引用值xy,当且仅当x.equals(y)true时,y.equals(x)也是true
  • 传递性(transitive)。对于任意不为null的引用值xyz,如果x.equals(y)true,同时y.equals(z)true,那么x.equals(z)一定是true
  • 一致性(consistent)。对于任意不为null的引用值xy,如果用于equals比较的对象信息没有被修改的话,多次调用时x.equals(y)要么一致地返回true要么一致地返回false
  • 对于任意不为null的引用值xx.equals(null)返回false

对于Object类来说,equals()方法在对象上实现的是差别可能性最大的等价关系,即,对于任意非null的引用值xy,当且仅当xy引用的是同一个对象,该方法才会返回true

需要注意的是当equals()方法被override时,hashCode()也要被override。按照一般hashCode()方法的实现来说,相等的对象,它们的hash code一定相等。

Reference