Java Comparable介面的範例程式碼詳解

這篇文章是免費Java 8 課程中關於Clean Code原則的一部分。

在這篇文章中，我們要聊聊Java Comparable介面。

還有一個不錯的影片可以點這裡。

Comparable介面時用來幹嘛的呢？

我們應該如何對事物進行比較和排序？這問題聽起來有點莫名其妙，但我希望你認真考慮。比方說，我們有一組蘋果：

例1

我們要怎麼對它們進行排序呢？我們希望透過重量進行排序嗎？如果是的話，排序是從最輕到最重還是從最重到最輕？當我們對它們進行排序的時候，我們需要反覆比較兩個蘋果的重量，直到正確地排好所有的蘋果。蘋果1比蘋果2重？那它比蘋果3重嗎？我們需要不斷比較，直到完成排序。 Comparable介面可以幫助我們實現這一目標。 Comparable本身無法對物件進行排序，但介面定義的方法 int compareTo(T)可以。

compareTo(T)如何運作

讓我們透過使用compareTo()方法來看看哪個蘋果比較重，開始吧。

例2

compareTo()方法的工作原理是傳回一個int值－或正，或負，或為零。它透過呼叫作為參數的物件來比較物件。負數表示呼叫的物件比參數“輕”。如果我們用大小來比較蘋果，那麼上面的呼叫會回傳一個負數，例如-400，因為紅蘋果比青蘋果小。如果兩個蘋果重量相等，那麼呼叫將返回0。如果紅蘋果比較重，那麼compareTo()將會回傳一個正數，例如68。

compareTo()的彈性

如果我們反覆呼叫上面的compareTo()方法，那麼我們可以透過大小來排序，這很棒，但並非故事的結束。如果我們想透過顏色來為蘋果排序呢？抑或是重量？我們也可以做到。關鍵是，我們的客戶－讓我們叫他胖子農夫（見例3），需要在我們開始開發之前精確定義需要如何對蘋果進行排序。

範例3

他可以透過回答這兩個問題來做到這一點：

1. 他希望蘋果如何進行排序？他希望我們比較什麼特徵？

2. 在那樣的環境中，“小於”，“等於”和“大於”指的是什麼意思？

也可以使用多個特徵，這個後面我們會講。

範例1：透過重量排序蘋果

在第一個例子中，我們將透過重量對蘋果排序。只需要一行程式碼。

Collections.sort(apples);

範例4

上面的程式碼行可以為我們做到所有的排序工作，只要我們事先定義好如何對蘋果進行排序（這就需要多行程式碼了）。

讓我們開始寫蘋果類別吧。

public class Apple implements Comparable {
    private String variety;
    private Color color;
    private int weight;
    @Override
    public int compareTo(Apple other) {
        if (this.weight < other.weight) {
            return -1;
        }
        if (this.weight == other.weight) {
            return 0;
        }
        return 1;
    }
}

範例5

這是Apple類別的第一個版本。由於我們使用的是compareTo方法，並且正在排序蘋果，所以我實作了Comparable介面。在這第一個版本中，我們透過重量來比較物件。在我們的compareTo()方法中，我們寫一個if條件，說明如果這個蘋果的重量小於其他的蘋果，那麼回傳一個負數，為了保持簡單，我們假定它為-1。請記住，這意味著這個蘋果輕於Apple ‘other’。在第二個if語句中，我們要說明，如果蘋果重量相等，那麼回傳一個0。當然，如果這個蘋果既不是更輕，又不是一樣重，那就只能比其他蘋果重了。在這種情況下，我們傳回一個正數，假定為1。

例2：通过多个特征排序苹果

正如我前面提到的，我们还可以使用compareTo()比较多个特征。比方说，我们第一通过品种排序苹果，但如果两个苹果是同一品种，那么我们就按颜色排序。最后，如果这两个特性相同，那么我们将按重量排序。虽然我们可以手动实现这件事，就像我在最后一个例子中做的那样，但是其实可以用一种简洁得多的方式实现。一般来说，最好是重用现有的代码，而不是自己写。我们可以在Integer、String和枚举类中使用compareTo方法来比较值。由于我们没有使用Integer对象，用了int，所以我们不得不使用来自于Integer包装器类的一个静态的helper方法来比较两个值。

public class Apple implements Comparable {
    private String variety;
    private Color color;
    private int weight;
    @Override
    public int compareTo(Apple other) {
        int result = this.variety.compareTo(other.variety);
        if (result != 0) {
            return result;
        }
        if (result == 0) {
            result = this.color.compareTo(other.color);
        }
        if (result != 0) {
            return result;
        }
        if (result == 0) {
            result = Integer.compare(this.weight, other.weight);
        }
        return result;
    }
}

例6

在例6中，我们比较了客户指定的苹果的第一特性，它们的品种。如果compareTo()调用的结果为非零，那么我们返回值。否则，我们调用另一个compareTo()直到得到一个非零值，或者直到已经比较完这三个特征。尽管此代码可以工作，但它不是最有效或干净的解决方案。在例3中，我们重构我们的代码，使其更简单。

@Override
public int compareTo(Apple other) {
     int result = this.variety.compareTo(other.variety);
     if (result == 0) {
          result = this.color.compareTo(other.color);
     }
     if (result == 0) {
          result = Integer.compare(this.weight, other.weight);
     }
     return result;
}

例7

正如你所看到的，这大大减少了代码，并且每一次比较只要一行代码。如果一个compareTo()调用的结果是零，那么我们就转移到下一个相同if语句的比较中。顺便说一句，这是成为Clean Coder的一个很好的例子。通常情况下，你不需要立即写出干净的代码；你可以从一个粗略的想法开始，使其可以工作，然后不断改进，直到你尽可能得让它干净就可以了。

Comparable，hashCode以及Equals

你可能会注意到compareTo()看起来有点像hashCode()和equals()方法。但是，它们有一个重要的区别。对于hashCode()和equals()方法，比较个体属性的顺序不影响返回的值，但是，在compareTo()中，通过你比较对象的顺序来定义对象的顺序。

结论

在结论中我只想强调Comparable接口是多么的重要。它既用于java.util.Arrays，也用于java.util.Collections实用程序类，来排序元素和搜索排序集合中的元素。使用TreeSet和Tree Map，就更简单了——想要它们会自动排序必须实现Comparable接口的元素。

以上是Java Comparable介面的範例程式碼詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！