HashCode和equals方法总结

HashCode和equals方法总结

对八股文要熟练掌握，这里给出相关的分类记录。本文讲述的是：hashcode和equals方法的区别联系。

1. hashcode是用于确认对象在数组中的位置的，equals是判断两个对象的内容是否相等，地址不同也无事。
2. 如果一个类需要在散列表(hashset、hashmap、hashtable等)中存储，那么覆写equals方法时，就需要覆写hashcode方法，因为在散列表中hashCode() 的作用是获取对象的散列码，进而确定该对象在散列表中的位置。
3. 如果一个类不需要在散列表中存储那么就不需要覆写hashcode方法。

一、equals()的作用

• equals()的作用是用来判断两个对象是否相等。通过判断两个对象的地址是否相同、是否是同一个对象；Java中的源码如下：

  public boolean equals(Object obj) {
      return (this == obj);
  }

  • 上述代码中可见：所有的类都可以通过equals()去比较两个对象是否相等；使用默认的“equals()”方法，等价于“==”方法。

  • 因此，我们通常会重写equals()方法：若两个对象的内容相等，则equals()方法返回true；否则，返回fasle。

  • 为判断类是否覆盖equals()方法：

    1. 若某个类没有覆盖equals()方法，当它的通过equals()比较两个对象时，实际上是比较两个对象是不是同一个对象。这时，等价于通过“==”去比较这两个对象。
    2. 覆盖类的equals()方法，来让equals()通过其它方式比较两个对象是否相等。通常的做法是：若两个对象的内容相等，则equals()方法返回true；否则，返回fasle。

  ​

1. 1 没有覆盖equals()方法

• 具体代码（EqualsTest1.java）：

  public class EqualsTest1 {
      public static void main(String[] args) {
          // 新建两个相同的Person对象
          // 再利用equals比较两者是否是相同的
          Person p1=new Person("eee",100);
          Person p2=new Person("eee",100);
          System.out.print(p1.equals(p2));
  
      }
      // 定义Person类
      private static class Person{
          int age;
          String name;
  
          public Person() {
          }
          
          public Person(String name,int age) {
              this.age = age;
              this.name = name;
          }
  
          public String toString() {
              return "Person{age = " + age + ", name = " + name + "}";
          }
      }
  }

• 运行结果：

  

• 结果分析：

  • 我们通过 p1.equals(p2) 来“比较p1和p2是否相等时”。实际上，调用的Object.java的equals()方法，即调用的 (p1==p2) 。它是比较“p1和p2是否是同一个对象”。 而由 p1 和 p2 的定义可知，它们虽然内容相同；但它们是两个不同的对象！因此，返回结果是false。

  ​

1. 2 覆盖equals的方法情况

• 将上述的代码进行修改：

  import java.util.*;
  import java.lang.Comparable;
  
  public class EqualsTest2{
  
      public static void main(String[] args) {
          // 新建2个相同内容的Person对象，
          // 再用equals比较它们是否相等
          Person p1 = new Person("eee", 100);
          Person p2 = new Person("eee", 100);
          System.out.printf("%s\n", p1.equals(p2));
      }
  
      /**
       * @desc Person类。
       */
      private static class Person {
          int age;
          String name;
  
          public Person(String name, int age) {
              this.name = name;
              this.age = age;
          }
  
          public String toString() {
              return name + " - " +age;
          }
  
          /**
           * @desc 覆盖equals方法
           */
          @Override
          public boolean equals(Object obj){
              if(obj == null){
                  return false;
              }
  
              //如果是同一个对象返回true，反之返回false
              if(this == obj){
                  return true;
              }
  
              //判断是否类型相同
              if(this.getClass() != obj.getClass()){
                  return false;
              }
  
              Person person = (Person)obj;
              return name.equals(person.name) && age==person.age;
          }
      }
  }

• 运行结果：

  

• 结果分析：

  • 我们在EqualsTest2.java 中重写了Person的equals()函数：当两个Person对象的 name 和 age 都相等，则返回true。 因此，运行结果返回true。

    ​

1.3 Java中对equals()的要求

1. 对称性：如果x.equals(y)返回是"true"，那么y.equals(x)也应该返回是"true"。
2. 反射性：x.equals(x)必须返回是"true"。
3. 类推性：如果x.equals(y)返回是"true"，而且y.equals(z)返回是"true"，那么z.equals(x)也应该返回是"true"。
4. 一致性：如果x.equals(y)返回是"true"，只要x和y内容一直不变，不管你重复x.equals(y)多少次，返回都是"true"。
5. 非空性，x.equals(null)，永远返回是"false"；x.equals(和x不同类型的对象)永远返回是"false"。

• 回顾一下equals()的作用：判断两个对象是否相等。需要重写的时候不能改变其功能

  ​

二、equals()与==的区别是什么？

2.1 二者的概念

1. ==：判断两个对象的地址是否相等，换句话说，就是判断两个对象是否是同一个对象。
2. equals()：判断两个对象是否相等，如上一个章节的两个区别，一个是没有重写覆盖，相当于是==；另外一个是通过重写覆盖需要判断的具体内容。

