java中hashCode方法与equals方法以及contains方法的用法总结

一、equals方法的作用

   1、默认情况（没有覆盖equals方法）下equals方法都是调用Object类的equals方法，而Object的equals方法主要用于判断对象的内存地址引用是不是同一个地址（是不是同一个对象）。

2 、要是类中覆盖了equals方法，那么就要根据具体的代码来确定equals方法的作用了，覆盖后一般都是通过对象的内容是否相等来判断对象是否相等。

没有覆盖equals方法代码如下：

[java] view plaincopy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.       
6.     public Student() {  
7.     }  
8.     public Student(int age, String name) {  
9.         super();  
10.         this.age = age;  
11.         this.name = name;  
12.     }  
13.     public int getAge() {  
14.         return age;  
15.     }  
16.     public String getName() {  
17.         return name;  
18.     }  
19.     public void setAge(int age) {  
20.         this.age = age;  
21.     }  
22.     public void setName(String name) {  
23.         this.name = name;  
24.     }  
25. }  

测试 代码如下：

[java] view plaincopy

1. import java.util.HashSet;  
2. import java.util.LinkedList;  
3. import java.util.Set;  
4.   
5.   
6. public class EqualsTest {  
7.     public static void main(String[] args) {  
8.         LinkedList<Student> list = new LinkedList<Student>();  
9.         Set<Student> set = new HashSet<Student>();  
10.         Student stu1  = new Student(3,"张三");  
11.         Student stu2  = new Student(3,"张三");  
12.         System.out.println("stu1 == stu2 : "+(stu1 == stu2));  
13.         System.out.println("stu1.equals(stu2) : "+stu1.equals(stu2));  
14.         list.add(stu1);  
15.         list.add(stu2);  
16.         System.out.println("list size:"+ list.size());  
17.           
18.         set.add(stu1);  
19.         set.add(stu2);  
20.         System.out.println("set size:"+ set.size());  
21.     }  
22.   
23. }  

运行结果：

stu1 == stu2 : false
stu1.equals(stu2) :  false
list size:2
set size:2

结果分析：Student类没有覆盖equals方法，stu1调用equals方法实际上调用的是Object的equals方法。所以采用对象内存地址是否相等来判断对象是否相等。因为是两个新对象所以对象的内存地址不相等，所以stu1.equals(stu2) 是false。

3、我们覆盖一下equals方法（age和name属性），让Student类其通过判断对象的内容是否相等来确定对象是否相等。

覆盖后的Student类：

[java] view plaincopy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.       
6.     public Student() {  
7.     }  
8.     public Student(int age, String name) {  
9.         super();  
10.         this.age = age;  
11.         this.name = name;  
12.     }  
13.     public int getAge() {  
14.         return age;  
15.     }  
16.     public String getName() {  
17.         return name;  
18.     }  
19.     public void setAge(int age) {  
20.         this.age = age;  
21.     }  
22.     public void setName(String name) {  
23.         this.name = name;  
24.     }  
25.     @Override  
26.     public boolean equals(Object obj) {  
27.         if (this == obj)  
28.             return true;  
29.         if (obj == null)  
30.             return false;  
31.         if (getClass() != obj.getClass())  
32.             return false;  
33.         Student other = (Student) obj;  
34.         if (age != other.age)  
35.             return false;  
36.         if (name == null) {  
37.             if (other.name != null)  
38.                 return false;  
39.         } else if (!name.equals(other.name))  
40.             return false;  
41.         return true;  
42.     }  
43.       
44. }  

运行结果：

stu1 == stu2 : false
stu1.equals(stu2) : true
list size:2
set size:2

结果分析：因为Student两个对象的age和name属性相等，而且又是通过覆盖equals方法来判断的，所示stu1.equals(stu2) 为true。注意以上几次测试list和set的size都是2

二、HashCode

4、通过以上的代码运行，我们知道equals方法已经生效。接下来我们在覆盖一下hashCode方法（通过age和name属性来生成hashcode）并不覆盖equals方法，其中Hash码是通过age和name生成的。

覆盖hashcode后的Student类：

