用生命谱写代码的赞歌

0%

Java 中 equals() 和 hashCode() 的方法详解

equals() 与 hashCode()

equals():反映的是对象或变量具体的值,即两个对象里面包含的值–可能是对象的引用,也可能是值类型的值。

hashCode():计算出对象实例的哈希码,并返回哈希码,又称为散列函数。根类 Object 的 hashCode() 方法的计算依赖于对象实例的 D(内存地址),故每个 Object 对象的 hashCode 都是唯一的;当然,当对象所对应的类重写了 hashCode() 方法时,结果就截然不同了。

首先 equals()hashcode() 这两个方法都是从 object 类中继承过来的。

equals() 方法在 object 类中定义如下:

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

很明显是对两个对象的地址值进行的比较(也就是比较对象的引用)。但是我们必需清楚,当 String 、Math、还有Integer、Double 等等这些封装类在使用 equals() 方法时,都覆盖了 object 类的 equals() 方法,因为 Object 中的 equals() 不能满足需求。

下面就以 String 类中的 equals() 方法为例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
public boolean equals(Object anObject) {
if (this == anObject) {
return true;
}
if (anObject instanceof String) {
String anotherString = (String)anObject;
int n = count;
if (n == anotherString.count) {
char v1[] = value;
char v2[] = anotherString.value;
int i = offset;
int j = anotherString.offset;
while (n– != 0) {
if (v1[i++] != v2[j++])
return false;
}
return true;
}
}
return false;
}

很明显,这是进行的内容比较,而已经不再是地址的比较。依次类推 Double、Integer、Math等等这些类都是重写了 equals() 方法的,从而进行的是内容的比较。当然了基本类型是进行值的比较,这个没有什么好说的。

我们还应该注意,Java 语言对 equals() 的要求如下,这些要求是必须遵循的:

  • 对称性:如果 x.equals(y) 返回是 true ,那么 y.equals(x) 也应该返回是 true 。
  • 反射性:x.equals(x) 必须返回是 true 。
  • 类推性:如果 x.equals(y) 返回是 true ,而且 y.equals(z) 返回是 true ,那么z.equals(x)也应该返回是 true 。
  • 还有一致性:如果 x.equals(y) 返回是 true ,只要 x 和 y 内容一直不变,不管你重复 x.equals(y) 多少次,返回都是 true 。
  • 任何情况下,x.equals(null) ,永远返回是 false ;x.equals (和 x 不同类型的对象)永远返回是 false 。

以上这五点是重写 equals() 方法时,必须遵守的准则,如果违反会出现意想不到的结果,请大家一定要遵守。

hashcode() 方法,在 object 类中定义如下:

1
public native int `hashcode()`;

说明是一个本地方法,它的实现是根据本地机器相关的。当然我们可以在自己写的类中覆盖 hashcode() 方法,比如 String、 Integer、Double 等等这些类都是覆盖了 hashcode() 方法的。

例如在String类中定义的 hashcode() 方法如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
public int `hashcode()` {
int h = hash;
if (h == 0) {
int off = offset;
char val[] = value;
int len = count;
for (int i = 0; i < len; i++) {
h = 31*h + val[off++];
}
hash = h;
}
return h;
}

解释一下这个程序(String的API中写到):

s[0]*31^(n-1) + s[1]*31^(n-2) + … + s[n-1]

使用 int 算法,这里 s[i] 是字符串的第 i 个字符,n 是字符串的长度,^ 表示求幂。
(空字符串的哈希码为 0)

首先,想要明白 hashCode 的作用,你必须要先知道 Java 中的集合。

总的来说,Java 中的集合(Collection)有两类,一类是 List,再有一类是 Set。

你知道它们的区别吗?前者集合内的元素是有序的,元素可以重复;后者元素无序,但元素不可重复。

那么这里就有一个比较严重的问题了:要想保证元素不重复,可两个元素是否重复应该依据什么来判断呢?

这就是 Object.equals 方法了。但是,如果每增加一个元素就检查一次,那么当元素很多时,后添加到集合中的元素比较的次数就非常多了。

也就是说,如果集合中现在已经有 1000 个元素,那么第 1001 个元素加入集合时,它就要调用 1000 次 equals 方法。这显然会大大降低效率。

于是,Java 采用了哈希表的原理。哈希(Hash)实际上是个人名,由于他提出一哈希算法的概念,所以就以他的名字命名了。

哈希算法也称为散列算法,是将数据依特定算法直接指定到一个地址上。如果详细讲解哈希算法,那需要更多的文章篇幅,我在这里就不介绍了。

