12. Consider implementing Comparable
大意為 考慮實現(xiàn)Comparable接口
對于Comparable接口來說，其主要方法應(yīng)該是compareTo方法调俘，可是這個方法并沒有在Object里面聲明，而是Comparable接口中唯一的方法，這個方法所能夠產(chǎn)生的作用并不局限于簡單的比較杆怕，還可以是有順序的比較
換句話說糠溜，實現(xiàn)Comparable接口的類，都具有一種內(nèi)在的排序關(guān)系（natural ordering）旁瘫，而且對該類的數(shù)組進行排序也是比較簡單的引颈，例如：
Arrays.sort(a);
對于儲存在集合里面的實現(xiàn)了Comparable接口的對象進行搜索，計算極值之類的操作都十分簡單境蜕，下面舉個例子蝙场，實現(xiàn)了從命令行讀取參數(shù)，并且自動排序并打印
public class ComparableTest {
public static void main(String[] args){
Set<String> s=new TreeSet<String>();
Collections.addAll(s,args);
System.out.println(s);
}
}
我們在IntelliJ里面設(shè)定命令行參數(shù)粱年，設(shè)定方法如下
主面板-> Run -> Edit Configurations
如上圖所示售滤，我們把參數(shù)設(shè)成 “apple cat interest home bed”這5個字符串
得到的結(jié)果為
我們可以在參數(shù)后面繼續(xù)加一個apple，你會發(fā)現(xiàn)結(jié)果還是一樣的台诗，這說明此內(nèi)在排序關(guān)系還能夠剔除重復(fù)的元素
可以看出來完箩，這個接口的功能還是十分強大的，Java中的一些值依賴的類都實現(xiàn)了這個接口拉队，所以當(dāng)你想要實現(xiàn)排序弊知，不管是字母順序排序還是數(shù)值排序，都應(yīng)該考慮實現(xiàn)這個接口
Comparable接口中的compareTo方法其實與我們之前所介紹的equals類似粱快，按照兩個對象的比較大小返回相應(yīng)的結(jié)果秩彤，分別是0，正整數(shù)事哭，負(fù)整數(shù)漫雷，如果無法比較的話就拋出一個ClassCastException
在這里我們引入一個數(shù)學(xué)函數(shù)signum也就是sgn符號函數(shù)，該函數(shù)根據(jù)自變量的符號分別返回-1鳍咱，0降盹，+1
接下來，利用這個數(shù)學(xué)函數(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
- 對于任意z丑念，當(dāng)x.compareTo(y)==0時涡戳，均有sgn(x.compareTo(z))==sgn(y.compareTo(z))
- 強烈建議，x.compareTo(y)==0等價于x.equals(y) ,雖然這個不是必要的渠欺，但是如果違反這一條件妹蔽，應(yīng)該做出適當(dāng)說明
以上是我們必需遵守的規(guī)范，如果違反了這些規(guī)范，那么就會破壞了一些依賴于比較關(guān)系的類胳岂，比如說一些有序的集合類沪摄，TreeSet渠牲，TreeMap露泊，或者是一些工具類霎桅，比如Collection和Arrays，它們的內(nèi)部都有搜索和排序算法
再此需要提及的是产园，實現(xiàn)了Comparble接口的類汞斧，如果你想要為它添加一些值依賴的域，那么首要的選項必然不是去直接添加成員域來進行擴展什燕，比較好的方法應(yīng)該是重新寫一個類粘勒，在這個新的類里面有著擴展前的類的實例，并且包含一個“View”來返回這個實例
對著上面的約定中的最后一項屎即，并不是真正的規(guī)則庙睡，而是同equals返回的結(jié)果一致，保持一種一致的順序關(guān)系技俐，當(dāng)然了乘陪，一個類違反了這個小規(guī)則，也可以繼續(xù)正常工作雕擂，不過當(dāng)一個有序的集合的元素違反了這個規(guī)則啡邑，那么這個集合可能就不能遵守一些集合，比如Collection井赌，Set谤逼，Map等的通用的接口約定，這是因為這些通用的接口約定是利用equals定義的
在這里舉一個例子族展，BigDecimal的這個類森缠，它的compareTo方法和equals方法并不一致，如果你用HashMap創(chuàng)建一個集合仪缸，并且添加new BigDecimal(1.0)和new BigDecimal(1.00)這兩個實例，這個集合將包含兩個元素列肢，用TreeMap來實現(xiàn)的話就只有一個元素存在恰画，這是因為前者是利用equals，后者是利用compareTo,我們實際來測試一下
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é)果如下圖所示：
可以看出瓷马，書中所提的bug在1.8已經(jīng)被修復(fù)了拴还，但是BigDecimal的兩個方法不一致的問題還是存在
編寫compareTo方法和equals方法差不多，但是有幾個重要的區(qū)別欧聘，Comparable接口是參數(shù)化的片林，并且comparable方法是靜態(tài)的類型，那么我們就不用對參數(shù)進行類型轉(zhuǎn)換，如果參數(shù)類型不合適的話费封，甚至無法通過編譯
注意到compareTo方法其實是順序的比較焕妙，比較對象的引用域的時候我們可以遞歸地使用compareTo方法來解決，如果一個域沒有實現(xiàn)Comparable接口弓摘，或者我們需要一種另類的排序關(guān)系來比較的話焚鹊，可以考慮使用Comparator，使用已有的或者是自己編寫一個
需要提及的是韧献，當(dāng)一個類有多個關(guān)鍵域的時候末患，我們需要自己擬定比較的順序，舉一個例子锤窑，在筆記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
}
由于我們并不要求返回的值璧针，只要求返回的符號，所以以上的代碼可以簡化成
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的表示范圍渊啰，否則就溢出了