[java] view plaincopy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.       
6.     public Student() {  
7.     }  
8.     public Student(int age, String name) {  
9.         super();  
10.         this.age = age;  
11.         this.name = name;  
12.     }  
13.     public int getAge() {  
14.         return age;  
15.     }  
16.     public String getName() {  
17.         return name;  
18.     }  
19.     public void setAge(int age) {  
20.         this.age = age;  
21.     }  
22.     public void setName(String name) {  
23.         this.name = name;  
24.     }  
25.     @Override  
26.     public int hashCode() {  
27.         final int prime = 31;  
28.         int result = 1;  
29.         result = prime * result + age;  
30.         result = prime * result + ((name == null) ? 0 : name.hashCode());  
31.         return result;  
32.     }     
33. }  

运行结果：

stu1 == stu2 : false
stu1.equals(stu2) : false
list size:2
hashCode :775943
hashCode :775943
set size:2

结果分析：我们并没有覆盖equals方法只覆盖了hashCode方法，两个对象虽然hashCode一样，但在将stu1和stu2放入set集合时由于equals方法比较的两个对象是false，所以就没有在比较两个对象的hashcode值。

5、我们覆盖一下equals方法和hashCode方法。

Student代码如下：

[java] view plaincopy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.     public Student() {  
6.     }  
7.     public Student(int age, String name) {  
8.         super();  
9.         this.age = age;  
10.         this.name = name;  
11.     }  
12.     public int getAge() {  
13.         return age;  
14.     }  
15.     public String getName() {  
16.         return name;  
17.     }  
18.     public void setAge(int age) {  
19.         this.age = age;  
20.     }  
21.     public void setName(String name) {  
22.         this.name = name;  
23.     }  
24.     @Override  
25.     public int hashCode() {  
26.         final int prime = 31;  
27.         int result = 1;  
28.         result = prime * result + age;  
29.         result = prime * result + ((name == null) ? 0 : name.hashCode());  
30.         System.out.println("hashCode : "+ result);  
31.         return result;  
32.     }  
33.     @Override  
34.     public boolean equals(Object obj) {  
35.         if (this == obj)  
36.             return true;  
37.         if (obj == null)  
38.             return false;  
39.         if (getClass() != obj.getClass())  
40.             return false;  
41.         Student other = (Student) obj;  
42.         if (age != other.age)  
43.             return false;  
44.         if (name == null) {  
45.             if (other.name != null)  
46.                 return false;  
47.         } else if (!name.equals(other.name))  
48.             return false;  
49.         return true;  
50.     }  
51.       
52. }  

运行结果：

stu1 == stu2 : false

stu1.equals(stu2) :true

list size:2

hashCode :775943

hashCode :775943

set size:1

结果分析：stu1和stu2通过equals方法比较相等，而且返回的hashCode值一样，所以放入set集合中时只放入了一个对象。

6、下面我们让两个对象equals方法比较相等，但hashCode值不相等试试。

Student类的代码如下：

[java] view plaincopy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.     <span style="color:#ff0000;">private static int index=5;</span>  
6.     public Student() {  
7.     }  
8.     public Student(int age, String name) {  
9.         super();  
10.         this.age = age;  
11.         this.name = name;  
12.     }  
13.     public int getAge() {  
14.         return age;  
15.     }  
16.     public String getName() {  
17.         return name;  
18.     }  
19.     public void setAge(int age) {  
20.         this.age = age;  
21.     }  
22.     public void setName(String name) {  
23.         this.name = name;  
24.     }  
25.     @Override  
26.     public int hashCode() {  
27.         final int prime = 31;  
28.         int result = 1;  
29.         result = prime * result + <span style="color:#ff0000;">(age+index++)</span>;  
30.         result = prime * result + ((name == null) ? 0 : name.hashCode());  
31.         <span style="color:#ff0000;">System.out.println("result :"+result);</span>  
32.         return result;  
33.     }  
34.     @Override  
35.     public boolean equals(Object obj) {  
36.         if (this == obj)  
37.             return true;  
38.         if (obj == null)  
39.             return false;  
40.         if (getClass() != obj.getClass())  
41.             return false;  
42.         Student other = (Student) obj;  
43.         if (age != other.age)  
44.             return false;  
45.         if (name == null) {  
46.             if (other.name != null)  
47.                 return false;  
48.         } else if (!name.equals(other.name))  
49.             return false;  
50.         return true;  
51.     }  
52.       
53. }  

