一、介紹
通過如何建立和銷燬物件一文，我們已經知道Java是一個面向物件的程式語言，Java類層次結構的頂部是Object類，Java中每個單獨的類都隱式的繼承於該類。因此，所有的類都繼承了在Object類中定義的一系列方法，這其中的一些非常重要的方法如下：

本文我們只介紹equals,hashCode,toString和clone方法的使用，其他的方法我們將會在後續的多執行緒最佳實戰的文章中細說。

二、equals和hashCode方法

預設情況下，Java中的任何兩個物件引用（或類例項引用）只有在引用相同的記憶體位置（引用相等）的情況下才是相等的。但是Java允許類通過覆蓋（overriding）Object類的equals()方法定義自己的相等規則。這聽起來是很強大的概念，然而正確的equals()方法實現應該符合一些規則和滿足以下的一些限制：

• 自反性 Reflexive：物件x必須等於它自己並且x.equals(x)必須返回true；

• 對稱性 Symmetric：如果x.equals(y)返回true，那麼y.equals(x)也必須返回true；

• 傳遞性 Transtive：如果x.equals(y)返回true並且y.equals(z)返回true，那麼x.equals(z)也必須返回true；

• 一致性 Consistent：equals方法的多次呼叫必須返回相同的結果值，除非用於相等比較的屬性被改變；

• 和Null比較：任何非null x，x.equals(null)返回false；

不幸的是，Java編譯器在編譯處理過程中不能強制這些限制。然而，不遵守這些規則將會導致非常奇怪和難以解決的問題。一般我們建議：如果你需要寫你自己的equals()方法實現，請再三思考是否你真的需要實現個性化的equals()方法；現在，根據這些規則，讓我們為Person類寫一個簡單的equals()方法實現。

package javaTec;

public class Person {
    private final String firstName;
    private final String lastName;
    private final String email;

    public Person(final String firstName, final String lastName, final String email) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.email = email;
    }

    public String getEmail() {
        return email;
    }

    public String getFirstName() {
        return firstName;
    }

    public String getLastName() {
        return lastName;
    }

    /**
     * @Comment Step 0：新增@Override註解，這能夠確保你的意圖是修改預設實現
     * @Author Ron
     * @Date 2018年1月2日 下午4:41:39
     * @return
     */
    @Override
    public boolean equals(Object obj) {
        // Step 1: 檢查obj是否為null
        if (obj == null) {
            return false;
        }

        // Step 2: 檢查obj是否指向當前例項
        if (this == obj) {
            return true;
        }

        // Step 3: 檢查類相等。請注意這裡：不要使用'instanceof'關鍵字，除非類被定義為final。因為它可能會導致一些類層次上的問題。
        if (getClass() != obj.getClass()) {
            return false;
        }

        // Step 4: 檢查單獨的欄位是否相等
        final Person other = (Person) obj;
        if (email == null) {
            if (other.email != null) {
                return false;
            }
        } else if (!email.equals(other.email)) {
            return false;
        }
        if (firstName == null) {
            if (other.firstName != null) {
                return false;
            }
        } else if (!firstName.equals(other.firstName)) {
            return false;
        }
        if (lastName == null) {
            if (other.lastName != null) {
                return false;
            }
        } else if (!lastName.equals(other.lastName)) {
            return false;
        }
        return true;
    }
}

在本節我們包含了hashCode()方法在我們的標題中，這並不是偶然。最後但同樣重要且需要記住的規則就是：當你覆蓋了equals()方法的時候，一般也是需要覆蓋hashCode()方法。如果對於任意兩個物件來說equals()方法返回true，然後這兩個物件中任意一個物件的hashCode()方法所返回的是相同的整數值（然而相反的情況就並沒有那麼嚴格的要求：如果對於任意兩個物件來說equals()方法返回false，然後這兩個物件中任意一個物件的hashCode()方法所返回的整數值有可能相同也有可能不同）。讓我們為Person類覆蓋一個hashCode()方法。

/**
* @Comment 新增@Override註解，這能夠確保你的意圖是修改預設實現
* @Author Ron
* @Date 2018年1月2日 下午6:06:40
* @return
*/
@Override
public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + ( ( email == null ) ? 0 : email.hashCode() );
    result = prime * result + ( ( firstName == null ) ? 0 : firstName.hashCode() );
    result = prime * result + ( ( lastName == null ) ? 0 : lastName.hashCode() );
    return result;
}

