Java equals() 、hashCode()浅析

equals()

equals()作用

equals() 的作用是 用来判断两个对象是否相等。

equals() 定义在JDK的Object.java中，通过判断两个对象的地址是否相等(即，是否是同一个对象)来区分它们是否相等，源码如下：

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

Object.java中定义了equals()方法，Object类是所有Java类的祖先，每个类都使用 Object 作为超类。这就意味着所有的Java类都继承了equals()方法，所有的类都可以通过equals()去比较两个对象是否相等。 但是，我们已经说过，使用默认的“equals()”方法，等价于“==”方法。因此，我们通常会重写equals()方法：若两个对象的内容相等，则equals()方法返回true；否则，返回fasle。

根据类“是否覆盖equals()方法”，将所有类分为两组。

(1) 没有覆盖equals()方法的类，它通过equals()比较两个对象时，等价于通过“==”去比较这两个对象，实际上是比较两个对象是不是同一个对象。

(2) 覆盖equals()方法的类，让equals()通过其它方式比较两个对象是否相等：若两个对象的内容相等，则equals()方法返回true；否则，返回false。

实例1：没有覆盖equals()方法的类

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

public class EqualsTest1{
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;
}
}
}

输出：

false

结果分析：

通过 p1.equals(p2) 来“比较p1和p2是否相等时”，由于 Person类并没有覆盖equals()方法，调用的是Object.java的equals()方法，即调用的 (p1==p2) ，比较“p1和p2是否是同一个对象”。

而由 p1 和 p2 的定义可知，它们虽然内容相同；但它们是两个不同的对象！因此，返回结果是false。

实例：覆盖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));
}

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;
}
}
}

输出：

true

结果分析：

Person类覆盖了equals()函数：当两个Person对象的 name 和 age 都相等，则返回true。

因此，运行结果返回true。

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() : 它的作用也是判断两个对象是否相等。但它一般有两种使用情况 ：

情况1，类没有覆盖equals()方法：则通过equals()比较该类的两个对象时，等价于通过“==”比较这两个对象。

情况2，类覆盖了equals()方法：一般，我们都覆盖equals()方法来比较两个对象的内容是否相等；若它们的内容相等，则返回true(即，认为这两个对象相等)。

通过示例比较它们的区别:

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

/**
* @desc equals()的测试程序。
*
* @author skywang
* @emai kuiwu-wang@163.com
*/
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);
}

/**
* @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;
}
}
}

输出：

p1.equals(p2) : true
p1==p2 : false

结果分析

在EqualsTest3.java 中：

(1) p1.equals(p2)

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

(2) p1==p2

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

hashCode()

hashCode()的作用

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

hashCode() 定义在JDK的Object.java中，这就意味着Java中的所有类都包含有hashCode() 函数。

虽然，每个Java类都包含hashCode() 函数。但是，仅仅当创建并使用某个“类的散列表”时，该类的hashCode() 才有用(作用是：确定该类的每一个对象在散列表中的位置；其它情况下(例如，创建类的单个对象，或者创建类的对象数组等等)，类的hashCode() 没有作用。

上面的散列表，指的是：Java集合中本质是散列表的类，如HashMap，Hashtable，HashSet。

即：hashCode() 在散列表中才有用，在其它情况下没用。在散列表中hashCode() 的作用是获取对象的散列码，进而确定该对象在散列表中的索引位置。

简单的介绍一下散列码的作用：

散列表存储的是键值对(key-value)，它的特点是：能根据“键”快速的检索出对应的“值”，这其中就利用到了散列码！

散列表的本质是通过数组实现的，当要获取散列表中的某个“值”时，实际上是要获取数组中的某个位置的元素。而“值”在数组中的位置，就是通过“键”来获取的；更进一步说，索引位置，是通过“键”对应的散列码计算得到的。

下面，我们以HashSet为例，来深入说明hashCode()的作用。

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

因为HashSet是Set集合，它不允许有重复元素。

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

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

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

2、如果两个对象hashCode()相等，它们并不一定相等。

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

hashCode() 和 equals() 的关系

很多文章将 hashCode() 和 equals 关联起来，有的讲的不透彻，有误导读者的嫌疑。这里，梳理一下 “hashCode() 和 equals()的关系”。

我们以“类的用途”来将“hashCode() 和 equals()的关系”分2种情况来说明。

1. 第一种 不会创建“类对应的散列表”

这里所说的“不会创建类对应的散列表”是说：我们不会在HashSet, Hashtable, HashMap等等这些本质是散列表的数据结构中，用到该类。例如，不会创建该类的HashSet集合。

在这种情况下，该类的“hashCode() 和 equals() ”没有半毛钱关系的！

在这种情况下，equals() 用来比较该类的两个对象是否相等。而hashCode() 则根本没有任何作用，所以，不用理会hashCode()。

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

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

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.equals(p2) : true; p1(1169863946) p2(1901116749)
p1.equals(p3) : false; p1(1169863946) p3(2131949076)

从结果也可以看出：p1和p2相等的情况下，hashCode()也不一定相等。

第二种 会创建“类对应的散列表”

这里所说的“会创建类对应的散列表”是说：我们会在HashSet, Hashtable, HashMap等等这些本质是散列表的数据结构中，用到该类。例如，会创建该类的HashSet集合。

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

1)、如果两个对象相等，那么它们的hashCode()值一定相同。

这里的相等是指，通过equals()比较两个对象时返回true。

2)、如果两个对象hashCode()相等，它们并不一定相等，通过equals()比较两个对象时不一定返回true。

因为在散列表中，hashCode()相等，即两个键值对的哈希值相等。然而哈希值相等，并不一定能得出键值对相等。补充说一句：“两个不同的键值对，哈希值相等”，这就是哈希冲突。

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

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

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

实例：

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

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;
}
}
}

输出：

p1.equals(p2) : true; p1(1169863946) p2(1690552137)
set:[(eee, 100), (eee, 100), (aaa, 200)]

结果分析：

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

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

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

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

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;
}
}
}

输出：

p1.equals(p2) : true; p1(68545) p2(68545)
p1.equals(p4) : false; p1(68545) p4(68545)
set:[aaa - 200, eee - 100]

结果分析：

此时，equals()生效了，HashSet中没有重复元素。

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

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