初学者可以这样理解,hashCode 方法实际上返回的就是对象存储的物理地址(实际可能并不是)。

这样一来,当集合要添加新的元素时,先调用这个元素的 hashCode 方法,就一下子能定位到它应该放置的物理位置上。

如果这个位置上没有元素,它就可以直接存储在这个位置上,不用再进行任何比较了;如果这个位置上已经有元素了,就调用它的 equals 方法与新元素进行比较,相同的话就不存了,不相同就散列其它的地址。

所以这里存在一个冲突解决的问题。这样一来实际调用 equals 方法的次数就大大降低了,几乎只需要一两次。

所以,Java 对于 eqauls 方法和 hashCode 方法是这样规定的:

  1. 如果两个对象相同,那么它们的hashCode值一定要相同;
  2. 如果两个对象的hashCode相同,它们并不一定相同;

上面说的对象相同指的是用eqauls方法比较。你当然可以不按要求去做了,但你会发现,相同的对象可以出现在Set集合中。同时,增加新元素的效率会大大下降。

这里我们首先要明白一个问题:

equals() 相等的两个对象,hashcode() 一定相等;

equals() 不相等的两个对象,却并不能证明他们的 hashcode() 不相等。换句话说,equals() 方法不相等的两个对象,hashcode() 有可能相等。(我的理解是由于哈希码在生成的时候产生冲突造成的)。

反过来:hashcode() 不等,一定能推出 equals() 也不等;hashcode() 相等,equals() 可能相等,也可能不等。

解释下第3点的使用范围,我的理解是在 object、String 等类中都能使用。在 object类中,hashcode() 方法是本地方法,返回的是对象的地址值,而 object 类中的 equals() 方法比较的也是两个对象的地址值,如果 equals() 相等,说明两个对象地址值也相等,当然 hashcode() 也就相等了;在String类中,equals() 返回的是两个对象内容的比较,当两个对象内容相等时,hashcode() 方法根据String类的重写(第2点里面已经分析了)代码的分析,也可知道 hashcode() 返回结果也会相等。

以此类推,可以知道 Integer、Double 等封装类中经过重写的 equals()hashcode() 方法也同样适合于这个原则。当然没有经过重写的类,在继承了 object 类的 equals()hashcode() 方法后,也会遵守这个原则。

谈到 hashcode()equals() 就不能不说到 hashset,hashmap,hashtable 中的使用,具体是怎样呢,请看如下分析:

Hashset 是继承 Set 接口,Set 接口又实现 Collection 接口,这是层次关系。那么 hashset 是根据什么原理来存取对象的呢?

在 hashset 中不允许出现重复对象,元素的位置也是不确定的。在 hashset 中又是怎样判定元素是否重复的呢?这就是问题的关键所在,经过一下午的查询求证终于获得了一点启示,和大家分享一下,在 java 的集合中,判断两个对象是否相等的规则是:

  1. 判断两个对象的hashCode是否相等
    • 如果不相等,认为两个对象也不相等,完毕
    • 如果相等,转入2(这一点只是为了提高存储效率而要求的,其实理论上没有也可以,但如果没有,实际使用时效率会大大降低,所以我们这里将其做为必需的。后面会重点讲到这个问题。)
  2. 判断两个对象用equals运算是否相等
    • 如果不相等,认为两个对象也不相等
    • 如果相等,认为两个对象相等(equals() 是判断两个对象是否相等的关键)

为什么是两条准则,难道用第一条不行吗?不行,因为前面已经说了,hashcode() 相等时,equals() 方法也可能不等,所以必须用第 2 条准则进行限制,才能保证加入的为非重复元素。