​

2.2 具体代码对比

• 通过代码进行对比：

public class EqualsTest3 {

    public static void main(String[] args) {
        // 新建2个相同内容的Person对象，
        // 再用equals比较它们是否相等
        Person p1 = new Person("eee", 100);
        Person p2 = new Person("eee", 100);
        System.out.printf("p1.equals(p2) : %s\n", p1.equals(p2));
        System.out.printf("p1==p2 : %s\n", p1==p2);
    }

    private static class Person{
        int age;
        String name;

        public Person() {
        }

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

        public String toString() {
            return "Person{age = " + age + ", name = " + name + "}";
        }

        @Override
        public boolean equals(Object obj){
            if(obj==null){
                return false;
            }

            //如果是相同的对象返回true，反之返回false
            if(this==obj){
                return true;
            }

            //判断返回的类型
            if(this.getClass()!=obj.getClass()){
                return false;
            }

            Person person = (Person) obj;
            return name.equals(person.name) && age==person.age;
        }
    }
}

• 运行结果：

  

• 结果分析：

  • p1.equals(p2) ： 这是判断p1和p2的内容是否相等。因为Person覆盖equals()方法，而这个equals()是用来判断p1和p2的内容是否相等，恰恰p1和p2的内容又相等；因此，返回true。

  • p1==p2 ： 这是判断p1和p2是否是同一个对象。由于它们是各自新建的两个Person对象；因此，返回false。

  ​

三、hashCode()的作用

3.1 使用场景和作用

• hashCode() 的作用是获取哈希码，也称为散列码；它实际上是返回一个int整数。这个哈希码的作用是确定该对象在哈希表中的索引位置。

• hashCode()只有再散列表中才有用，其他情况下没有用。在散列表中hashCode()的作用是获取对象的散列码，进而确定该对象在散列表中的位置。

  • 我们都知道，散列表存储的是键值对(key-value)，它的特点是：**能根据“键”快速的检索出对应的“值”。**这其中就利用到了散列码！
  • 散列表的本质是通过数组实现的.
    • 当我们要获取散列表中的某个“值”时，实际上是要获取数组中的某个位置的元素。
    • 数组的位置，就是通过“键”来获取的；更进一步说，数组的位置，是通过“键”对应的散列码计算得到的。

  ​

3.2 具体举例

• 以HashSet为例子，深入说明**HashCode()**的方法：

  Q：假设，HashSet中已经有1000个元素。当插入第1001个元素时，需要怎么处理？

  A： 因为HashSet是Set集合，它允许有重复元素。 “将第1001个元素逐个的和前面1000个元素进行比较”？显然，这个效率是相等低下的。散列表很好的解决了这个问题，它根据元素的散列码计算出元素在散列表中的位置，然后将元素插入该位置即可。对于相同的元素，自然是只保存了一个。

  T： 由此可知，若两个元素相等，它们的散列码一定相等；但反过来确不一定。

  • 在散列表中：

    1. 如果两个对象相等，那么它们的hashCode()值一定要相同；
    2. 如果两个对象hashCode()相等，它们并不一定相等。

  • 注意：这是在散列表中的情况。在非散列表中一定如此！

  ​

四、hashCode() 和 equals() 的关系

• 按照类的用途进行分类如下的两种情况：

  ​

4.1 不会创建“类对应的散列表”

• 在这样的情况下，不会创建该类的hashCode()方法，或者说此方法没有实现效果，不用理会。

  通过示例查看类的两个对象相等 以及 不等时hashCode()的取值：

  import java.util.*;
  import java.lang.Comparable;
  
  /**
   * @desc 比较equals() 返回true 以及 返回false时， hashCode()的值。
   */
  public class NormalHashCodeTest{
  
      public static void main(String[] args) {
          // 新建2个相同内容的Person对象，
          // 再用equals比较它们是否相等
          Person p1 = new Person("eee", 100);
          Person p2 = new Person("eee", 100);
          Person p3 = new Person("aaa", 200);
          System.out.printf("p1.equals(p2) : %s; p1(%d) p2(%d)\n", p1.equals(p2), p1.hashCode(), p2.hashCode());
          System.out.printf("p1.equals(p3) : %s; p1(%d) p3(%d)\n", p1.equals(p3), p1.hashCode(), p3.hashCode());
      }
  
      /**
       * @desc Person类。
       */
      private static class Person {
          int age;
          String name;
  
          public Person(String name, int age) {
              this.name = name;
              this.age = age;
          }
  
          public String toString() {
              return name + " - " +age;
          }
  
          /**
           * @desc 覆盖equals方法
           */
          public boolean equals(Object obj){
              if(obj == null){
                  return false;
              }
  
              //如果是同一个对象返回true，反之返回false
              if(this == obj){
                  return true;
              }
  
              //判断是否类型相同
              if(this.getClass() != obj.getClass()){
                  return false;
              }
  
              Person person = (Person)obj;
              return name.equals(person.name) && age==person.age;
          }
      }
  }

• 运行结果：

  

  ​

• 结果分析：

  • p1和p2相等的情况下，hashCode()也不一定相等

    ​

