:::info
<a href="/@TFA101/CherryJava" target="_self">< :notebook_with_decorative_cover: [共享目錄] Java 2 學習筆記
</a>
:::
# 模組18 集合物件排序（Comparable、compareTo()、sort()）

集合中，有順序性的集合如下：

* List（存在我底下的絕對保證順序）
* **ArrayList**
* **Vector**
* **LinkedList**（Queue 再來說明）

* Set（我只保證不重複，不要以為存在我底下的就不保證順序！）
* SortedSet（介面）
* **TreeSet**（同時具備不重複、有順序的特性；單值獨立存取）
* HashSet（我不保證順序）
* **LinkedHashSet**（我有順序性，依照加入先後為順序）

* Map（我保證 key 值重複就覆蓋舊的 value 值）
* **TreeMap**（同時具備重複就覆蓋、有順序的特性；對映存取，依 key 值排序）
* HashMap（我不保證順序）
* **LinkedHashMap**（我有順序性，依照加入先後為順序）

* Queue（有順序性、消化性）
* **LinkedList**
* **PriorityQueue**

## 集合排序元素的依據

這些集合的排序以下列介面及其抽象方法為依據：

* 介面：Comparable<T>

* 抽象方法：`compareTo(T target)`

### 實作 Comparable 介面

想藉由陣列或集合擁有大小排序的特性，必須主動實作 Comparable 介面，再依自訂的大小定義和排序規則去 Override 掉（實作）它的抽象方法 `compareTo()`。

:::warning
記得 [Comparable 可以宣告泛型](https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html)，如： `Class Test implements Compareble<Example>`。

不宣告泛型可不可以？可以。

但此時則會以 `Obejct` 為型別，`compareTo(Object obj)` 方法傳入的參數就會是 `Object` 型別。進行排序前要先強制轉型，存為用來呼叫此方法的物件的型別（比較大小的兩者要同源才有意義）。
:::

### Override `compareTo(T target)` 方法

:::warning
下面範例中，傳入的參數 `Example ex` 的型別 `Example` 即是在實作 Comaparable 介面時就已宣告的泛型，這樣在比較時就不需先強制轉型，當然也不用先檢查它的型別。
:::

// 前略...
// 假設已於實作Comaparable時宣告泛型<Example>
// 某集合存放的Example物件，有number屬性，在compareTo設定為排序依據
public int compareTo(Example ex) {
    if(this.number > ex.number)
        return 1;
    else if(this.number == ex.number)
        return 0;
    else
        return -1;
    }

排序將會依 `public int compareTo(T target)` 的回傳值，來排定元素的順序：

:::warning
呼叫這個方法的是集合（或準備加入集合）內的元素，傳進來的參數也是集合（或準備加入集合）內的元素。
:::

1. **回傳值是 ==大於 0== 的整數（例子中為 `1`）時**：
用來呼叫的物件存到參數傳入的物件的 ==右邊==。
<div style="margin-bottom:16px;" title="保持間距用"></div>

2. **回傳值 ==正好為0== 時**：
用來呼叫和傳入參數的物件沒有大小之分，只要兩個人左右存在一起就好。
<font color=red>但在可排序、保證不重複的 TreeSet 中，回傳值為 `0` 會是不重複的根據，後來的物件將會不被允許加入。</font>
<div style="margin-bottom:16px;" title="保持間距用"></div>

3. **回傳值是 ==小於 0== 的整數（例子中為 `-1`）時**：
用來呼叫的物件存到參數傳入的物件的 ==左邊==。

### if 條件與 compareTo() 的回傳值
須注意，回傳值需要搭配 `if` 的條件判斷。此範例中回傳 `1` 的條件為 `this.number ＞ ex.number`，因此將會由小至大排序。

反之，若在 `if (this.number ＜ ex.number)` 時回傳 `1`，則代表「如果用來呼叫的物件比傳入參數 ex 的 number **<font style="text-decoration:underline">小</font>**，就移動到 **<font style="text-decoration:underline">右邊</font>**」，可以達到由大到小反向排序的效果。

:::info
:bulb: <span style="border-bottom: 1px solid #31708f;">**Tip**</span>　如果用來比較的值**剛好都是整數的話**，若要由小至大排列，其實可以寫成這樣：
<div style="margin-bottom:16px;" title="保持間距用"></div>

public int compareTo(Example ex) { 
    return this.number - ex.number;
}

回傳值符合存入順序的條件。由大至小排列則可以寫成 `return ex.number - this.number;`。
:::

## 自動排序

學習陣列（Array）相關的方法時，應該大家都記得某個 static 方法 `Arrays.sort()`，集合類別也有類似的方法 `Collections.sort()`。

:::warning
[Array](https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Array.html) 類別 / [Array<font style="text-decoration:underline; font-weight:bold;">s</font>](https://docs.oracle.com/javase/8/docs/api/java/util/Arrays.html) 類別，[Collection](https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html) 介面 / [Collection<font style="text-decoration:underline; font-weight:bold;">s</font>](https://docs.oracle.com/javase/8/docs/api/java/util/Collections.html) 類別，千萬要搞清楚。
:::

當時我們只知道呼叫它，會依照自然順序，由小至大排列。

**其實這個所謂的「自然順序」就是由 `compareTo(T target)` 方法定義的**。陣列或集合物件傳入 `Arrays.sort()` 或 `Collections.sort()`，兩個方法內部會自動去呼叫該物件的 `compareTo(T target)`。

所以如果改變（Override）了該集合或陣列物件類別中 `compareTo(T target)` 方法的排序規則，會影響到物件呼叫與將物件傳入 `Arrays.sort()` 或 `Collections.sort()` 排序時，排出來的元素順序。