為了避免一些意外情況的發生，在實現equals()方法和hashCode()方法時儘量使用final欄位。這樣會保證方法的操作不會受欄位值變化的影響（然而，在現實專案中這幾乎是不可能）。

最後，在實現equals()方法和hashCode()方法時一定要確認相同的欄位已經被使用過，這樣一旦遇到任何影響到欄位的變化問題，才能保證兩個方法的一致性操作。

三、toString方法

toString()方法相對其他方法來看可以說是最有趣的了，它正在被更頻繁地覆蓋。該方法的主要意圖就是提供物件（類例項）的字串表示方式。正確編寫的toString()方法可以大大簡化現實系統中除錯和故障排除的過程。

在大多數情況下toString()的預設實現並沒有太大的用處並且它僅僅只是返回一個全類名和物件的hash code，由’@’符號分割，例如：

com.javacodegeeks.advanced.objects.Person@6104e2ee

讓我們嘗試一下為Person類重寫一個toString()方法改善toString()方法的實現。這是讓toString()方法發揮作用的一種方式。

/**
* @Comment 新增@Override註解，這能夠確保你的意圖是修改預設實現
* @Author Ron
* @Date 2018年1月3日 上午11:49:16
* @return
*/
@Override
public String toString() {
    return String.format( "%s[email=%s, first name=%s, last name=%s]",
    getClass().getSimpleName(), email, firstName, lastName );
}

現在，Person類的toString()方法就提供了Person類例項的包含所有欄位的字串版本。例如，當執行如下程式碼段時：

final Person person = new Person( "John", "Smith", "[email protected]" );
System.out.println( person.toString() );

將會輸出如下結果：

Person[[email protected], first name=John, last name=Smith]

不幸的是，標準Java庫對簡化toString()方法實現的支援有限，很明顯，大多數有用的方法都是Objects.toString()、Arrays.toString()/ Arrays.deepToString()。讓我們來看一下Office類和它的一個可能的toString()方法實現。

package javaTec;

import java.util.Arrays;

public class Office {
    private Person[] persons;

    public Office(Person... persons) {
        this.persons = Arrays.copyOf(persons, persons.length);
    }

    @Override
    public String toString() {
        return String.format("%s{persons=%s}", getClass().getSimpleName(), Arrays.toString(persons));
    }

    public Person[] getPersons() {
        return persons;
    }
}

當執行如下程式碼段時：

public static void main(String[] args) {
    final Person person = new Person( "John", "Smith", "[email protected]" );
    final Person personTwo = new Person( "Ron", "Zheng", "[email protected]" );
    Office office = new Office(person,personTwo);

    System.out.println( office.toString() );
}

將會出現如下結果：

Office{persons=[Person[[email protected], first name=John, last name=Smith],
Person[[email protected], first name=Ron, last name=Zheng]]}

Java社群已經開發了一些非常全面的庫，這些庫有助於使toString()實現變得容易和輕鬆。其中就有 Google Guava’s Objects.toStringHelper和 Apache Commons Lang ToStringBuilder。

四、clone方法

如果說在Java中那個方法的名聲最臭，那一定是clone()。此方法的意圖非常清晰——返回呼叫該方法的例項的一個正確的副本，然而有很多的原因導致它並沒有聽起來那麼容易。

• 首先，假如你決定實現你自己的clone()方法，有很多在Java文件中規定的約定你需要遵守。

• 其次，clone()方法在Object類中定義為protected型別，因此為了讓該方法可見，那麼它應該被重寫為public，並且返回型別應該是重寫類本身。

• 第三、重寫類應該實現Cloneable介面（這只是一個標記介面，介面中並沒有定義方法），否則會報CloneNotSupportedException異常。

• 最後、實現首先需要呼叫 super.clone()然後才執行其他額外所需的操作。讓我們來看一下我們的Person類如何實現clone()方法。

public class Person implements Cloneable {
    /**
    * @Comment 新增@Override註解，這能夠確保你的意圖是修改預設實現
    * @Author Ron
    * @Date 2018年1月3日 下午2:40:10
    * @return
    */
    @Override
    public Person clone() throws CloneNotSupportedException {
        return ( Person )super.clone();
    }
}

