Java提高十七：TreeSet 深入分析

前一篇我們分析了TreeMap，接下來我們分析TreeSet，比較有意思的地方是，似乎有Map和Set的地方，Set幾乎都成了Map的一個馬甲。此話怎講呢?在前面一篇討論HashMap和HashSet的詳細實現討論里，我們發現HashSet的詳細實現都是通過封裝了一個HashMap的成員變量來實現的。這里，TreeSet也不例外。我們先看部分代碼，里面聲明了成員變量：

private transient NavigableMap<E,Object> m; 

這里NavigableMap本身是TreeMap所實現的一個接口。我們再看下面和構造函數相關的實現：

TreeSet(NavigableMap<E,Object> m) {  
    this.m = m;  
}  
  
public TreeSet() {   // 無參數構造函數  
    this(new TreeMap<E,Object>());  
}  
  
public TreeSet(Comparator<? super E> comparator) { // 包含比較器的構造函數  
    this(new TreeMap<>(comparator));  
}  
  
public TreeSet(Collection<? extends E> c) {  
    this();  
    addAll(c);  
}  
  
public TreeSet(SortedSet<E> s) {  
    this(s.comparator());  
    addAll(s);  
}  
  
public  boolean addAll(Collection<? extends E> c) {  
    // Use linear-time version if applicable  
    if (m.size()==0 && c.size() > 0 &&  
        c instanceof SortedSet &&  
        m instanceof TreeMap) {  
        SortedSet<? extends E> set = (SortedSet<? extends E>) c;  
        TreeMap<E,Object> map = (TreeMap<E, Object>) m;  
        Comparator<? super E> cc = (Comparator<? super E>) set.comparator();  
        Comparator<? super E> mc = map.comparator();  
        if (cc==mc || (cc != null && cc.equals(mc))) {  
            map.addAllForTreeSet(set, PRESENT);  
            return true;  
        }  
    }  
    return super.addAll(c);  
}  

這里構造函數相關部分的代碼看起來比較多，實際上主要的構造函數就兩個，一個是默認的無參數構造函數和一個比較器構造函數，他們內部的實現都是使用的TreeMap，而其他相關的構造函數都是通過調用這兩個來實現的，故其底層使用的就是TreeMap。既然TreeSet只是TreeMap的一個馬甲，因此只要掌握了前面一篇的TreeMap原理，那么TreeSet還是比較容易懂的，因此本文不會詳細去介紹TreeMap中已介紹的內容。好了，言歸正傳，下面開始TreeSet的學習。

一、TreeSet簡單介紹

TreeSet是JAVA中集合的一種，TreeSet 是一個有序的集合，它的作用是提供有序的Set集合。它繼承於AbstractSet抽象類，實現了NavigableSet<E>,Cloneable,java.io.Serializable接口。一種基於TreeMap的NavigableSet實現。

因為TreeSet繼承了AbstractSet抽象類，所以它是一個set集合，可以被實例化，且具有set的屬性和方法。

TreeSet是基於TreeMap實現的。TreeSet中的元素支持2種排序方式：自然排序 或者 根據創建TreeSet 時提供的 Comparator 進行排序。這取決於使用的構造方法。

TreeSet的性能比HashSet差但是我們在需要排序的時候可以用TreeSet因為他是自然排序也就是升序下面是TreeSet實現代碼這個類也似只能通過迭代器迭代元素

ps：TreeSet是有序的Set集合，因此支持add、remove、get等方法。

java.lang.Object
   ↳     java.util.AbstractCollection<E>
         ↳     java.util.AbstractSet<E>
               ↳     java.util.TreeSet<E>

public class TreeSet<E> extends AbstractSet<E>        
    implements NavigableSet<E>, Cloneable, java.io.Serializable{}

TreeSet與Collection關系如下圖：

從圖中可以看出：
(01) TreeSet繼承於AbstractSet，並且實現了NavigableSet接口。
(02) TreeSet的本質是一個"有序的，並且沒有重復元素"的集合，它是通過TreeMap實現的。TreeSet中含有一個"NavigableMap類型的成員變量"m，而m實際上是"TreeMap的實例"。

二、TreeSet的構造方法和API

