Java：HashMap与equals()、hashCode()的恩怨

最新推荐文章于 2023-09-18 15:55:55 发布

cgamaz1ng

最新推荐文章于 2023-09-18 15:55:55 发布

阅读量480

点赞数

分类专栏： Java高级特性文章标签： java equals hashmap hashcode

Java高级特性专栏收录该内容

2 篇文章 0 订阅

订阅专栏

先以一段代码开始这篇blog。

public class Name {

  private String first; //first name
  private String last;  //last name

  public String getFirst() {
    return first;
  }

  public void setFirst(String first) {
    this.first = first;
  }

  public String getLast() {
    return last;
  }

  public void setLast(String last) {
    this.last = last;
  }

  public Name(String first, String last) {
    this.first = first;
    this.last = last;
  }

  @Override
  public boolean equals(Object object) {
    Name name = (Name) object;

    return first.equals(name.getFirst()) && last.equals(name.getLast());
  }

  public static void main(String[] args) {
    Map<Name, String> map = new HashMap<Name, String>();
    map.put(new Name("mali", "sb"), "yes");

    System.out.println("is the key existed? ture or false? -> "
        + map.containsKey(new Name("mali", "sb")));
  }

}

那输出结果是什么呢？类似这样的题目总能遇到，以前不知道有什么好考的，弱智？自己动手尝试了一次，发现结果不是自己想象的那样。本篇就用来揭示HashMap的equals与hashCode中你不知道的秘密。结果如下：

is the key existed? ture or false? -> false

对的，结果就是false，我很不理解为什么这样，已经重写了equals函数了啊！当时真心不服气，就在equals函数里面打了断点，然后更让我难以置信的事情发生了，断点处没有停。非常困惑，不过还好，jdk的源码在手上，去查了HashMap中containsKey函数的源码。源码结构如下图：

从图中可以看出，真正干活的是getEntry(Object key)，重点看如下两行：

if (e.hash == hash &&
                ((k = e.key) == key || (key != null && key.equals(k))))
    return e;

从if条件上看，是一个短路与，首先要判断两个对象的hash值是否相等。如果相等才进行后续的判断。或者换一个说法，在HashMap中只有两个对象的hash值相等的前提下才会执行equals方法的逻辑。关于这一点，有两个佐证。

在stackoverflow上找到一篇关于HashMap不执行equals方法的文章，回答中有明确给出这样的答案。Java HashMap.containsKey() doesn’t call equals()

自己编程验证。

在文章开头的基础上，做了点儿改进，输出两个对象的hash值，并且在equals方法中打印一行文字。如下：

public class Name {

  private String first; //first name
  private String last;  //last name

  public String getFirst() {
    return first;
  }

  public void setFirst(String first) {
    this.first = first;
  }

  public String getLast() {
    return last;
  }

  public void setLast(String last) {
    this.last = last;
  }

  public Name(String first, String last) {
    this.first = first;
    this.last = last;
  }

  @Override
  public boolean equals(Object object) {
    System.out.println("equals is running...");
    Name name = (Name) object;

    return first.equals(name.getFirst()) && last.equals(name.getLast());
  }

  public static void main(String[] args) {
    Map<Name, String> map = new HashMap<Name, String>();
    Name n1 = new Name("mali", "sb");
    System.out.println("the hashCode of n1 : " + n1.hashCode());
    map.put(n1, "yes");
    Name n2 = new Name("mali", "sb");
    System.out.println("the hashCode of n2 : " + n2.hashCode());
    System.out.println("is the key existed? ture or false? -> "
        + map.containsKey(n2));
  }

}

结果：

the hashCode of n1 : 1690552137

the hashCode of n2 : 1901116749

is the key existed? ture or false? -> false

从执行结果可以看出1、两个对象的hash值是不相同的；2、equals方法确实也没有执行。

再次对代码进行改进，加入重写的hashCode方法，如下，看看这次的结果会是怎样。

public class Name {

  private String first; //first name
  private String last;  //last name

  public String getFirst() {
    return first;
  }

  public void setFirst(String first) {
    this.first = first;
  }

  public String getLast() {
    return last;
  }

  public void setLast(String last) {
    this.last = last;
  }

  public Name(String first, String last) {
    this.first = first;
    this.last = last;
  }

  @Override
  public boolean equals(Object object) {
    System.out.println("equals is running...");
    Name name = (Name) object;

    return first.equals(name.getFirst()) && last.equals(name.getLast());
  }

  public int hashCode() {
    System.out.println("hashCode is running..."); 
    return first.hashCode() + last.hashCode();
  }

  public static void main(String[] args) {
    Map<Name, String> map = new HashMap<Name, String>();
    Name n1 = new Name("mali", "sb");
    System.out.println("the hashCode of n1 : " + n1.hashCode());
    map.put(n1, "yes");
    Name n2 = new Name("mali", "sb");
    System.out.println("the hashCode of n2 : " + n2.hashCode());
    System.out.println("is the key existed? ture or false? -> "
        + map.containsKey(n2));
  }

}