如何重寫Java中的equals方法

 

   Java中,只有8種基本類型不是對象,例如:4種整形類型(byte, short, int,long),2種浮點類型(flout, double),boolean, char不是對象,其他的所有類型,不論是對象數組,列表等都擴展了Object類.了解學習Object中方法的設計原理和實現方式有助於更好的學習理解java語言.下面,我們首先學習一下Object中的equals方法. 判斷兩個對象相等時,JVM首先查找兩個對象的hashCode, 如果兩者hashCode不同,則返回false;如果兩者的hashCode相同,則調用equals方法進行比較.

Object中equals方法

   Object中的equals方法用於檢測一個對象是否等於另外一個對象. Object類中,判斷兩個對象是否引用同一個對象實現equals方法,源碼如下:

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

    實際處理中,若要比較兩個對象是否相等,一般需要重寫equals方法.

 

例1:雇員對象比較

如果兩個雇員對象的姓名, 薪水和雇佣一樣,就認為它們相等.重寫equals方法如下:

 
          public  
          class Employee { 
          
 
          
     
          private String name; 
          
     
          private  
          double salary; 
          
     
          private Date hireDay; 
         

    ...

    @Override
    public boolean equals(Object obj) {
        // 如果為同一對象的不同引用,則相同
        if (this == obj) {
            return true;
        }
        // 如果傳入的對象為空,則返回false
        if (obj == null) {
            return false;
        }

        // 如果兩者屬於不同的類型,不能相等
        if (getClass() != obj.getClass()) {
            return false;
        }

        // 類型相同, 比較內容是否相同
        Employee other = (Employee) obj;

        return Objects.equals(name, other.name) && salary == other.salary && Objects.equals(hireDay, other.hireDay);
    }
}

 

 

  注意,比較通過Objects中靜態函數equals比較兩個對象是否相等.該方法源碼如下:

             
          public  
          static  
          boolean equals(Object a, Object b) { 
          
         
          return (a == b) || (a !=  
          null && a.equals(b)); 
          
    } 
         

 這樣,當兩個對象都為null時,返回true,例如,兩個Employee對象的name都為null, 返回true; 如果第一個對象不為null,則調用a.equals(Object obj)方法

 

對象比較與繼承

   如果隱式和顯式的對象所屬類型不一致,equals方法該如何處理呢?在例1中,如果兩個對象的類型不一致,直接返回false;多數程序員直接使用instanceof檢測:

if(!(obj  instanceof Employee))  return  false;

 這樣做不但沒有解決繼承子類的錯誤,還可能引發其他的一些錯誤,例1中,采用強制類型轉換的方式.

 要實現子類對象比較,先了解一下java規范中對equals方法的約束.

java規范中equals方法特征

• 自反性

對於任何非空引用x, x.equals(x) 返回true;

• 對稱性

對於任何引用x, y, 當且僅當y.equals(x) 返回true, x.equals(y)返回true;

• 傳遞性

對於任何引用x, y, z, 若x.equals(y)返回true, y.equals(z)返回true; 則 x.equals(z)返回true;

• 一致性

若x和y引用的對象沒有發生改變, 則反復調用x.equals(y)應該返回同樣的結果.

• 對任意非空引用x, x.equals(null) 返回false;

 下面可以通過兩個不同的情況看待這個問題:

• 如果子類能夠擁有自己的相等概念, 則對稱性需求強制采用getClass進行檢測

• 如果由超類決定相等的概念, 那么就用instanceof進行檢測,這樣可以在不用子類的對象之間進行相等的比較

 注釋:

1. 在標准的java庫中包含150多個equals方法的實現,包括instanceof檢測, 調用getClass檢測, 捕獲ClassCastException檢測或者什么都不做. 在java.sql.TimeStamp實現人員指出, Timestamp類繼承Date類,而后者的equals方法使用了一個instanceof檢測,這樣重寫equals方法時,就無法同時做到對稱性.
2. 在由超類決定相等時,可以考慮final關鍵字修改比較函數,若考慮到子類equals方法靈活性,可以不加修飾,例如AbstractSet.equals方法,應該申明為final, 這樣就可以比較子類HashSet和TreeSet, 但是考慮到子類的靈活性,沒有添加任何修飾.

編寫equals方法的建議:

1. 顯示參數命名為otherObject, 稍后轉化成other變量
   public  boolean equals(Object otherObject)
2. 檢測this和otherObject是否是同一個對象的引用,是,返回true;

    
               if( 
               this==otherObject){ 
               
        
               return  
               true; 
               
   } 
              

3. 檢測otherObject是否為null, 是, 返回false;

    
               if(otherObject ==  
               null){ 
               
        
               return  
               false; 
               
   } 
              

4. 比較this和otherObject是否屬於同一個類. 如果equals的語義在每個子類中有所改變,就使用getClass檢測:

    
               if(getClass() != otherObject.getClass()){ 
               
        
               return  
               false; 
               
   } 
              

   如果所以子類語義相同,使用instanceof檢測:

    
               if(!(otherObject  
               instanceof Employee)){ 
               
        
               return  
               false; 
               
   } 
              

5. 將otherObject轉化為相對應的類型變量other
   Employee other = (Employee)otherObject;
6. 對所需要的比較的數據域進行比較. 如果是基本數據類型,使用a==b比較; 如果是對象比較,調用Objects.equals(a, b)進行比較
   return Objects.equals(name, other.name) && salary == other.salary && Objects.equals(hireDay, other.hireDay);

整個流程可以參照例1;

常見equals方法實現錯誤

 
          public  
          class Employee { 
          
     
          public  
          boolean equals(Employee other) { 
          
 
          
 
          
     
          return Objects.equals(name, other.name) && salary ==other.salary && Objects.equals(hireDay, other.hireDay); 
          
} 
         

 

這個方法聲明的顯示參數類型是Employee. 其結果並沒有覆蓋Object中的equals方法,而是定義了一個完全無關的方法.為了避免發生類型錯誤,可以使用@override對覆蓋超類的方法進行標記.