序號	構造函數的說明
1	TreeSet （) 此構造函數構造空樹集，將在根據其元素的自然順序按升序排序。
2	TreeSet (集合 c) 此構造函數生成樹的集合，它包含的元素的集合 c。
3	TreeSet (比較器 comp) 此構造函數構造一個空樹集，將根據給定的比較器進行排序。
4	TreeSet (SortedSet ss) 此構造函數生成包含給定 SortedSet 的元素 TreeSet

TreeSet的方法：

修飾符和類型	方法和描述
boolean	add(E e) 將指定的元素添加到這套，如果它已不存在。
boolean	addAll(Collection<? extends E> c) 在加入這一組指定的集合中添加的所有元素。
E	ceiling(E e) 返回最小的元素在這一組大於或等於給定的元素，則 null如果沒有這樣的元素。
void	clear() 從這一組中移除所有元素。
Object	clone() 返回此 TreeSet實例淺表副本。
Comparator<? super E>	comparator() 返回用於排序在這集，或 空元素，如果這套使用自然排序其元素的比較。
boolean	contains(Object o) 如果此集合包含指定的元素，則返回 true 。
Iterator<E>	descendingIterator() 返回迭代器中這套降序排序的元素。
NavigableSet<E>	descendingSet() 返回逆序視圖中包含的元素這一套。
E	first() 返回第一個 （最低） 元素當前在這一套。
E	floor(E e) 返回的最大元素在這一組小於或等於 null如果沒有這樣的元素。
SortedSet<E>	headSet(E toElement) 返回其元素是嚴格小於toElement這套的部分視圖.
NavigableSet<E>	headSet(E toElement, boolean inclusive) 返回一個視圖的這部分設置的元素都小於 （或等於，如果inclusive是真的） toElement.
E	higher(E e) 返回最小的元素在這套嚴格大於給定的元素，則 null如果沒有這樣的元素。
boolean	isEmpty() 如果此集不包含任何元素，則返回 true 。
Iterator<E>	iterator() 返回迭代器中這套以升序排序的元素。
E	last() 在這套目前返回的最后一個 （最高） 的元素。
E	lower(E e) 在這一套嚴格的小於給定的元素，則 null返回的最大元素，如果沒有這樣的元素。
E	pollFirst() 檢索和刪除第一個 （最低） 元素，或如果此集合為空，則返回 null 。
E	pollLast() 檢索和刪除的最后一個 （最高） 的元素，或如果此集合為空，則返回 null 。
boolean	remove(Object o) 從這一組中移除指定的元素，如果它存在。
int	size() 在這套 （其基數） 中返回的元素的數目。
NavigableSet<E>	subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive) 返回此集的部分視圖的元素范圍從fromElement到toElement.
SortedSet<E>	subSet(E fromElement, E toElement) 返回視圖的部分的這一套的元素范圍從 fromElement，具有包容性，到 toElement，獨家。
SortedSet<E>	tailSet(E fromElement) 返回其元素是大於或等於fromElement這套的部分視圖.
NavigableSet<E>	tailSet(E fromElement, boolean inclusive) 返回其元素是大於 （或等於，如果inclusive是真的） 這套的部分視圖fromElement.

三、TreeSet主要方法分析

1、add：將指定的元素添加到此 set（如果該元素尚未存在於 set 中）。

public boolean add(E e) {
        return m.put(e, PRESENT)==null;
    }

2、addAll：將指定 collection 中的所有元素添加到此 set 中。

public  boolean addAll(Collection<? extends E> c) {
        // Use linear-time version if applicable
        if (m.size()==0 && c.size() > 0 &&
            c instanceof SortedSet &&
            m instanceof TreeMap) {
            SortedSet<? extends E> set = (SortedSet<? extends E>) c;
            TreeMap<E,Object> map = (TreeMap<E, Object>) m;
            Comparator<? super E> cc = (Comparator<? super E>) set.comparator();
            Comparator<? super E> mc = map.comparator();
            if (cc==mc || (cc != null && cc.equals(mc))) {
                map.addAllForTreeSet(set, PRESENT);
                return true;
            }
        }
        return super.addAll(c);
    }

3、ceiling：返回此 set 中大於等於給定元素的最小元素；如果不存在這樣的元素，則返回 null。

public E ceiling(E e) {
        return m.ceilingKey(e);
    }

4、clear：移除此 set 中的所有元素。

public void clear() {
        m.clear();
    }

5、clone：返回 TreeSet 實例的淺表副本。屬於淺拷貝。