运行结果：

stu1 == stu2 : false
stu1.equals(stu2) : true
list size:2
hashCode :776098
hashCode :776129
set size:2

结果分析：虽然stu1和stu2通过equals方法比较相等，但两个对象的hashcode的值并不相等，所以在将stu1和stu2放入set集合中时认为是两个不同的对象。

7、修改stu1的某个属性值

Student代码如下：

[java] view plaincopy

1. //学生类  
2. public class Student {  
3.     private int age;  
4.     private String name;  
5.     public Student() {  
6.     }  
7.     public Student(int age, String name) {  
8.         super();  
9.         this.age = age;  
10.         this.name = name;  
11.     }  
12.     public int getAge() {  
13.         return age;  
14.     }  
15.     public String getName() {  
16.         return name;  
17.     }  
18.     public void setAge(int age) {  
19.         this.age = age;  
20.     }  
21.     public void setName(String name) {  
22.         this.name = name;  
23.     }  
24.     @Override  
25.     public int hashCode() {  
26.         final int prime = 31;  
27.         int result = 1;  
28.         result = prime * result + age;  
29.         result = prime * result + ((name == null) ? 0 : name.hashCode());  
30.         System.out.println("hashCode : "+ result);  
31.         return result;  
32.     }  
33.     @Override  
34.     public boolean equals(Object obj) {  
35.         if (this == obj)  
36.             return true;  
37.         if (obj == null)  
38.             return false;  
39.         if (getClass() != obj.getClass())  
40.             return false;  
41.         Student other = (Student) obj;  
42.         if (age != other.age)  
43.             return false;  
44.         if (name == null) {  
45.             if (other.name != null)  
46.                 return false;  
47.         } else if (!name.equals(other.name))  
48.             return false;  
49.         return true;  
50.     }  
51.       
52. }  

测试代码如下：

[java] view plaincopy

1. import java.util.HashSet;  
2. import java.util.LinkedList;  
3. import java.util.Set;  
4.   
5.   
6. public class EqualsTest {  
7.     public static void main(String[] args) {  
8.         LinkedList<Student> list = new LinkedList<Student>();  
9.         Set<Student> set = new HashSet<Student>();  
10.         Student stu1  = new Student(3,"张三");  
11.         Student stu2  = new Student(3,"张三");  
12.         System.out.println("stu1 == stu2 : "+(stu1 == stu2));  
13.         System.out.println("stu1.equals(stu2) : "+stu1.equals(stu2));  
14.         list.add(stu1);  
15.         list.add(stu2);  
16.         System.out.println("list size:"+ list.size());  
17.           
18.         set.add(stu1);  
19.         set.add(stu2);  
20.         System.out.println("set size:"+ set.size());  
21.         stu1.setAge(34);  
22.         System.out.println("remove stu1 : "+set.remove(stu1));  
23.         System.out.println("set size:"+ set.size());  
24.     }  
25.   
26. }  

运行结果：

stu1 == stu2 : false
stu1.equals(stu2) : true
list size:2
hashCode : 775943
hashCode : 775943
set size:1
hashCode : 776904
remove stu1 : false
set size:1

结果分析：

当我们将某个对象存到set中时，如果该对象的属性参与了hashcode的计算，那么以后就不能修改该对象参与hashcode计算的那些属性了，否则会引起意向不到的错误的。正如测试中，不能够移除stu1对象。

三、contains方法的作用

     

   例如，一个AarryList 有1000个String元素，现在需要你判断里面是否有我的String id：lzw0286,
你难道不用contains ,而会自己去写个一方法，来迭代arrayList,取出一个一个String来equals吗？

其实这2个方法主要看使用的情形

equals是比较两个东西是否等同，这个适用于任何类别的对象
contains是是否包含的意思，那肯定.左边的对象是一个容器了
String现在也有一个contains，那是因为String是一个字符的容器

contains内部如何实现要看具体是哪种容器，ArrayList这种随机访问容器内部就是用equals去比较的，和你常识中的实现应该是一样的，HashSet这类容器就是用hashcode来比较的了
下面我粘一段ArrayList的代码吧
    public boolean contains(Object o) {
return indexOf(o) >= 0;
    }
    public int indexOf(Object o) {
if (o == null) {
    for (int i = 0; i < size; i++)
if (elementData[i]==null)
    return i;
} else {
    for (int i = 0; i < size; i++)
if (o.equals(elementData[i]))
    return i;
}
return -1;
    }

