43
回答
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

public class Employee
{
    private Integer id;
    private String firstname;
    private String lastName;
    private String department;

    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getFirstname() {
        return firstname;
    }
    public void setFirstname(String firstname) {
        this.firstname = firstname;
    }
    public String getLastName() {
        return lastName;
    }
    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
    public String getDepartment() {
        return department;
    }
    public void setDepartment(String department) {
        this.department = department;
    }
}
上面的Employee类只是有一些非常基础的属性和getter、setter.现在来考虑一个你需要比较两个employee的情形。


public class EqualsTest {
    public static void main(String[] args) {
        Employee e1 = new Employee();
        Employee e2 = new Employee();

        e1.setId(100);
        e2.setId(100);
        //Prints false in console
        System.out.println(e1.equals(e2));
    }
}
毫无疑问,上面的程序将输出false,但是,事实上上面两个对象代表的是通过一个employee。真正的商业逻辑希望我们返回true。
为了达到这个目的,我们需要重写equals方法。
public boolean equals(Object o) {
        if(o == null)
        {
            return false;
        }
        if (o == this)
        {
           return true;
        }
        if (getClass() != o.getClass())
        {
            return false;
        }
        Employee e = (Employee) o;
        return (this.getId() == e.getId());
}
在上面的类中添加这个方法,EauqlsTest将会输出true。
So are we done?没有,让我们换一种测试方法来看看。
import java.util.HashSet;
import java.util.Set;

public class EqualsTest
{
    public static void main(String[] args)
    {
        Employee e1 = new Employee();
        Employee e2 = new Employee();

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

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

        Set<Employee> employees = new HashSet<Employee>();
        employees.add(e1);
        employees.add(e2);
        //Prints two objects
        System.out.println(employees);
    }
上面的程序输出的结果是两个。如果两个employee对象equals返回true,Set中应该只存储一个对象才对,问题在哪里呢?
我们忘掉了第二个重要的方法hashCode()。就像JDK的Javadoc中所说的一样,如果重写equals()方法必须要重写hashCode()方法。我们加上下面这个方法,程序将执行正确。
@Override
 public int hashCode()
 {
    final int PRIME = 31;
    int result = 1;
    result = PRIME * result + getId();
    return result;
 }
使用Apache Commons Lang包重写hashCode() 和equals()方法
Apache Commons 包提供了两个非常优秀的类来生成hashCode()和equals()方法。看下面的程序。


import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
public class Employee
{
 private Integer id;
 private String firstname;
 private String lastName;
 private String department;
public Integer getId() {
    return id;
 }
 public void setId(Integer id) {
    this.id = id;
 }
 public String getFirstname() {
    return firstname;
 }
 public void setFirstname(String firstname) {
    this.firstname = firstname;
 }
 public String getLastName() {
    return lastName;
 }
 public void setLastName(String lastName) {
    this.lastName = lastName;
 }
 public String getDepartment() {
    return department;
 }
 public void setDepartment(String department) {
    this.department = department;
 }
@Override
 public int hashCode()
 {
    final int PRIME = 31;
    return new HashCodeBuilder(getId()%2==0?getId()+1:getId(), PRIME).
           toHashCode();
 }
@Override
 public boolean equals(Object o) {
    if (o == null)
       return false;
    if (o == this)
       return true;
    if (o.getClass() != getClass())
       return false;
    Employee e = (Employee) o;
       return new EqualsBuilder().
              append(getId(), e.getId()).
              isEquals();
    }
 }
如果你使用Eclipse或者其他的IDE,IDE也可能会提供生成良好的hashCode()方法和equals()方法。

需要注意记住的事情