public Object clone() {
        TreeSet<E> clone = null;
        try {
            clone = (TreeSet<E>) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new InternalError();
        }

        clone.m = new TreeMap<>(m);
        return clone;
    }

6、comparator：返回對此 set 中的元素進行排序的比較器；如果此 set 使用其元素的自然順序，則返回 null。

public Comparator<? super E> comparator() {
        return m.comparator();
    }

7、contains：如果此 set 包含指定的元素，則返回 true。

public boolean contains(Object o) {
        return m.containsKey(o);
    }

8、descendingIterator：返回在此 set 元素上按降序進行迭代的迭代器。

public Iterator<E> descendingIterator() {
        return m.descendingKeySet().iterator();
    }

9、descendingSet：返回此 set 中所包含元素的逆序視圖。

public NavigableSet<E> descendingSet() {
        return new TreeSet<>(m.descendingMap());
    }

10、first：返回此 set 中當前第一個（最低）元素。

public E first() {
        return m.firstKey();
    }

剩下的不一一分析，都比較簡單。

四、TreeSet遍歷方式

Iterator順序遍歷

for(Iterator iter = set.iterator(); iter.hasNext(); ) { 
    iter.next();
}   

// 假設set是TreeSet對象
for(Iterator iter = set.descendingIterator(); iter.hasNext(); ) { 
    iter.next();
}

for-each遍歷HashSet

// 假設set是TreeSet對象，並且set中元素是String類型
String[] arr = (String[])set.toArray(new String[0]);
for (String str:arr)
    System.out.printf("for each : %s\n", str);

TreeSet不支持快速隨機遍歷，只能通過迭代器進行遍歷！

測試：

import java.util.*;

public class TreeSetIteratorTest {

    public static void main(String[] args) {
        TreeSet set = new TreeSet();
        set.add("aaa");
        set.add("aaa");
        set.add("bbb");
        set.add("eee");
        set.add("ddd");
        set.add("ccc");

        // 順序遍歷TreeSet
        ascIteratorThroughIterator(set) ;
        // 逆序遍歷TreeSet
        descIteratorThroughIterator(set);
        // 通過for-each遍歷TreeSet。不推薦！此方法需要先將Set轉換為數組
        foreachTreeSet(set);
    }

    // 順序遍歷TreeSet
    public static void ascIteratorThroughIterator(TreeSet set) {
        System.out.print("\n ---- Ascend Iterator ----\n");
        for(Iterator iter = set.iterator(); iter.hasNext(); ) {
            System.out.printf("asc : %s\n", iter.next());
        }
    }

    // 逆序遍歷TreeSet
    public static void descIteratorThroughIterator(TreeSet set) {
        System.out.printf("\n ---- Descend Iterator ----\n");
        for(Iterator iter = set.descendingIterator(); iter.hasNext(); )
            System.out.printf("desc : %s\n", (String)iter.next());
    }

    // 通過for-each遍歷TreeSet。不推薦！此方法需要先將Set轉換為數組
    private static void foreachTreeSet(TreeSet set) {
        System.out.printf("\n ---- For-each ----\n");
        String[] arr = (String[])set.toArray(new String[0]);
        for (String str:arr)
            System.out.printf("for each : %s\n", str);
    }
}

運行結果：

---- Ascend Iterator ----
asc : aaa
asc : bbb
asc : ccc
asc : ddd
asc : eee

 ---- Descend Iterator ----
desc : eee
desc : ddd
desc : ccc
desc : bbb
desc : aaa

 ---- For-each ----
for each : aaa
for each : bbb
for each : ccc
for each : ddd
for each : eee

五、綜合對比

TreeSet和TreeMap
相同點：
TreeMap和TreeSet都是有序的集合。
TreeMap和TreeSet都是非同步集合，因此他們不能在多線程之間共享，不過可以使用方法Collections.synchroinzedMap()來實現同步。
運行速度都要比Hash集合慢，他們內部對元素的操作時間復雜度為O(logN)，而HashMap/HashSet則為O(1)。
不同點：
最主要的區別就是TreeSet和TreeMap非別實現Set和Map接口
TreeSet只存儲一個對象，而TreeMap存儲兩個對象Key和Value（僅僅key對象有序）
TreeSet中不能有重復對象，而TreeMap中可以存在。

 