比如下面的代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
public static void main(String args[]){
String s1=new String(“zhaoxudong”);
String s2=new String(“zhaoxudong”);
System.out.println(s1==s2);//false
System.out.println(s1.equals(s2));//true
System.out.println(s1.`hashcode()`);//s1.`hashcode()`等于s2.`hashcode()`
System.out.println(s2.`hashcode()`);
Set hashset=new HashSet();
hashset.add(s1);
hashset.add(s2);/*实质上在添加s1,s2时,运用上面说到的两点准则,可以知道hashset认为s1和s2是相等的,是在添加重复元素,所以让s2覆盖了s1;*/
Iterator it=hashset.iterator();
while(it.hasNext()){
System.out.println(it.next());
}

最后在while循环的时候只打印出了一个”zhaoxudong”。

输出结果为:

1
2
3
4
false
true
-967303459
-967303459

这是因为 String 类已经重写了 equals() 方法和 hashcode() 方法,所以在根据上面的第1.2条原则判定时,hashset认为它们是相等的对象,进行了重复添加。

但是看下面的程序:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
import java.util.*;
public class HashSetTest
{
public static void main(String[] args)
{
HashSet hs=new HashSet();
hs.add(new Student(1,”zhangsan”));
hs.add(new Student(2,”lisi”));
hs.add(new Student(3,”wangwu”));
hs.add(new Student(1,”zhangsan”));
Iterator it=hs.iterator();
while(it.hasNext())
{
System.out.println(it.next());
}
}
}
class Student
{
int num;
String name;
Student(int num,String name)
{
this.num=num;
this.name=name;
}
public String toString()
{
return num+”:”+name;
}
}

输出结果为:

1
2
3
4
1:zhangsan
1:zhangsan
3:wangwu
2:lisi

问题出现了,为什么 hashset 添加了相等的元素呢,这是不是和 hashset 的原则违背了呢?回答是:没有

因为在根据 hashcode() 对两次建立的 new Student(1,”zhangsan”) 对象进行比较时,生成的是不同的哈希码值,所以 hashset 把他当作不同的对象对待了,当然此时的 equals() 方法返回的值也不等(这个不用解释了吧)。

那么为什么会生成不同的哈希码值呢?上面我们在比较s1和s2的时候不是生成了同样的哈希码吗?

原因就在于我们自己写的Student类并没有重新自己的 hashcode()equals() 方法,所以在比较时,是继承的 object 类中的 hashcode() 方法,呵呵,各位还记得 object 类中的 hashcode() 方法比较的是什么吧!!

它是一个本地方法,比较的是对象的地址(引用地址),使用 new 方法创建对象,两次生成的当然是不同的对象了(这个大家都能理解吧。。。),造成 的结果就是两个对象的 hashcode() 返回的值不一样。

所以根据第一个准则,hashset 会把它们当作不同的对象对待,自然也用不着第二个准则进行 判定了。那么怎么解决这个问题呢??

答案是:在 Student 类中重新 hashcode()equals() 方法。

例如:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
class Student{
int num;
String name;
Student(int num,String name){
this.num=num;
this.name=name;
}
public int `hashcode()`{
return num*name.`hashcode()`;
}
public boolean equals(Object o){
Student s=(Student)o;
return num==s.num && name.equals(s.name);
}
public String toString(){
return num+”:”+name;
}
}

根据重写的方法,即便两次调用了 new Student(1,”zhangsan”),我们在获得对象的哈希码时,根据重写的方法 hashcode(),获得的哈希码肯定是一样的(这一点应该没有疑问吧)。

当然根据 equals() 方法我们也可判断是相同的。所以在向 hashset 集合中添加时把它们当作重复元素看待了。所以运行修改后的程序时,我们会发现运行结果是:

1
2
3
1:zhangsan
3:wangwu
2:lisi

可以看到重复元素的问题已经消除。

关于在 hibernate 的 pojo 类中,重新 equals()hashcode() 的问题:

  1. 重点是 equals,重写 hashCode 只是技术要求(为了提高效率)
  2. 为什么要重写 equals 呢,因为在 java 的集合框架中,是通过 equals 来判断两个对象是否相等的
  3. 在 hibernate 中,经常使用set集合来保存相关对象,而set集合是不允许重复的。我们再来谈谈前面提到在向 hashset 集合中添加元素时,怎样判断对象是否相同的准则,前面说了两条,其实只要重写 equals() 这一条也可以。

但当 hashset 中元素比较多时,或者是重写的 equals() 方法比较复杂时,我们只用 equals() 方法进行比较判断,效率也会非常低,所以引入了 hashcode() 这个方法,只是为了提高效率,但是我觉得这是非常有必要的(所以我们在前面以两条准则来进行hashset的元素是否重复 的判断)。

比如可以这样写:

1
2
public int `hashcode()`{
return 1;}//等价于hashcode无效

这样做的效果就是在比较哈希码的时候不能进行判断,因为每个对象返回的哈希码都是1,每次都必须要经过比较 equals() 方法后才能进行判断是否重复,这当然会引起效率的大大降低。

我有一个问题,如果像前面提到的在 hashset 中判断元素是否重复的必要方法是 equals() 方法(根据网上找到的观点),但是这里并没有涉及到关于哈希表的问题,可是这个集合却叫hashset,这是为什么??

我想,在 hashmap, hashtable 中的存储操作,依然遵守上面的准则。所以这里不再多说。

如果大家觉得不足的地方还是多多指教。希望能在探讨中一起进步。

原文地址