Java中hashCode和equals方法的正确使用

在这篇文章中，我将告诉大家我对hashCode和equals方法的理解。我将讨论他们的默认实现，以及如何正确的重写他们。我也将使用Apache Commons提供的工具包做一个实现。

目录：

1.hashCode()和equals()的用法

2.重写默认实现

3.使用Apache Commons Lang包重写hashCode()和equals()

4.需要注意记住的事情

5.当使用ORM的时候特别要注意的

hashCode()和equals()定义在Object类中，这个类是所有java类的基类，所以所有的java类都继承这两个方法。

使用hashCode()和equals()

hashCode()方法被用来获取给定对象的唯一整数。这个整数被用来确定对象被存储在HashTable类似的结构中的位置。默认的，Object类的hashCode()方法返回这个对象存储的内存地址的编号。

重写默认的实现

如果你不重写这两个方法，将几乎不遇到任何问题，但是有的时候程序要求我们必须改变一些对象的默认实现。

来看看这个例子，让我们创建一个简单的类Employee

1. publicclassEmployee
2. {
3. privateIntegerid;
4. privateStringfirstname;
5. privateStringlastName;
6. privateStringdepartment;
8. publicIntegergetId(){
9. returnid;
10. }
11. publicvoidsetId(Integerid){
12. this.id=id;
13. }
14. publicStringgetFirstname(){
15. returnfirstname;
16. }
17. publicvoidsetFirstname(Stringfirstname){
18. this.firstname=firstname;
19. }
20. publicStringgetLastName(){
21. returnlastName;
22. }
23. publicvoidsetLastName(StringlastName){
24. this.lastName=lastName;
25. }
26. publicStringgetDepartment(){
27. returndepartment;
28. }
29. publicvoidsetDepartment(Stringdepartment){
30. this.department=department;
31. }
32. }

上面的Employee类只是有一些非常基础的属性和getter、setter.现在来考虑一个你需要比较两个employee的情形。

1. publicclassEqualsTest{
2. publicstaticvoidmain(String[]args){
3. Employeee1=newEmployee();
4. Employeee2=newEmployee();
6. e1.setId(100);
7. e2.setId(100);
8. //Printsfalseinconsole
9. System.out.println(e1.equals(e2));
10. }
11. }

毫无疑问，上面的程序将输出false，但是，事实上上面两个对象代表的是通过一个employee。真正的商业逻辑希望我们返回true。
为了达到这个目的，我们需要重写equals方法。

1. publicbooleanequals(Objecto){
2. if(o==null)
3. {
4. returnfalse;
5. }
6. if(o==this)
7. {
8. returntrue;
9. }
10. if(getClass()!=o.getClass())
11. {
12. returnfalse;
13. }
14. Employeee=(Employee)o;
15. return(this.getId()==e.getId());
16. }

在上面的类中添加这个方法，EauqlsTest将会输出true。

So are we done?没有，让我们换一种测试方法来看看。

1. importjava.util.HashSet;
2. importjava.util.Set;
4. publicclassEqualsTest
5. {
6. publicstaticvoidmain(String[]args)
7. {
8. Employeee1=newEmployee();
9. Employeee2=newEmployee();
11. e1.setId(100);
12. e2.setId(100);
14. //Prints'true'
15. System.out.println(e1.equals(e2));
17. Set<Employee>employees=newHashSet<Employee>();
18. employees.add(e1);
19. employees.add(e2);
20. //Printstwoobjects
21. System.out.println(employees);
22. }

上面的程序输出的结果是两个。如果两个employee对象equals返回true，Set中应该只存储一个对象才对，问题在哪里呢？

我们忘掉了第二个重要的方法hashCode()。就像JDK的Javadoc中所说的一样，如果重写equals()方法必须要重写hashCode()方法。我们加上下面这个方法，程序将执行正确。

1. @Override
2. publicinthashCode()
3. {
4. finalintPRIME=31;
5. intresult=1;
6. result=PRIME*result+getId();
7. returnresult;
8. }

使用Apache Commons Lang包重写hashCode() 和equals()方法

Apache Commons 包提供了两个非常优秀的类来生成hashCode()和equals()方法。看下面的程序。

1. importorg.apache.commons.lang3.builder.EqualsBuilder;
2. importorg.apache.commons.lang3.builder.HashCodeBuilder;
3. publicclassEmployee
4. {
5. privateIntegerid;
6. privateStringfirstname;
7. privateStringlastName;
8. privateStringdepartment;
9. publicIntegergetId(){
10. returnid;
11. }
12. publicvoidsetId(Integerid){
13. this.id=id;
14. }
15. publicStringgetFirstname(){
16. returnfirstname;
17. }
18. publicvoidsetFirstname(Stringfirstname){
19. this.firstname=firstname;
20. }
21. publicStringgetLastName(){
22. returnlastName;
23. }
24. publicvoidsetLastName(StringlastName){
25. this.lastName=lastName;
26. }
27. publicStringgetDepartment(){
28. returndepartment;
29. }
30. publicvoidsetDepartment(Stringdepartment){
31. this.department=department;
32. }
33. @Override
34. publicinthashCode()
35. {
36. finalintPRIME=31;
37. returnnewHashCodeBuilder(getId()%2==0?getId()+1:getId(),PRIME).
38. toHashCode();
39. }
40. @Override
41. publicbooleanequals(Objecto){
42. if(o==null)
43. returnfalse;
44. if(o==this)
45. returntrue;
46. if(o.getClass()!=getClass())
47. returnfalse;
48. Employeee=(Employee)o;
49. returnnewEqualsBuilder().
50. append(getId(),e.getId()).
51. isEquals();
52. }
53. }

如果你使用Eclipse或者其他的IDE，IDE也可能会提供生成良好的hashCode()方法和equals()方法。

需要注意记住的事情

1.尽量保证使用对象的同一个属性来生成hashCode()和equals()两个方法。在我们的案例中,我们使用员工id。

2.eqauls方法必须保证一致（如果对象没有被修改，equals应该返回相同的值）

3.任何时候只要a.equals(b),那么a.hashCode()必须和b.hashCode()相等。

4.两者必须同时重写。

当使用ORM的时候特别要注意的

1.如果你使用ORM处理一些对象的话，你要确保在hashCode()和equals()对象中使用getter和setter而不是直接引用成员变量。因为在ORM中有的时候成员变量会被延时加载，这些变量只有当getter方法被调用的时候才真正可用。

2.例如在我们的例子中，如果我们使用e1.id == e2.id则可能会出现这个问题，但是我们使用e1.getId() == e2.getId()就不会出现这个问题。

原文链接：http://www.oschina.net/question/82993_75533