解析java中对equals和hashCode方法的约定

JDK的java.lang.Object类中实现了equals函数，其定义说明如下：

写道

public boolean equals(Object obj)
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
[list=5]

It is reflexive: for any non-null reference value x, x.equals(x) should return true.

It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.

It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.

For any non-null reference value x, x.equals(null) should return false.
[/list]
The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

 其具体的实现代码如下所示：

写道

public boolean equals(Object obj) {
return (this == obj);
}

 从上面的代码中可以看出，Object类的equals实现只是简单地调用了“==”运算符，也即定义中说明的，对于两个非空对象X和Y，有且仅当X和Y 指向同一个对象时该函数才返回true。由于Object类是java中所有类的超类，因而其它任何类都默认继承了此函数。在大多数情况下，此默认的实现 方式是合适的，因为任一个类本质上都是唯一的；但是对于那些表示“值”的类(如Integer、String等)，它们引入了自己特有的“逻辑相等”的概 念，此时就必须修改equals函数的实现。
例如java.lang.String类的实现如下：

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

而java.lang.Integer类的实现如下： 

public boolean equals(Object obj) {
    if (obj instanceof Integer) {
        return value == ((Integer)obj).intValue();
    }
    return false;
    }

      String类的equals实现使得当两个String对象所表示的字符串的值是一样的时候就能返回true；而Integer类则当两个Integer对象所持有的整数值是一样的时候就能返回true。 
      因此，当我们我们自己编写的类需要引入“逻辑相等”的概念，且其超类又没有改写equals的实现时，我们就必须实现自己的equals函数。在上面Object类中关于equals函数的说明中，定义了5条改写equals函数所必须遵守的规范。其中第1条自反性(reflexivity)和第5条通常能够自行满足。下面我们重点介绍下第2点对称性(symmetric)、第3点传递性(transitive)和第4点一致性(consistent)。 
      对称性 
即对于任意两个引用值X和Y，X.equals(Y) 和 Y.equals(X) 返回的结果必须是一致的。下面引用《effect java》上的例子来说明了违反这一特性的后果：

public class CaseInsensitiveString {

    private String s;

    public boolean equals(Object obj){
        if(obj instanceof CaseInsensitiveString)
            return s.equalsIgnoreCase(((CaseInsensitiveString)obj).s);
        if(obj instanceof String)
            return s.equalsIgnoreCase((String)obj);
        return false;
    }
}

然后我们定义如下的类来进行测试：

public void test(){
    CaseInsensitiveString cis = new CaseInsensitiveString("Value");
    String s = "Value";
    List list = new ArrayList();
    list.add(cis);
    System.out.println(cis.equals(s));
    System.out.println(s.equals(cis));
    System.out.println(list.contains(s));
}

 

运行test(),第一条语句的输出为true，而后两条为false。因为CaseInsensitiveString类中equals函数对String对象的比较也可能返回true，只要其大小写不敏感的字符串值相等；而在String类中对任何非String对象都返回false，这样CaseInsensitiveString的实现就违反了对称性，从而导致了第三条语句也返回了意想不到的结果false。这是因为ArrayList的contains函数实现是用实参s对list中每一个对象调用equals函数，若有equals函数返回true，则contains返回true；因而在这里contains函数必然返回false。因此，如果违反了对称性，则可能会得到意料之外的结果。解决此问题的一个办法就是在CaseInsensitiveString类的equals函数中对Stirng对象的比较无论值是否一致都返回false。

传递性 
即对于任意的引用值X、Y和Z，如果 X.equals(Y) 和 Y.equals(Z) 都返回true，则 X.equals(Z) 也一定返回true。下面举例说明： 

 public class Point {
    private final int x;

    private final int y;

    public Point(int x, int y) {
        this.x = x;
        this.y = y;
    }

    public boolean equals(Object obj) {
        if (!(obj instanceof Point))
            return false;
        Point p = (Point) obj;
        return p.x == x && p.y == y;
    }
}

public class ColorPoint extends Point {

    private int z;

    public ColorPoint(int x, int y, int z) {
        super(x, y);
        this.z = z;
    }

    public boolean equals(Object obj) {
        if (!(obj instanceof Point))
            return false;
        if(obj instanceof ColorPoint){
		ColorPoint cp = (ColorPoint) obj;
 		return super.equals(obj) && cp.z == this.z;
	}else{
		Point cp = (Point) obj;
		return super.equals(obj);
	}

    }
}

