Effective Java 对于所用对象都通用的方法 9.覆盖equals时总要覆盖hashCode

时间:2022-12-12 16:02:58
相信在使用快捷键覆盖equals方法时,总会伴随着hashCode,很多初学者不知道equals跟hashCode在实体类中的作用,我初学时也不知道。使用的比较多的就是字符串调用equals方法,但是跟实体类中的equals方法没有半毛钱关系。


正是因为覆盖equals方法时,会覆盖hashCode,所以就没有遇到过其中的错误。


每个覆盖了equals方法的类中,也必须覆盖hashCode方法。这属于乌龟的屁股--规定 


如果不这样的话,就会违反Object.hashCode的通用约定,从而导致该类无法结合所有基于散列的集合一起正常运作,这样的集合包括HashMap、HashSet和Hashtable。


Object.hashCode的通用约定


在应用程序的执行期间,只要对象的equals方法的比较操作所用到的信息没有被修改,那么对这同一个对象调用多次,hashCode方法都必须始终如一的返回同一个整数。在一个应用程序的多次执行过程中,每次执行所返回的整数可以不一致。 


如果两个对象根据equals方法比较是相等的,那么调用这两个对象中任意一个对象的hashCode方法都必须产生同样的整数结果。 


如果两个对象根据equals方法比较是不相等的,那么调用这两个对象中任意一个对象的hashCode方法,则不一定要产生不同的整数结果。但是程序员应该知道,给不相等的对象产生截然不同的整数结果,有可能提高散列表(hash table)的性能。


  
import java.util.*;  
  
public final class PhoneNumber {  
    private final short areaCode;  
    private final short prefix;  
    private final short lineNumber;  
  
    public PhoneNumber(int areaCode, int prefix,  
                       int lineNumber) {  
        rangeCheck(areaCode,    999, "area code");  
        rangeCheck(prefix,      999, "prefix");  
        rangeCheck(lineNumber, 9999, "line number");  
        this.areaCode  = (short) areaCode;  
        this.prefix  = (short) prefix;  
        this.lineNumber = (short) lineNumber;  
    }  
  
    private static void rangeCheck(int arg, int max,  
                                   String name) {  
        if (arg < 0 || arg > max)  
           throw new IllegalArgumentException(name +": " + arg);  
    }  
  
    @Override public boolean equals(Object o) {  
        if (o == this)  
            return true;  
        if (!(o instanceof PhoneNumber))  
            return false;  
        PhoneNumber pn = (PhoneNumber)o;  
        return pn.lineNumber == lineNumber  
            && pn.prefix  == prefix  
            && pn.areaCode  == areaCode;  
    }  
  
 假设你将这个类与hashCode一起使用。
  
 
        Map<PhoneNumber, String> m  
            = new HashMap<PhoneNumber, String>();  
        m.put(new PhoneNumber(707, 867, 5309), "Jenny");  

这个时候我们期望m.get(new PhoneNumber(707, 867, 5309))的结果是Jenny,然而事实上却是null;
这里有俩个PhoneNumber实例:
第一个实例:用于被插入到hashMap中。
第二个实例:跟第一个实例相等,被用于获取。
由于PhoneNumber类没有覆盖hashCode的方法,从而导致两个相等的实例具有不相等的散列码,违反了hashCode的约定。因此,put方法吧电话号码对象存放在一个散列桶(hash bucket)中,get方法却在另一个散列桶中查找这个电话号码,即使这俩个实例都在同一个散列桶中,get方法也会返回null,因为HashMap有一项优化,可以将每个项相关联的散列码缓存起来,如果散列码不匹配,也就不必校验对象的等同性。


修正这个问题就是覆盖HashCode即可。


@Override public int hashCode(){return 42;}


这个方法是没有问题的,它确保了相等的对象总是返回相同的散列码,但他也是极为恶劣的,它使得每个对象都具有相同的散列码。