12. Consider implementing Comparable

大意為 考慮實(shí)現(xiàn)Comparable接口

對(duì)于Comparable接口來說，其主要方法應(yīng)該是compareTo方法，可是這個(gè)方法并沒有在Object里面聲明，而是Comparable接口中唯一的方法，這個(gè)方法所能夠產(chǎn)生的作用并不局限于簡(jiǎn)單的比較，還可以是有順序的比較

換句話說，實(shí)現(xiàn)Comparable接口的類，都具有一種內(nèi)在的排序關(guān)系（natural ordering），而且對(duì)該類的數(shù)組進(jìn)行排序也是比較簡(jiǎn)單的，例如：

Arrays.sort(a);

對(duì)于儲(chǔ)存在集合里面的實(shí)現(xiàn)了Comparable接口的對(duì)象進(jìn)行搜索，計(jì)算極值之類的操作都十分簡(jiǎn)單，下面舉個(gè)例子，實(shí)現(xiàn)了從命令行讀取參數(shù)，并且自動(dòng)排序并打印

public class ComparableTest {
    public static void main(String[] args){
        Set<String> s=new TreeSet<String>();
        Collections.addAll(s,args);
        System.out.println(s);
    }
}

我們?cè)贗ntelliJ里面設(shè)定命令行參數(shù)，設(shè)定方法如下

主面板-> Run -> Edit Configurations

setThePara

如上圖所示，我們把參數(shù)設(shè)成 “apple cat interest home bed”這5個(gè)字符串
得到的結(jié)果為

result

我們可以在參數(shù)后面繼續(xù)加一個(gè)apple，你會(huì)發(fā)現(xiàn)結(jié)果還是一樣的，這說明此內(nèi)在排序關(guān)系還能夠剔除重復(fù)的元素

可以看出來，這個(gè)接口的功能還是十分強(qiáng)大的，Java中的一些值依賴的類都實(shí)現(xiàn)了這個(gè)接口，所以當(dāng)你想要實(shí)現(xiàn)排序，不管是字母順序排序還是數(shù)值排序，都應(yīng)該考慮實(shí)現(xiàn)這個(gè)接口

Comparable接口中的compareTo方法其實(shí)與我們之前所介紹的equals類似，按照兩個(gè)對(duì)象的比較大小返回相應(yīng)的結(jié)果，分別是0，正整數(shù)，負(fù)整數(shù)，如果無法比較的話就拋出一個(gè)ClassCastException

在這里我們引入一個(gè)數(shù)學(xué)函數(shù)signum也就是sgn符號(hào)函數(shù)，該函數(shù)根據(jù)自變量的符號(hào)分別返回-1，0，+1

接下來，利用這個(gè)數(shù)學(xué)函數(shù)，我們介紹一下實(shí)現(xiàn)Comparable接口的一些約定

• 所有的x，y需滿足，sgn(x.compareTo(y)) == -sgn(y.compareTo(x))
• 傳遞性：x.compareTo(y) > 0 并且 y.compareTo(z) > 0,則有 x.compareTo(z) >0
• 對(duì)于任意z，當(dāng)x.compareTo(y)==0時(shí)，均有sgn(x.compareTo(z))==sgn(y.compareTo(z))
• 強(qiáng)烈建議，x.compareTo(y)==0等價(jià)于x.equals(y) ,雖然這個(gè)不是必要的，但是如果違反這一條件，應(yīng)該做出適當(dāng)說明

以上是我們必需遵守的規(guī)范，如果違反了這些規(guī)范，那么就會(huì)破壞了一些依賴于比較關(guān)系的類，比如說一些有序的集合類，TreeSet，TreeMap，或者是一些工具類，比如Collection和Arrays，它們的內(nèi)部都有搜索和排序算法

再此需要提及的是，實(shí)現(xiàn)了Comparble接口的類，如果你想要為它添加一些值依賴的域，那么首要的選項(xiàng)必然不是去直接添加成員域來進(jìn)行擴(kuò)展，比較好的方法應(yīng)該是重新寫一個(gè)類，在這個(gè)新的類里面有著擴(kuò)展前的類的實(shí)例，并且包含一個(gè)“View”來返回這個(gè)實(shí)例