hashcode 又与查找对象的存储空间有关系了。
首先，hashcode是一种查找对象的算法，当比较2个对象是否相等时，先会到hashcode对应的内存空间里去找，如果2个对象是在同一个内存空间，再去比较2个对象的equals方法。

当比较对象A与对象B是否相等时要调用 equal方法
当判断对象A是否在集合里时使用contains.

在使用contains的地方你可以不使用，而自己用equal一个一个比较
但是当使用equal的地方，你是无法使用contains替代的。

总结：

1、equals方法用于比较对象的内容是否相等（覆盖以后）

2、hashcode方法只有在集合中用到

3、当覆盖了equals方法时，比较对象是否相等将通过覆盖后的equals方法进行比较（判断对象的内容是否相等）。

4、将对象放入到集合中时，首先判断要放入对象的hashcode值与集合中的任意一个元素的hashcode值是否相等，如果不相等直接将该对象放入集合中。如果hashcode值相等，然后再通过equals方法判断要放入对象与集合中的任意一个对象是否相等，如果equals判断不相等，直接将该元素放入到集合中，否则不放入。

5、将元素放入集合的流程图：

6、HashSet中add方法源代码：

[java] view plaincopy

1. public boolean add(E e) {  
2.     return map.put(e, PRESENT)==null;  
3.     }  

map.put源代码: [java] view plaincopy

1. <pre name="code" class="java"> public V put(K key, V value) {  
2.         if (key == null)  
3.             return putForNullKey(value);  
4.         int hash = hash(key.hashCode());  
5.         int i = indexFor(hash, table.length);  
6.         for (Entry<K,V> e = table[i]; e != null; e = e.next) {  
7.             Object k;  
8.             if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {  
9.                 V oldValue = e.value;  
10.                 e.value = value;  
11.                 e.recordAccess(this);  
12.                 return oldValue;  
13.             }  
14.         }  
15.   
16.         modCount++;  
17.         addEntry(hash, key, value, i);  
18.         return null;  
19.     }</pre>  
20. <pre></pre>  
21. <pre></pre>  
22. 转自http://blog.csdn.net/afgasdg/article/details/6889383。

     

     

     首先，想要明白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集合中。同时，增加新元素的效率会大大下降。

      hashcode这个方法是用来鉴定2个对象是否相等的。 那你会说，不是还有equals这个方法吗？ 不错，这2个方法都是用来判断2个对象是否相等的。但是他们是有区别的。 一般来讲，equals这个方法是给用户调用的，如果你想判断2个对象是否相等，你可以重写equals方法，然后在代码中调用，就可以判断他们是否相等 了。简单来讲，equals方法主要是用来判断从表面上看或者从内容上看，2个对象是不是相等。

       举个例子，有个学生类，属性只有姓名和性别，那么我们可以 认为只要姓名和性别相等，那么就说这2个对象是相等的。 hashcode方法一般用户不会去调用，比如在hashmap中，由于key是不可以重复的，他在判断key是不是重复的时候就判断了hashcode 这个方法，而且也用到了equals方法。这里不可以重复是说equals和hashcode只要有一个不等就可以了！所以简单来讲，hashcode相 当于是一个对象的编码，就好像文件中的md5，他和equals不同就在于他返回的是int型的，比较起来不直观。我们一般在覆盖equals的同时也要 覆盖hashcode，让他们的逻辑一致。举个例子，还是刚刚的例子，如果姓名和性别相等就算2个对象相等的话，那么hashcode的方法也要返回姓名 的hashcode值加上性别的hashcode值，这样从逻辑上，他们就一致了。 要从物理上判断2个对象是否相等，用==就可以了。

       在Java语言中，equals()和hashCode()两个函数的使用是紧密配合的，你要是自己设计其中一个，就要设计另外一个。在多数情况 下，这两个函数是不用考虑的，直接使用它们的默认设计就可以了。但是在一些情况下，这两个函数最好是自己设计，才能确保整个程序的正常运行。最常见的是当 一个对象被加入收集对象（collection object）时，这两个函数必须自己设计。更细化的定义是：如果你想将一个对象A放入另一个收集对象B里，或者使用这个对象A为查找一个元对象在收集对 象B里位置的钥匙，并支持是否容纳，删除收集对象B里的元对象这样的操作，那么，equals()和hashCode()函数必须开发者自己定义。其他情 况下，这两个函数是不需要定义的。