TreeSet和HashSet
相同點：
都是唯一不重復的Set集合。
不同點：
底層來說，HashSet是用Hash表來存儲數據，而TreeSet是用二叉平衡樹來存儲數據。 功能上來說，由於TreeSet是有序的Set，可以使用SortedSet。接口的first()、last()等方法。但由於要排序，勢必要影響速度。所以，如果不需要順序的話，還是使用HashSet吧，使用Hash表存儲數據的HashSet在速度上更勝一籌。如果需要順序則TreeSet更為明智。
底層來說，HashSet是用Hash表來存儲數據，而TreeSet是用二叉平衡樹來存儲數據。

 

總結：
1、不能有重復的元素；
2、具有排序功能；
3、TreeSet中的元素必須實現Comparable接口並重寫compareTo()方法，TreeSet判斷元素是否重復 、以及確定元素的順序 靠的都是這個方法；
①對於java類庫中定義的類，TreeSet可以直接對其進行存儲，如String，Integer等,因為這些類已經實現了Comparable接口);
②對於自定義類，如果不做適當的處理，TreeSet中只能存儲一個該類型的對象實例，否則無法判斷是否重復。
4、依賴TreeMap。
5、相對HashSet,TreeSet的優勢是有序，劣勢是相對讀取慢。根據不同的場景選擇不同的集合。

整體源碼（1.6）：

package java.util;