對(duì)著上面的約定中的最后一項(xiàng)，并不是真正的規(guī)則，而是同equals返回的結(jié)果一致，保持一種一致的順序關(guān)系，當(dāng)然了，一個(gè)類違反了這個(gè)小規(guī)則，也可以繼續(xù)正常工作，不過當(dāng)一個(gè)有序的集合的元素違反了這個(gè)規(guī)則，那么這個(gè)集合可能就不能遵守一些集合，比如Collection，Set，Map等的通用的接口約定，這是因?yàn)檫@些通用的接口約定是利用equals定義的

在這里舉一個(gè)例子，BigDecimal的這個(gè)類，它的compareTo方法和equals方法并不一致，如果你用HashMap創(chuàng)建一個(gè)集合，并且添加new BigDecimal(1.0)和new BigDecimal(1.00)這兩個(gè)實(shí)例，這個(gè)集合將包含兩個(gè)元素，用TreeMap來實(shí)現(xiàn)的話就只有一個(gè)元素存在，這是因?yàn)榍罢呤抢胑quals，后者是利用compareTo,我們實(shí)際來測(cè)試一下

public class ComparableTest {
    public static void main(String[] args){
        TreeSet<BigDecimal> set1= new TreeSet<>();
        HashSet<BigDecimal> set2=new HashSet<>();
        set1.add(new BigDecimal(1.0));
        set1.add(new BigDecimal(1.00));
        set2.add(new BigDecimal(1.0));
        set2.add(new BigDecimal(1.00));
        System.out.println("Set1's size is "+set1.size());
        System.out.println("Set2's size is "+set2.size());
        System.out.println(new BigDecimal(1.00).compareTo(new BigDecimal(1.0)));
        System.out.println(new BigDecimal(1.00).equals(new BigDecimal(1.0)));
    }
}

結(jié)果如下圖所示：

result

可以看出，書中所提的bug在1.8已經(jīng)被修復(fù)了，但是BigDecimal的兩個(gè)方法不一致的問題還是存在

編寫compareTo方法和equals方法差不多，但是有幾個(gè)重要的區(qū)別，Comparable接口是參數(shù)化的，并且comparable方法是靜態(tài)的類型，那么我們就不用對(duì)參數(shù)進(jìn)行類型轉(zhuǎn)換，如果參數(shù)類型不合適的話，甚至無法通過編譯

注意到compareTo方法其實(shí)是順序的比較，比較對(duì)象的引用域的時(shí)候我們可以遞歸地使用compareTo方法來解決，如果一個(gè)域沒有實(shí)現(xiàn)Comparable接口，或者我們需要一種另類的排序關(guān)系來比較的話，可以考慮使用Comparator，使用已有的或者是自己編寫一個(gè)

需要提及的是，當(dāng)一個(gè)類有多個(gè)關(guān)鍵域的時(shí)候，我們需要自己擬定比較的順序，舉一個(gè)例子，在筆記9中出現(xiàn)的PhoneNumber類

public int compareTo(PhoneNumber pn) {
    // Compare area codes
    if (areaCode < pn.areaCode)
        return -1;
    if (areaCode > pn.areaCode)
        return 1;
    // Area codes are equal, compare prefixes
    if (prefix < pn.prefix)
        return -1;
    if (prefix > pn.prefix)
        return 1;
    // Area codes and prefixes are equal, compare line numbers
    if (lineNumber < pn.lineNumber)
        return -1;
    if (lineNumber > pn.lineNumber)
        return 1;
    return 0; // All fields are equal
}

由于我們并不要求返回的值，只要求返回的符號(hào)，所以以上的代碼可以簡(jiǎn)化成

public int compareTo(PhoneNumber pn) {
    // Compare area codes
    int areaCodeDiff = areaCode - pn.areaCode;
    if (areaCodeDiff != 0)
        return areaCodeDiff;
    // Area codes are equal, compare prefixes
    int prefixDiff = prefix - pn.prefix;
    if (prefixDiff != 0)
        return prefixDiff;
    // Area codes and prefixes are equal, compare line numbers
    return lineNumber - pn.lineNumber;
}

當(dāng)然這樣做要注意兩者的差值不能超過int的表示范圍，否則就溢出了