Java經常使用數據結構之Set之TreeSet

前言

上篇文章咱們分析了HashSet，它是基於HashMap實現的，那TreeSet會是怎麼實現的呢？沒錯！和你們想的同樣，它是基於TreeMap實現的。因此，TreeSet的源碼也很簡單，主要仍是理解TreeMap。

TreeSet的繼承關係

按照慣例，先來看TreeSet類的繼承關係：

public class TreeSet<E> extends AbstractSet<E> implements NavigableSet<E>, Cloneable, java.io.Serializable 複製代碼

1. 絕不意外的繼承了抽象類AbstracSet，方便擴展；
2. 實現了一個NavigableSet接口，和NavigableMap接口相似，提供了各類導航方法；
3. 實現了Cloneable接口，能夠克隆；
4. 實現了Serializable接口，能夠序列化；

這裏主要看NavigableSet接口類：

public interface NavigableSet<E> extends SortedSet<E> 複製代碼

熟悉的味道，繼承SortedSet接口。SortedSet則提供了一個返回比較器的方法：

Comparator<? super E> comparator();
複製代碼

和SortedMap同樣，支持天然排序和自定義排序。天然排序要求添加到Set中的元素實現Comparable接口，自定義排序要求實現一個Comparator比較器。

源碼分析

關鍵點

關鍵點天然是TreeSet如何保證元素不重複以及元素有序的，前面說了它是基於TreeMap實現的，那咱們來看看吧。

private transient NavigableMap<E,Object> m; // 保證有序

// Dummy value to associate with an Object in the backing Map
private static final Object PRESENT = new Object(); // 固定Value
複製代碼

縱觀TreeSet源碼，發現只有這兩個屬性（還有個uid，這裏就不算了）。很明顯，m是用來保存元素的，但m聲明的是NavigableMap而不是TreeMap。能夠猜想，TreeMap應該是在構造方法裏實例化的，這裏使用NavigableMap可讓TreeSet更加靈活。PRESENT和HashSet中的PRESENT做用同樣，做爲固定Value值進行佔位的。
再看add和remove方法：

public boolean add(E e) {
        return m.put(e, PRESENT)==null;
    }
    
public boolean remove(Object o) {
        return m.remove(o)==PRESENT;
    }
複製代碼

和HashSet的實現同樣，也是利用了Map保存的Key-Value鍵值對的Key不會重複的特色。

構造函數

果真，TreeSet中的TreeMap是在構造函數中初始化的。

public TreeSet() {
        this(new TreeMap<>()); // 默認天然排序的TreeMap
    }

public TreeSet(Comparator<? super E> comparator) {
        this(new TreeMap<>(comparator)); // 自定義比較器的TreeMap
    }
    
public TreeSet(Collection<? extends E> c) {
        this(); // 仍是用的默認
        addAll(c); // 將元素一個一個添加到TreeMap中
    }
 
 public TreeSet(SortedSet<E> s) {
        this(s.comparator()); // 使用傳入的SortedSet的比較器
        addAll(s); // 一個一個添加元素
    }   
複製代碼

默認實例化了一個天然排序的TreeMap，固然，咱們能夠自定義比較器。
這裏跟蹤下addAll方法：

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; // 強轉成TreeMap
            Comparator<?> cc = set.comparator();
            Comparator<? super E> mc = map.comparator();
            if (cc==mc || (cc != null && cc.equals(mc))) { // 要保證set和map的比較器同樣
                map.addAllForTreeSet(set, PRESENT); // TreeMap專門爲TreeSet準備的方法
                return true;
            }
        }
        return super.addAll(c);
    }
複製代碼

調用了TreeMap的addAllForTreeSet方法：

void addAllForTreeSet(SortedSet<? extends K> set, V defaultVal) {
        try {
            buildFromSorted(set.size(), set.iterator(), null, defaultVal);
        } catch (java.io.IOException | ClassNotFoundException cannotHappen) {
        }
    }
複製代碼

看到buildFromSorted，應該很熟悉，在TreeMap的文章中分析過。該方法將傳入的集合元素構形成了一棵最底層的結點爲紅色，而其餘結點都是黑色的紅黑樹。

導航方法

既然實現了NavigableSet，那各類導航方法天然少不了。它們的實現也很簡單，直接調用m對應的導航方法便可。例如：

public E first() {
        return m.firstKey(); // 返回第一個元素
    }
    
public E lower(E e) {
        return m.lowerKey(e); // 返回小於e的第一個元素
    }
    
public NavigableSet<E> headSet(E toElement, boolean inclusive) {
        return new TreeSet<>(m.headMap(toElement, inclusive)); // 取前幾個元素構成子集
    }
    
public E pollFirst() { // 彈出第一個元素
        Map.Entry<E,?> e = m.pollFirstEntry();
        return (e == null) ? null : e.getKey();
    }

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

......
複製代碼

這裏須要注意的是返回子集合的方法，例如：headSet。返回的子集合是能夠添加和刪除元素的，可是有邊界限制，舉個栗子。

// 前面構造了一個存儲Int的Set
        // 三、五、七、9
        SortedSet<Integer> subSet = intSet.headSet(8); // 最大值7，超過7越界
        for (Integer sub : subSet) {
            System.out.println(sub);
        }

        subSet.add(2);
// subSet.add(8); // 越界了
        subSet.remove(3);
        for (Integer sub : subSet) {
            System.out.println(sub);
        }
複製代碼

TreeSet也是支持逆序輸出的，由於有descendingIterator的實現：

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

總結

1. TreeSet是基於TreeMap實現的，支持天然排序和自定義排序，能夠進行逆序輸出；
2. TreeSet不容許null值；
3. TreeSet不是線程安全的，多線程環境下可使用SortedSet s = Collections.synchronizedSortedSet(new TreeSet(...))；

關注微信公衆號，最新技術乾貨實時推送