public class TreeSet<E> extends AbstractSet<E>
    implements NavigableSet<E>, Cloneable, java.io.Serializable
{
    // NavigableMap對象
    private transient NavigableMap<E,Object> m;

    // TreeSet是通過TreeMap實現的，
    // PRESENT是鍵-值對中的值。
    private static final Object PRESENT = new Object();

    // 不帶參數的構造函數。創建一個空的TreeMap
    public TreeSet() {
        this(new TreeMap<E,Object>());
    }

    // 將TreeMap賦值給 "NavigableMap對象m"
    TreeSet(NavigableMap<E,Object> m) {
        this.m = m;
    }

    // 帶比較器的構造函數。
    public TreeSet(Comparator<? super E> comparator) {
        this(new TreeMap<E,Object>(comparator));
    }

    // 創建TreeSet，並將集合c中的全部元素都添加到TreeSet中
    public TreeSet(Collection<? extends E> c) {
        this();
        // 將集合c中的元素全部添加到TreeSet中
        addAll(c);
    }

    // 創建TreeSet，並將s中的全部元素都添加到TreeSet中
    public TreeSet(SortedSet<E> s) {
        this(s.comparator());
        addAll(s);
    }

    // 返回TreeSet的順序排列的迭代器。
    // 因為TreeSet時TreeMap實現的，所以這里實際上時返回TreeMap的“鍵集”對應的迭代器
    public Iterator<E> iterator() {
        return m.navigableKeySet().iterator();
    }

    // 返回TreeSet的逆序排列的迭代器。
    // 因為TreeSet時TreeMap實現的，所以這里實際上時返回TreeMap的“鍵集”對應的迭代器
    public Iterator<E> descendingIterator() {
        return m.descendingKeySet().iterator();
    }

    // 返回TreeSet的大小
    public int size() {
        return m.size();
    }

    // 返回TreeSet是否為空
    public boolean isEmpty() {
        return m.isEmpty();
    }

    // 返回TreeSet是否包含對象(o)
    public boolean contains(Object o) {
        return m.containsKey(o);
    }

    // 添加e到TreeSet中
    public boolean add(E e) {
        return m.put(e, PRESENT)==null;
    }

    // 刪除TreeSet中的對象o
    public boolean remove(Object o) {
        return m.remove(o)==PRESENT;
    }

    // 清空TreeSet
    public void clear() {
        m.clear();
    }

    // 將集合c中的全部元素添加到TreeSet中
    public  boolean addAll(Collection<? extends E> c) {
        // Use linear-time version if applicable
        if (m.size()==0 && c.size() > 0 &&
            c instanceof SortedSet &&
            m instanceof TreeMap) {
            SortedSet<? extends E> set = (SortedSet<? extends E>) c;
            TreeMap<E,Object> map = (TreeMap<E, Object>) m;
            Comparator<? super E> cc = (Comparator<? super E>) set.comparator();
            Comparator<? super E> mc = map.comparator();
            if (cc==mc || (cc != null && cc.equals(mc))) {
                map.addAllForTreeSet(set, PRESENT);
                return true;
            }
        }
        return super.addAll(c);
    }

    // 返回子Set，實際上是通過TreeMap的subMap()實現的。
    public NavigableSet<E> subSet(E fromElement, boolean fromInclusive,
                                  E toElement,   boolean toInclusive) {
        return new TreeSet<E>(m.subMap(fromElement, fromInclusive,
                                       toElement,   toInclusive));
    }

    // 返回Set的頭部，范圍是：從頭部到toElement。
    // inclusive是是否包含toElement的標志
    public NavigableSet<E> headSet(E toElement, boolean inclusive) {
        return new TreeSet<E>(m.headMap(toElement, inclusive));
    }

    // 返回Set的尾部，范圍是：從fromElement到結尾。
    // inclusive是是否包含fromElement的標志
    public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
        return new TreeSet<E>(m.tailMap(fromElement, inclusive));
    }

    // 返回子Set。范圍是：從fromElement(包括)到toElement(不包括)。
    public SortedSet<E> subSet(E fromElement, E toElement) {
        return subSet(fromElement, true, toElement, false);
    }

    // 返回Set的頭部，范圍是：從頭部到toElement(不包括)。
    public SortedSet<E> headSet(E toElement) {
        return headSet(toElement, false);
    }

    // 返回Set的尾部，范圍是：從fromElement到結尾(不包括)。
    public SortedSet<E> tailSet(E fromElement) {
        return tailSet(fromElement, true);
    }

    // 返回Set的比較器
    public Comparator<? super E> comparator() {
        return m.comparator();
    }

    // 返回Set的第一個元素
    public E first() {
        return m.firstKey();
    }

    // 返回Set的最后一個元素
    public E first() {
    public E last() {
        return m.lastKey();
    }

    // 返回Set中小於e的最大元素
    public E lower(E e) {
        return m.lowerKey(e);
    }

    // 返回Set中小於/等於e的最大元素
    public E floor(E e) {
        return m.floorKey(e);
    }

    // 返回Set中大於/等於e的最小元素
    public E ceiling(E e) {
        return m.ceilingKey(e);
    }

    // 返回Set中大於e的最小元素
    public E higher(E e) {
        return m.higherKey(e);
    }

    // 獲取第一個元素，並將該元素從TreeMap中刪除。
    public E pollFirst() {
        Map.Entry<E,?> e = m.pollFirstEntry();
        return (e == null)? null : e.getKey();
    }

    // 獲取最后一個元素，並將該元素從TreeMap中刪除。
    public E pollLast() {
        Map.Entry<E,?> e = m.pollLastEntry();
        return (e == null)? null : e.getKey();
    }

    // 克隆一個TreeSet，並返回Object對象
    public Object clone() {
        TreeSet<E> clone = null;
        try {
            clone = (TreeSet<E>) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new InternalError();
        }

        clone.m = new TreeMap<E,Object>(m);
        return clone;
    }

    // java.io.Serializable的寫入函數
    // 將TreeSet的“比較器、容量，所有的元素值”都寫入到輸出流中
    private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException {
        s.defaultWriteObject();

        // 寫入比較器
        s.writeObject(m.comparator());

        // 寫入容量
        s.writeInt(m.size());

        // 寫入“TreeSet中的每一個元素”
        for (Iterator i=m.keySet().iterator(); i.hasNext(); )
            s.writeObject(i.next());
    }

    // java.io.Serializable的讀取函數：根據寫入方式讀出
    // 先將TreeSet的“比較器、容量、所有的元素值”依次讀出
    private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        // Read in any hidden stuff
        s.defaultReadObject();

        // 從輸入流中讀取TreeSet的“比較器”
        Comparator<? super E> c = (Comparator<? super E>) s.readObject();

        TreeMap<E,Object> tm;
        if (c==null)
            tm = new TreeMap<E,Object>();
        else
            tm = new TreeMap<E,Object>(c);
        m = tm;

        // 從輸入流中讀取TreeSet的“容量”
        int size = s.readInt();

        // 從輸入流中讀取TreeSet的“全部元素”
        tm.readTreeSet(size, s, PRESENT);
    }

    // TreeSet的序列版本號
    private static final long serialVersionUID = -2479143000061671589L;
}