UDN-企业互联网技术人气社区

板块导航

浏览  : 824
回复  : 0

[讨论交流] Java 中正确使用 hashCode 和 equals 方法

[复制链接]
独领风骚的头像 楼主
发表于 2016-9-6 14:45:01 | 显示全部楼层 |阅读模式
  在这篇文章中,我将告诉大家我对hashCode和equals方法的理解。我将讨论他们的默认实现,以及如何正确的重写他们。我也将使用Apache Commons提供的工具包做一个实现。

  目录:

  hashCode()和equals()的用法

  重写默认实现

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

  需要注意记住的事情

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

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

  使用hashCode()和equals()

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

  重写默认的实现

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

  来看看这个例子,让我们创建一个简单的类Employee
  1. public class Employee
  2. {
  3.     private Integer id;
  4.     private String firstname;
  5.     private String lastName;
  6.     private String department;

  7.     public Integer getId() {
  8.         return id;
  9.     }
  10.     public void setId(Integer id) {
  11.         this.id = id;
  12.     }
  13.     public String getFirstname() {
  14.         return firstname;
  15.     }
  16.     public void setFirstname(String firstname) {
  17.         this.firstname = firstname;
  18.     }
  19.     public String getLastName() {
  20.         return lastName;
  21.     }
  22.     public void setLastName(String lastName) {
  23.         this.lastName = lastName;
  24.     }
  25.     public String getDepartment() {
  26.         return department;
  27.     }
  28.     public void setDepartment(String department) {
  29.         this.department = department;
  30.     }
  31. }
复制代码

  上面的Employee类只是有一些非常基础的属性和getter、setter.现在来考虑一个你需要比较两个employee的情形。
  1. public class EqualsTest {
  2.     public static void main(String[] args) {
  3.         Employee e1 = new Employee();
  4.         Employee e2 = new Employee();

  5.         e1.setId(100);
  6.         e2.setId(100);
  7.         //Prints false in console
  8.         System.out.println(e1.equals(e2));
  9.     }
  10. }
复制代码

  毫无疑问,上面的程序将输出false,但是,事实上上面两个对象代表的是通过一个employee。真正的商业逻辑希望我们返回true。
为了达到这个目的,我们需要重写equals方法。
  1. public boolean equals(Object o) {
  2.         if(o == null)
  3.         {
  4.             return false;
  5.         }
  6.         if (o == this)
  7.         {
  8.            return true;
  9.         }
  10.         if (getClass() != o.getClass())
  11.         {
  12.             return false;
  13.         }
  14.         Employee e = (Employee) o;
  15.         return (this.getId() == e.getId());
  16. }
复制代码

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

  So are we done?没有,让我们换一种测试方法来看看。
  1. import java.util.HashSet;
  2. import java.util.Set;

  3. public class EqualsTest
  4. {
  5.     public static void main(String[] args)
  6.     {
  7.         Employee e1 = new Employee();
  8.         Employee e2 = new Employee();

  9.         e1.setId(100);
  10.         e2.setId(100);

  11.         //Prints 'true'
  12.         System.out.println(e1.equals(e2));

  13.         Set<Employee> employees = new HashSet<Employee>();
  14.         employees.add(e1);
  15.         employees.add(e2);
  16.         //Prints two objects
  17.         System.out.println(employees);
  18.     }
复制代码

  上面的程序输出的结果是两个。如果两个employee对象equals返回true,Set中应该只存储一个对象才对,问题在哪里呢?
我们忘掉了第二个重要的方法hashCode()。就像JDK的Javadoc中所说的一样,如果重写equals()方法必须要重写hashCode()方法。我们加上下面这个方法,程序将执行正确。
  1. @Override
  2. public int hashCode()
  3. {
  4.     final int PRIME = 31;
  5.     int result = 1;
  6.     result = PRIME * result + getId();
  7.     return result;
  8. }
复制代码

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

  Apache Commons 包提供了两个非常优秀的类来生成hashCode()和equals()方法。看下面的程序。
  1. import org.apache.commons.lang3.builder.EqualsBuilder;
  2. import org.apache.commons.lang3.builder.HashCodeBuilder;
  3. public class Employee
  4. {
  5. private Integer id;
  6. private String firstname;
  7. private String lastName;
  8. private String department;
  9. public Integer getId() {
  10.     return id;
  11. }
  12. public void setId(Integer id) {
  13.     this.id = id;
  14. }
  15. public String getFirstname() {
  16.     return firstname;
  17. }
  18. public void setFirstname(String firstname) {
  19.     this.firstname = firstname;
  20. }
  21. public String getLastName() {
  22.     return lastName;
  23. }
  24. public void setLastName(String lastName) {
  25.     this.lastName = lastName;
  26. }
  27. public String getDepartment() {
  28.     return department;
  29. }
  30. public void setDepartment(String department) {
  31.     this.department = department;
  32. }
  33. @Override
  34. public int hashCode()
  35. {
  36.     final int PRIME = 31;
  37.     return new HashCodeBuilder(getId()%2==0?getId()+1:getId(), PRIME).
  38.            toHashCode();
  39. }
  40. @Override
  41. public boolean equals(Object o) {
  42.     if (o == null)
  43.        return false;
  44.     if (o == this)
  45.        return true;
  46.     if (o.getClass() != getClass())
  47.        return false;
  48.     Employee e = (Employee) o;
  49.        return new EqualsBuilder().
  50.               append(getId(), e.getId()).
  51.               isEquals();
  52.     }
  53. }
复制代码

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

  需要注意记住的事情

  • 尽量保证使用对象的同一个属性来生成hashCode()和equals()两个方法。在我们的案例中,我们使用员工id。
  • eqauls方法必须保证一致(如果对象没有被修改,equals应该返回相同的值)
  • 任何时候只要a.equals(b),那么a.hashCode()必须和b.hashCode()相等。
  • 两者必须同时重写。

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

  • 如果你使用ORM处理一些对象的话,你要确保在hashCode()和equals()对象中使用getter和setter而不是直接引用成员变量。因为在ORM中有的时候成员变量会被延时加载,这些变量只有当getter方法被调用的时候才真正可用。
  • 例如在我们的例子中,如果我们使用e1.id == e2.id则可能会出现这个问题,但是我们使用e1.getId() == e2.getId()就不会出现这个问题。

相关帖子

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

关于我们
联系我们
  • 电话:010-86393388
  • 邮件:udn@yonyou.com
  • 地址:北京市海淀区北清路68号
移动客户端下载
关注我们
  • 微信公众号:yonyouudn
  • 扫描右侧二维码关注我们
  • 专注企业互联网的技术社区
版权所有:用友网络科技股份有限公司82041 京ICP备05007539号-11 京公网网备安1101080209224 Powered by Discuz!
快速回复 返回列表 返回顶部