在上面的代码中定义了类Point及其子类ColorPoint，并分别改写了equals函数。下面运行如下代码来测试：

ColorPoint cp1 = new ColorPoint(1,2,3);
ColorPoint cp2 = new ColorPoint(1,2,4);
Point p = new Point(1,2);
System.out.println(cp1.equals(p));
System.out.println(p.equals(cp2));
System.out.println(cp1.equals(cp2));

结果前两条语句输出“true”，而最后一条语句输出为“false”；从而违反了传递性规范。其主要原因是在基类的equals函数中并未对子类加以区分，从而使得基类与子类之间的比较也能返回true。要解决此方法，《effect java》上提供了“复合代替继承”的方法；另外，如果可以将基类和子类视为不等的话，使用 getClass()函数代替 instanceof 运算符进行比较可以很好的解决这一问题。getClass()会返回此对象的运行期类(runtime class)，因为基类和子类属于不同的class，getClass()能够将其区分开来。下面是一段示例的代码：

public boolean equals(Object obj) {
        if(obj.getClass() != this.getClass())
            return false;
        Point p = (Point) obj;
        return p.x == x && p.y == y;

    }

      一致性 
即如果两个对象相等的话，那么它们必须始终保持相等，除非至少有一个对象被修改了。 

在Object类equals函数的说明中的最后一段提到当我们改写equals函数的时候，通常都需要改写hashCode函数，后者同样在Object类中进行了定义，如下：

引用

public int hashCode() 
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. 
The general contract of hashCode is: 
[list=3]

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.

If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.

It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

[/list] 
As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.) 

hashCode()函数返回一个对象的散列值(hash code)，在java中有些集合类都是基于散列值的，如HashMap、HashSet、Hashtable等；它们都根据对象的散列值将其映射到相应的散列桶中。如Hashtable的put和get函数的实现如下所示：

  public synchronized V get(Object key) {
Entry tab[] = table;
int hash = key.hashCode();
int index = (hash & 0x7FFFFFFF) % tab.length;
for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) {
    if ((e.hash == hash) && e.key.equals(key)) {
    return e.value;
    }
}
return null;
   }

ublic synchronized V put(K key, V value) {
// Make sure the value is not null
if (value == null) {
    throw new NullPointerException();
}

// Makes sure the key is not already in the hashtable.
Entry tab[] = table;
int hash = key.hashCode();
int index = (hash & 0x7FFFFFFF) % tab.length;
for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) {
    if ((e.hash == hash) && e.key.equals(key)) {
    V old = e.value;
    e.value = value;
    return old;
    }
}

modCount++;
if (count >= threshold) {
    // Rehash the table if the threshold is exceeded
    rehash();

           tab = table;
           index = (hash & 0x7FFFFFFF) % tab.length;
}

// Creates the new entry.
Entry<K,V> e = tab[index];
tab[index] = new Entry<K,V>(hash, key, value, e);
count++;
return null;
   }

因而hashCode函数极大地影响了这些集合类的正常工作。如果在改写完equals函数后，不相应改写hashCode函数，则可能会得不到想要的结果。如下例所示：

Point p1 = new Point(1, 2);
Point p2 = new Point(1, 2);
Hashtable<Point, String> ht = new Hashtable<Point, String>();
ht.put(p1, "value");
System.out.println(p1.equals(p2));
System.out.println(ht.get(p2));

 

由上面Point类的实现，p1和p2是相等的，第一个语句正常输出true；但是第二个语句输出的值是null，并没有得到期望中的“value”。导致这一问题的根本原因是Point类改写了equals函数，对相等的概念作了更改，但没有相应更改hashCode函数，使得两个相等的函数拥有不同的hashCode，违反了Object类关于hashCode的约定中的第2点，从而返回了错误的结果。 
在Object类中定义的几个hashCode约定如下： 
1. 在同一应用中，一个对象的hashCode函数在equals函数没有更改的情况下，无论调用多少次，它都必须返回同一个整数。 
2. 两个对象如果调用equals函数是相等的话，那么调用hashCode函数一定会返回相同的整数。 
3. 两个对象如果调用equals函数是不相等的话，那么调用hashCode函数不要求一定返回不同的整数。 
我们在改写equals 和 hashCode 函数的时候，一定要遵守如上3条约定，在改写equals的同时也改写hashCode的实现，这样才能保证得到正确的结果。