  • 尽量保证使用对象的同一个属性来生成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()就不会出现这个问题。
希望这篇文章能够帮助你。


原文链接/OSCHINA翻译



举报
王振威
发帖于5年前 43回/60K+阅
共有43个评论 最后回答: 3个月前
不明白java的设计者为啥要搞出个hashCode()方法,一个equals()不是足够了吗?
--- 共有 4 条评论 ---
xpbughash散列算法,使得在hash表中查找一个记录速度变O(1). 每个记录都有自己的hashcode,散列算法按照hashcode把记录放置在合适的位置. 在查找一个记录,首先先通过hashcode快速定位记录的位置.然后再通过equals来比较是否相等. 没有hashcode,一个一个比较过来,时间就变O(N)了. 不知道说清楚了没? 也可以参照Index. 5年前 回复
Railgun回复 @喜之郎 : 但是从机器的角度来说,相同的内容在内存中只有一份才是最优设计吧 5年前 回复
喜之郎回复 @JekyCui : 我想问设计者为不让这些类调用equals不是同样能比较相等吗? 上面说覆写了equals就必须覆写hashCode,那不是意味着,若人为定义两对象相等,则其内存地址也让其相等,这显然不符合人的常规思维。从人的常规思维来说,两个对象定义为相等,其内存地址可以不等,也可以相等。 5年前 回复
JekyhashCode()是HashTable、HashMap和HashSet使用的 5年前 回复

引用来自“喜之郎”的答案

不明白java的设计者为啥要搞出个hashCode()方法,一个equals()不是足够了吗?

hash code跟内存没有关系,只不过是Object的默认hashCode()方法会返回一个内存编号,因为这样一定满足hashCode()方法的要求。

hashCode()方法要求:

当对象状态未改变,那么多次调用返回的值必须相等
两个对象equal,那么对象调用返回的值必须相等

你说的那个人的常规思维是认为hash code跟内存相关联,实际上不是,你可以理解为一个数字标识当前对象状态

--- 共有 3 条评论 ---
喜之郎回复 @唐明星 : 学习了。 5年前 回复
小宏的爹回复 @喜之郎 : 一个set有一万个元素,再加入一个不同的新元素,则需要执行一万次的equal方法,这个效率太低了。所以采用先比较hashcode,由于是64位整数,可以建立索引查找。如果hashcode没找到,则必定不equal,加入set当中;即使找到了,也只需执行hashcode相同的几个元素的equal。这是一种性能设计。 5年前 回复
喜之郎那人为什么要关心“对象的状态是否改变”呢? 5年前 回复

引用来自“JekyCui”的答案

引用来自“喜之郎”的答案

不明白java的设计者为啥要搞出个hashCode()方法,一个equals()不是足够了吗?

hash code跟内存没有关系,只不过是Object的默认hashCode()方法会返回一个内存编号,因为这样一定满足hashCode()方法的要求。

hashCode()方法要求:

当对象状态未改变,那么多次调用返回的值必须相等
两个对象equal,那么对象调用返回的值必须相等

你说的那个人的常规思维是认为hash code跟内存相关联,实际上不是,你可以理解为一个数字标识当前对象状态

应当是同一个对象要确保hashcode不变吧 

The value returned by hashCode is an int that maps an object into a bucket in a hash table.

An object must always produce the same hash code. However, objects can share hash codes
(they aren’t necessarily unique). Writing a “correct” hashing function is easy—always return
the same hash code for the same object. Writing an “efficient” hashing function—one that
provides a sufficient distribution of objects over the buckets—is difficult and is outside the
scope of this book.

--- 共有 2 条评论 ---
Jeky回复 @bugfiller : 讨论嘛..另外如果同一个对象要保持hash code一致,显然使用最原始的object的地址码最好,就不用覆盖了 5年前 回复
享开发@JekyCui 你说的对 我说错了 不好意思 我又查了些资料 我错大了 5年前 回复
equals方法的使用者是我们,而hashcode方法是jdk(如往list中插入值,会根据code决定顺序,这是equals方法无法代替的)。整体来说,equals相等,那么hashcode必须一样。而hashcode一样,equals不一定一样。
--- 共有 2 条评论 ---
夕水溪下@喜之郎 个人拙见,hashcode就像是对象的标识码,可以根据对象的属性计算而出。 5年前 回复
喜之郎让equals返回int的-1,0,1就行啊。 5年前 回复

手痒,弄上String的equals源码

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

顶部