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

  1. public native int hashCode();

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

1. hashCode方法的作用

对于包含容器类型的程序设计语言来说,基本上都会涉及到hashCode。在Java中也一样,hashCode方法的主要作用是为了配合基于散列的集合一起正常运行,这样的散列集合包括HashSet、HashMap以及HashTable。
比如在HashMap中插入元素,就是根据key的hashcode确定索引的位置,而不是把key和现有的所有key都比较(equals)来确定要插入的key是否已经存在,如果是这样的话,效率会很差,也就是hashcode是为了提高检索效率的。

由于有hash冲突的存在,所以有以下结论:  

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

    2. equals方法和hashCode方法

    在有些情况下,程序设计者在设计一个类的时候为需要重写equals方法,比如String类,但是千万要注意,在重写equals方法的同时,必须重写hashCode方法。为什么这么说呢?

下面看一个例子:

  1. package com.zheting.it.test05;
  2. import java.util.HashMap;
  3. class People {
  4. private String name;
  5. private int age;
  6. public People(String name, int age) {
  7. this.name = name;
  8. this.age = age;
  9. }
  10. public void setAge(int age) {
  11. this.age = age;
  12. }
  13. @Override
  14. public boolean equals(Object obj) {
  15. return this.name.equals(((People) obj).name) && this.age == ((People) obj).age;
  16. }
  17. }
  18. public class Main {
  19. public static void main(String[] args) {
  20. People p1 = new People("Jack", 12);
  21. System.out.println(p1.hashCode()); //hash 值
  22. HashMap<People, Integer> hashMap = new HashMap<>();
  23. hashMap.put(p1, 1);
  24. System.out.println(hashMap.get(new People("Jack", 12))); //null
  25. }
  26. }

在这里我只重写了equals方法,也就说如果两个People对象,如果它的姓名和年龄相等,则认为是同一个人。这段代码本来的意愿是想这段代码输出结果为“1”,但是事实上它输出的是“null”。为什么呢?原因就在于重写equals方法的同时忘记重写hashCode方法。虽然通过重写equals方法使得逻辑上姓名和年龄相同的两个对象被判定为相等的对象(跟String类类似),但是要知道默认情况下,hashCode方法是将对象的存储地址进行映射。那么上述代码的输出结果为“null”就不足为奇了。原因很简单,p1指向的对象和System.out.println(hashMap.get(new People(“Jack”, 12)));这句中的new People(“Jack”, 12)生成的是两个对象,它们的存储地址肯定不同。

下面是HashMap的get方法的具体实现:

  1. public V get(Object key) {
  2. Node<K,V> e;
  3. return (e = getNode(hash(key), key)) == null ? null : e.value;
  4. }
  5. final Node<K,V> getNode(int hash, Object key) {
  6. Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
  7. if ((tab = table) != null && (n = tab.length) > 0 &&
  8. (first = tab[(n - 1) & hash]) != null) {
  9. if (first.hash == hash && // always check first node
  10. ((k = first.key) == key || (key != null && key.equals(k))))
  11. return first;
  12. if ((e = first.next) != null) {
  13. if (first instanceof TreeNode)
  14. return ((TreeNode<K,V>)first).getTreeNode(hash, key);
  15. do {
  16. if (e.hash == hash &&
  17. ((k = e.key) == key || (key != null && key.equals(k))))
  18. return e;
  19. } while ((e = e.next) != null);
  20. }
  21. }
  22. return null;
  23. }

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

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

  1. package com.zheting.it.test05;
  2. import java.util.HashMap;
  3. class People {
  4. private String name;
  5. private int age;
  6. public People(String name, int age) {
  7. this.name = name;
  8. this.age = age;
  9. }
  10. public void setAge(int age) {
  11. this.age = age;
  12. }
  13. @Override
  14. public boolean equals(Object obj) {
  15. return this.name.equals(((People) obj).name) && this.age == ((People) obj).age;
  16. }
  17. @Override
  18. public int hashCode() {
  19. return name.hashCode() * 37 + age;
  20. }
  21. }
  22. public class Main {
  23. public static void main(String[] args) {
  24. People p1 = new People("Jack", 12);
  25. System.out.println(p1.hashCode()); //hash 值
  26. HashMap<People, Integer> hashMap = new HashMap<>();
  27. hashMap.put(p1, 1);
  28. System.out.println(hashMap.get(new People("Jack", 12))); //1
  29. }
  30. }

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

下面这段话摘自Effective Java一书:

  • 在程序执行期间,只要equals方法的比较操作用到的信息没有被修改,那么对这同一个对象调用多次,hashCode方法必须始终如一地返回同一个整数。
  • 如果两个对象根据equals方法比较是相等的,那么调用两个对象的hashCode方法必须返回相同的整数结果。
  • 如果两个对象根据equals方法比较是不等的,则hashCode方法不一定得返回不同的整数。

   对于第二条和第三条很好理解,但是第一条,很多时候就会忽略。在《Java编程思想》一书中的P495页也有同第一条类似的一段话:   “设计hashCode()时最重要的因素就是:无论何时,对同一个对象调用hashCode()都应该产生同样的值。如果在讲一个对象用put()添加进HashMap时产生一个hashCdoe值,而用get()取出时却产生了另一个hashCode值,那么就无法获取该对象了。所以如果你的hashCode方法依赖于对象中易变的数据,用户就要当心了,因为此数据发生变化时,hashCode()方法就会生成一个不同的散列码”。

下面举个例子:

  1. package com.zheting.it.test05;
  2. import java.util.HashMap;
  3. class People {
  4. private String name;
  5. private int age;
  6. public People(String name, int age) {
  7. this.name = name;
  8. this.age = age;
  9. }
  10. public void setAge(int age) {
  11. this.age = age;
  12. }
  13. @Override
  14. public boolean equals(Object obj) {
  15. return this.name.equals(((People) obj).name) && this.age == ((People) obj).age;
  16. }
  17. @Override
  18. public int hashCode() {
  19. return name.hashCode() * 37 + age;
  20. }
  21. }
  22. public class Main {
  23. public static void main(String[] args) {
  24. People p1 = new People("Jack", 12);
  25. HashMap<People, Integer> hashMap = new HashMap<>();
  26. hashMap.put(p1, 1);
  27. //影响了hashcode的计算
  28. p1.setAge(13);
  29. System.out.println(hashMap.get(p1)); //null
  30. }
  31. }

这段代码输出的结果为“null”,想必其中的原因大家应该都清楚了。
因此,在设计hashCode方法和equals方法的时候,如果对象中的数据易变,则最好在equals方法和hashCode方法中不要依赖于该字段。