4.2 会创建“类对应的散列表”

• 在这种情况下，该类的“hashCode() 和 equals() ”是有关系的：

  1. 如果两个对象相等，那么它们的hashCode()值一定相同。 这里的相等是指，通过equals()比较两个对象时返回true。
  2. 如果两个对象hashCode()相等，它们并不一定相等。 因为在散列表中，hashCode()相等，即两个键值对的哈希值相等。然而哈希值相等，并不一定能得出键值对相等。

  补充说一句：“两个不同的键值对，哈希值相等”，这就是哈希冲突。

  ​

• 此外，在这种情况下。若要判断两个对象是否相等，除了要覆盖equals()之外，也要覆盖hashCode()函数。否则，equals()无效。

例如，创建Person类的HashSet集合，必须同时覆盖Person类的equals() 和 hashCode()方法。

如果单单只是覆盖equals()方法。我们会发现，equals()方法没有达到我们想要的效果。

import java.util.*;
import java.lang.Comparable;

/**
 * @desc 比较equals() 返回true 以及 返回false时， hashCode()的值。
 */
public class ConflictHashCodeTest1{

    public static void main(String[] args) {
        // 新建Person对象，
        Person p1 = new Person("eee", 100);
        Person p2 = new Person("eee", 100);
        Person p3 = new Person("aaa", 200);

        // 新建HashSet对象
        HashSet set = new HashSet();
        set.add(p1);
        set.add(p2);
        set.add(p3);

        // 比较p1 和 p2， 并打印它们的hashCode()
        System.out.printf("p1.equals(p2) : %s; p1(%d) p2(%d)\n", p1.equals(p2), p1.hashCode(), p2.hashCode());
        // 打印set
        System.out.printf("set:%s\n", set);
    }

    /**
     * @desc Person类。
     */
    private static class Person {
        int age;
        String name;

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

        public String toString() {
            return "("+name + ", " +age+")";
        }

        /**
         * @desc 覆盖equals方法
         */
        @Override
        public boolean equals(Object obj){
            if(obj == null){
                return false;
            }

            //如果是同一个对象返回true，反之返回false
            if(this == obj){
                return true;
            }

            //判断是否类型相同
            if(this.getClass() != obj.getClass()){
                return false;
            }

            Person person = (Person)obj;
            return name.equals(person.name) && age==person.age;
        }
    }
}

​

• 运行结果：

  

• 结果分析：

  • 我们重写了Person的equals()。但是，很奇怪的发现：HashSet中仍然有重复元素：p1 和 p2。为什么会出现这种情况呢？

  • 这是因为虽然p1 和 p2的内容相等，但是它们的hashCode()不等；所以，HashSet在添加p1和p2的时候，认为它们不相等。

    ​

• 下面，我们同时覆盖equals() 和 hashCode()方法：

import java.util.*;
import java.lang.Comparable;

/**
 * @desc 比较equals() 返回true 以及 返回false时， hashCode()的值。
 */
public class ConflictHashCodeTest2{

    public static void main(String[] args) {
        // 新建Person对象，
        Person p1 = new Person("eee", 100);
        Person p2 = new Person("eee", 100);
        Person p3 = new Person("aaa", 200);
        Person p4 = new Person("EEE", 100);

        // 新建HashSet对象
        HashSet set = new HashSet();
        set.add(p1);
        set.add(p2);
        set.add(p3);

        // 比较p1 和 p2， 并打印它们的hashCode()
        System.out.printf("p1.equals(p2) : %s; p1(%d) p2(%d)\n", p1.equals(p2), p1.hashCode(), p2.hashCode());
        
        // 比较p1 和 p4， 并打印它们的hashCode()
        System.out.printf("p1.equals(p4) : %s; p1(%d) p4(%d)\n", p1.equals(p4), p1.hashCode(), p4.hashCode());
        
        // 打印set
        System.out.printf("set:%s\n", set);
    }

    /**
     * @desc Person类。
     */
    private static class Person {
        int age;
        String name;

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

        public String toString() {
            return name + " - " +age;
        }

        /**
         * @desc重写hashCode
         */
        @Override
        public int hashCode(){
            int nameHash =  name.toUpperCase().hashCode();
            return nameHash ^ age;
        }

        /**
         * @desc 覆盖equals方法
         */
        @Override
        public boolean equals(Object obj){
            if(obj == null){
                return false;
            }

            //如果是同一个对象返回true，反之返回false
            if(this == obj){
                return true;
            }

            //判断是否类型相同
            if(this.getClass() != obj.getClass()){
                return false;
            }

            Person person = (Person)obj;
            return name.equals(person.name) && age==person.age;
        }
    }
}

• 运行结果：

  

  ​

• 结果分析：

  • 这下，equals()生效了，HashSet中没有重复元素。

  • 比较p1和p2，我们发现：它们的hashCode()相等，通过equals()比较它们也返回true。所以，p1和p2被视为相等。

  • 比较p1和p4，我们发现：虽然它们的hashCode()相等；但是，通过equals()比较它们返回false。所以，p1和p4被视为不相等。

    ​

End~

​