這個實現看起來相當的簡單和直接，那麼這個地方哪兒容易出錯呢？當正在執行類例項的克隆時，不會呼叫任何類建構函式。 這種行為的後果是可能會出現無意的資料共享。讓我們考慮下一個在上一節介紹的Office類的例子：

public class Office implements Cloneable {
    private Person[] persons;

    public Office( Person ... persons ) {
        this.persons = Arrays.copyOf( persons, persons.length );
    }

    @Override
    public Office clone() throws CloneNotSupportedException {
        return ( Office )super.clone();
    }

    public Person[] getPersons() {
        return persons;
    }
}

在這個實現中，Office類例項的所有克隆將會共享相同的persons陣列，這不太可能是我們克隆所期望的結果。為了讓clone()能夠完成正確的操作，我們還需要完成一些工作。

@Override
public Office clone() throws CloneNotSupportedException {
    final Office clone = ( Office )super.clone();
    clone.persons = persons.clone();
    return clone;
}

這樣看起來就會稍微好一點，但是即使是這樣的實現也是很脆弱的，因為如果persons欄位的是final型別，那麼同樣會導致相同資料共享問題（final不能再分配）；

總的來說，如果你想精確的拷貝類例項，可能最好的方法是避免使用clone()和Cloneable，選擇其他更簡單的方法實現（比如，拷貝建構函式，對具有C++背景的開發者來說這是相當熟悉的概念；或者使用工廠方法，我們在Java高階系列——如何建立和銷燬物件一文中有討論過這個非常有用的構造模式）。

五、equals方法和==操作符

Java的==操作符和equals()方法之間有一個非常有趣的關係，這個關係將會導致很多問題和困惑。在大多數情況下（除了比較原始基本型別），==操作符比較的是引用相等：如果兩個引用指向相同的物件，那麼他就返回true，否則就返回false。讓我們通過例項的形式來闡明他們的不同：

final String str1 = new String( "bbb" );
System.out.println( "Using == operator: " + ( str1 == "bbb" ) );
System.out.println( "Using equals() method: " + str1.equals( "bbb" ) );

從我們人類的角度來看，str1==”bbb”和str1.equals(“bbb”)並沒有什麼不同：兩種情況下的結果都應該是相同的，因為str1僅僅只是引用了’bbb’字串。但是在Java中並不是這樣，我們看上面程式碼段的執行結果：

Using == operator: false
Using equals() method: true

雖然兩個字串看起來完全一樣，在這個特殊的例子中其實存在兩個不同的字串例項。根據經驗，如果你處理物件引用，一般情況下都是使用equals()或者Objects.equals()去做相等比較，除非你真的是有意的去比較是否兩個物件的引用是指向同一個例項。

六、有用的helper類

自Java 7釋出以來，就有很多非常有用的helper類包含在標準類庫中，其中之一就是Object類。尤其是下面的這三個方法能夠大大的簡化你自己的equals()和hashCode()方法實現。

如果我們使用helper方法為我們的Person類重寫equals()和hashCode()方法，程式碼數量就會少很多，甚至程式碼可讀性也能夠得到提升。

/**
 * @Comment 新增@Override註解，這能夠確保你的意圖是修改預設實現
 * @Author Ron
 * @Date 2018年1月3日 上午11:49:16
 * @return
*/
@Override
public boolean equals(Object obj) {
    if (obj == null) {
        return false;
    }
    if (this == obj) {
        return true;
    }
    if (getClass() != obj.getClass()) {
        return false;
    }
    final Person other = (Person) obj;
    if (!Objects.equals(email, other.email)) {
        return false;
    } else if (!Objects.equals(firstName, other.firstName)) {
        return false;
    } else if (!Objects.equals(lastName, other.lastName)) {
        return false;
    }
    return true;
}

/**
 * @Comment 新增@Override註解，這能夠確保你的意圖是修改預設實現
 * @Author Ron
 * @Date 2018年1月3日 上午11:49:16
 * @return
*/
@Override
public int hashCode() {
    return Objects.hash(email, firstName, lastName);
}

在本文中，我們討論了Object類，它是Java中面向物件程式設計的基礎。我們已經看到每個類如何覆蓋從Object類繼承的方法並強加自己的相等規則。在接下來的文章中我們將會扭轉我們的視角並且討論如何設計更適合我們的類和介面。