Java中擺脫equals，compareTo和toString

本文由碼農網 – 單劼原創翻譯，轉載請看清文末的轉載要求，歡迎參與我們的付費投稿計劃！

我們都曾在POJO中重寫過equals(),compareTo()和toString()方法。但是另有其他能做到職責分離的更好的方法並帶來更簡潔的程式碼。閱讀這篇文章來一探究竟吧！

更簡明的職責——擺脫equals、compareTo和toString方法

你曾經檢視過java文件中的Object類嗎？也許吧。每當你向上追溯繼承樹的時候都會止步於這個類。你會注意到，該類有幾個方法是每一個類都必須繼承的。而你最喜歡重寫的方法可能就是toString(), .equals() and .hashCode() 這三個了。（至於為何總是應該同時重寫後兩個方法，請看Per-Åke Minborg寫的這篇文章：https://minborgsjavapot.blogspot.com/2014/10/new-java-8-object-support-mixin-pattern.html）

但是僅僅有這幾個方法顯然是不夠的。許多人將標準庫中的其他的介面如Comparable和Serializable加以組合。但是這樣真的明智嗎？為什麼每個人都很迫切地去自己實現這些方法呢？事實上，當你準備將物件儲存在一些容器中，如HashMap，並且想要控制雜湊衝突的時候，實現你自己的.equals()方法和.hashCode()方法確實有它的意義，但實現compareTo()和toString()方法又是為何呢？

本篇文章中我將提出一種使用到Speedment 開源專案上的軟體設計方法，這裡的物件的方法被定義為儲存於變數上的方法引用，而不是重寫它們。這樣做確有一些好處：你的POJO將會更短小簡潔，通用的方法可以不需要繼承而進行復用並且你可以因地制宜地使用它們。

原始的程式碼

首先我們來看下面的程式碼：這裡有一個典型的Java類Person。在使用中需要從一個Set中列印出每一個person物件，並且按照姓在前和名在後的順序排列（以防出現兩個相同姓氏的人）。

Person.java

public class Person implements Comparable<Person> {
    private final String firstname;
    private final String lastname;
    public Person(String firstname, String lastname) {
        this.firstname = firstname;
        this.lastname  = lastname;
    }
    public String getFirstname() {
        return firstname;
    }
    public String getLastname() {
        return lastname;
    }
    @Override
    public int hashCode() {
        int hash = 7;
        hash = 83 * hash + Objects.hashCode(this.firstname);
        hash = 83 * hash + Objects.hashCode(this.lastname);
        return hash;
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null) return false;
        if (getClass() != obj.getClass()) return false;
        final Person other = (Person) obj;
        if (!Objects.equals(this.firstname, other.firstname)) {
            return false;
        }
        return Objects.equals(this.lastname, other.lastname);
    }
    @Override
    public int compareTo(Person that) {
        if (this == that) return 0;
        else if (that == null) return 1;
        int comparison = this.firstname.compareTo(that.firstname);
        if (comparison != 0) return comparison;
        comparison = this.lastname.compareTo(that.lastname);
        return comparison;
    }
    @Override
    public String toString() {
        return firstname + " " + lastname;
    }
}

Main.java

public class Main {
    public static void main(String... args) {
        final Set
      people = new HashSet<>();
        people.add(new Person("Adam", "Johnsson"));
        people.add(new Person("Adam", "Samuelsson"));
        people.add(new Person("Ben", "Carlsson"));
        people.add(new Person("Ben", "Carlsson"));
        people.add(new Person("Cecilia", "Adams"));
        people.stream()
            .sorted()
            .forEachOrdered(System.out::println);
    }
}

Output

run:
Adam Johnsson
Adam Samuelsson
Ben Carlsson
Cecilia Adams
BUILD SUCCESSFUL (total time: 0 seconds)

Person 類實現了一些方法來控制輸出。 hashCode()和equals() 方法確保同一個person物件不會被重複新增到set中。.compareTo() 方法用於排序方法中生成應有的順序。而重寫方法toString()是在System.out.println() 被呼叫的時候控制每個Person物件的輸出格式。你認出這種結構了嗎？幾乎任何一個java工程中都會有它。

替代這些程式碼

相比於將所有這些方法寫入Person類中，我們可以讓它保持儘量的簡潔，使用方法引用去處理它們。我們可以刪除所有equals(),hashCode(),compareTo()和toString()的樣板式程式碼，取而代之的是下面介紹的兩個靜態變數：COMPARATOR 和TO_STRING。

Person.java

public class Person {
    private final String firstname;
    private final String lastname;
    public Person(String firstname, String lastname) {
        this.firstname = firstname;
        this.lastname  = lastname;
    }
    public String getFirstname() {
        return firstname;
    }
    public String getLastname() {
        return lastname;
    }
    public final static Comparator<Person> COMPARATOR =
        Comparator.comparing(Person::getFirstname)
            .thenComparing(Person::getLastname);
    public final static Function<Person, String> TO_STRING =
        p -> p.getFirstname() + " " + p.getLastname();
}

Main.java

public class Main {
    public static void main(String... args) {
        final Set
      people = new TreeSet<>(Person.COMPARATOR);
        people.add(new Person("Adam", "Johnsson"));
        people.add(new Person("Adam", "Samuelsson"));
        people.add(new Person("Ben", "Carlsson"));
        people.add(new Person("Ben", "Carlsson"));
        people.add(new Person("Cecilia", "Adams"));
        people.stream()
            .map(Person.TO_STRING)
            .forEachOrdered(System.out::println);
    }
}

Output

run:
Adam Johnsson
Adam Samuelsson
Ben Carlsson
Cecilia Adams
BUILD SUCCESSFUL (total time: 0 seconds)

這樣實現的好處是我們可以在不用更改Person類的情況下替換排序策略或列印格式。這將使程式碼擁有更強的可維護性和複用性，更不用說更快的編寫速度了。