equals():

它是用于进行两个对象的比较的，是对象内容的比较，当然也能用于进行对象参阅值的比较。什么是对象参阅值的比较？就是两个参阅变量的值得比较，我们 都知道参阅变量的值其实就是一个数字，这个数字可以看成是鉴别不同对象的代号。两个对象参阅值的比较，就是两个数字的比较，两个代号的比较。这种比较是默 认的对象比较方式，在Object这个对象中，这种方式就已经设计好了。所以你也不用自己来重写，浪费不必要的时间。

对象内容的比较才是设计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”。

hashCode():
     这个函数返回的就是一个用来进行赫希操作的整型代号，请不要把这个代号和前面所说的参阅变量所代表的代号弄混了。后者不仅仅是个代号还具有在内存中才查找对 象的位置的功能。hashCode()所返回的值是用来分类对象在一些特定的收集对象中的位置。这些对象是HashMap, Hashtable, HashSet，等等。这个函数和上面的equals()函数必须自己设计，用来协助HashMap, Hashtable, HashSet，等等对自己所收集的大量对象进行搜寻和定位。

这些收集对象究竟如何工作的，想象每个元对象hashCode是一个箱子的 编码，按照编码，每个元对象就是根据hashCode()提供的代号归入相应的箱子里。所有的箱子加起来就是一个HashSet，HashMap，或 Hashtable对象，我们需要寻找一个元对象时，先看它的代码，就是hashCode()返回的整型值，这样我们找到它所在的箱子，然后在箱子里，每 个元对象都拿出来一个个和我们要找的对象进行对比，如果两个对象的内容相等，我们的搜寻也就结束。这种操作需要两个重要的信息，一是对象的 hashCode()，还有一个是对象内容对比的结果。

hashCode()的返回值和equals()的关系如下：

•如果x.equals(y)返回“true”，那么x和y的hashCode()必须相等。

•如果x.equals(y)返回“false”，那么x和y的hashCode()有可能相等，也有可能不等。

为什么这两个规则是这样的，原因其实很简单，拿HashSet来说吧，HashSet可以拥有一个或更多的箱子，在同一个箱子中可以有一个 或更多的独特元对象（HashSet所容纳的必须是独特的元对象）。这个例子说明一个元对象可以和其他不同的元对象拥有相同的hashCode。但是一个 元对象只能和拥有同样内容的元对象相等。所以这两个规则必须成立。

设计这两个函数所要注意到的：
如果你设计的对象类型并不使用于收集性对象，那么没有必要自己再设计这两个函数的处理方式。这是正确的面向对象设计方法，任何用户一时用不到的功能，就先不要设计，以免给日后功能扩展带来麻烦。

如果你在设计时想别出心裁，不遵守以上的两套规则，那么劝你还是不要做这样想入非非的事。我还没有遇到过哪一个开发者和我说设计这两个函数要违背前面说的两个规则，我碰到这些违反规则的情况时，都是作为设计错误处理。

当一个对象类型作为收集型对象的元对象时，这个对象应该拥有自己处理equals()，和/或处理hashCode()的设计，而且要遵守前面所说 的两种原则。equals()先要查null和是否是同一类型。查同一类型是为了避免出现ClassCastException这样的异常给丢出来。查 null是为了避免出现NullPointerException这样的异常给丢出来。

如果你的对象里面容纳的数据过多，那么这两个函数 equals()和hashCode()将会变得效率低。如果对象中拥有无法serialized的数据，equals()有可能在操作中出现错误。想象 一个对象x，它的一个整型数据是transient型（不能被serialize成二进制数据流）。然而equals()和hashCode()都有依靠 这个整型数据，那么，这个对象在serialization之前和之后，是否一样？答案是不一样。因为serialization之前的整型数据是有效的 数据，在serialization之后，这个整型数据的值并没有存储下来，再重新由二进制数据流转换成对象后，两者（对象在serialization 之前和之后）的状态已经不同了。这也是要注意的。