TreeSet 源碼分析

public class TreeSet<E> extends AbstractSet<E> implements NavigableSet<E>, Cloneable, java.io.Serializable {
    // 底層是使用的 NavigableMap 來存儲元素
    // 指定爲 transient 默認序列化洗出寫入的時候會忽略它，然後續的操做須要依次遍歷寫入方法
    // 看 writeObject 和 readObject
    private transient NavigableMap<E,Object> m;

    // 虛擬對象用於放入 map value 中
    private static final Object PRESENT = new Object();

    // 同包的構造方法，能夠看到傳入的類型不必定就是 TreeMap
    TreeSet(NavigableMap<E,Object> m) {
        this.m = m;
    }

    // TreeSet 默認是經過 TreeMap 來實現的
    public TreeSet() {
        this(new TreeMap<E,Object>());
    }

    /** * TreeSet 是有序的，它的有序是依賴於 NavigableMap -> SortedMap 的 * SortedMap 的有序性實現 Comparable 接口或者傳入 Comparator 比較器 * 具體細節看 SortedMap 分析 * 此處傳入了 Comparator 用起比較器來進行排序 * @param comparator */
    public TreeSet(Comparator<? super E> comparator) {
        this(new TreeMap<>(comparator));
    }

    // 傳入集合構建 TreeMap 而且調用 addAll() 將數據依次加入 map 中
    public TreeSet(Collection<? extends E> c) {
        this();
        addAll(c);
    }

    // 若是傳入的是 SortedSet 的則建立 Map 時候須要指定其 Comparator 保存排序的一致性
    // 再將數據依次放入
    public TreeSet(SortedSet<E> s) {
        this(s.comparator());
        addAll(s);
    }

    // 返回 map 的迭代器，其實是遍歷 map 的 key
    public Iterator<E> iterator() {
        return m.navigableKeySet().iterator();
    }

    // 返回逆序的 map 迭代器
    public Iterator<E> descendingIterator() {
        return m.descendingKeySet().iterator();
    }

    // 以逆序的方式建立一個新的 TreeSet 並返回
    public NavigableSet<E> descendingSet() {
        return new java.util.TreeSet<>(m.descendingMap());
    }


    public int size() {
        return m.size();
    }

    public boolean isEmpty() {
        return m.isEmpty();
    }

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

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

    public boolean remove(Object o) {
        return m.remove(o)==PRESENT;
    }

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

    // 將集合全部元素放入 TreeSet 中
    public boolean addAll(Collection<? extends E> c) {
        // 知足該條件就能夠調用 addAllForTreeSet 直接放入 map 中
        // map 方法具體的細節請看 Map 章節對應的源碼分析
        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<?> cc = set.comparator();
            Comparator<? super E> mc = map.comparator();
            if (cc==mc || (cc != null && cc.equals(mc))) {
                map.addAllForTreeSet(set, PRESENT);
                return true;
            }
        }
        // 若是不知足條件這調用父類的 addAll(c) 挨個添加
        return super.addAll(c);
    }

    /** * 截取 from, to 之間的元素 * @param fromElement 截取的起始元素 * @param fromInclusive 是否包含起始元素數據 * @param toElement 截取的終止元素 * @param toInclusive 是否包含終止的元素 * @return */
    public NavigableSet<E> subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive) {
        return new java.util.TreeSet<>(m.subMap(fromElement, fromInclusive,
                toElement,   toInclusive));
    }

    /** * 從頭部開始截取到 toElement 元素 * @param toElement 終止元素 * @param inclusive 是否包含終止元素 * @return */
    public NavigableSet<E> headSet(E toElement, boolean inclusive) {
        return new java.util.TreeSet<>(m.headMap(toElement, inclusive));
    }

    /** * 截取 from 到 treeSet 的最後一個元素 * @param fromElement 起始元素 * @param inclusive 是否包含起始元素 * @return */
    public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
        return new java.util.TreeSet<>(m.tailMap(fromElement, inclusive));
    }

    /** * 截取 [from, to) 之間的元素 * @param fromElement * @param toElement * @return */
    public SortedSet<E> subSet(E fromElement, E toElement) {
        return subSet(fromElement, true, toElement, false);
    }

    /** * 截取 [TreeSet 的第一個元素, to) 之間的元素 * @param toElement * @return */
    public SortedSet<E> headSet(E toElement) {
        return headSet(toElement, false);
    }

    /** * 截取 [from, TreeSet 最後一個元素] 之間的元素 * @param fromElement * @return */
    public SortedSet<E> tailSet(E fromElement) {
        return tailSet(fromElement, true);
    }

    /** * 返回 Comparator * @return */
    public Comparator<? super E> comparator() {
        return m.comparator();
    }

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

    public E last() {
        return m.lastKey();
    }

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

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

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

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

    // 彈出第一個元素
    public E pollFirst() {
        Map.Entry<E,?> e = m.pollFirstEntry();
        return (e == null) ? null : e.getKey();
    }

    // 彈出最後一個元素
    public E pollLast() {
        Map.Entry<E,?> e = m.pollLastEntry();
        return (e == null) ? null : e.getKey();
    }

    // clone 方法
    @SuppressWarnings("unchecked")
    public Object clone() {
        java.util.TreeSet<E> clone;
        try {
            // clone 父類的基礎屬性
            clone = (java.util.TreeSet<E>) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new InternalError(e);
        }

        // 建立一個新的 map 深拷貝
        clone.m = new TreeMap<>(m);
        return clone;
    }

    // 序列化寫出方法
    private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException {
        // Write out any hidden stuff
        s.defaultWriteObject();

        // Write out Comparator
        s.writeObject(m.comparator());

        // Write out size
        s.writeInt(m.size());

        // Write out all elements in the proper order.
        for (E e : m.keySet())
            s.writeObject(e);
    }

    // 序列化寫入方法
    private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, ClassNotFoundException {
        // Read in any hidden stuff
        s.defaultReadObject();

        // Read in Comparator
        @SuppressWarnings("unchecked")
        Comparator<? super E> c = (Comparator<? super E>) s.readObject();

        // Create backing TreeMap
        TreeMap<E,Object> tm = new TreeMap<>(c);
        m = tm;

        // Read in size
        int size = s.readInt();

        tm.readTreeSet(size, s, PRESENT);
    }

    // 返回能夠分割的迭代器
    public Spliterator<E> spliterator() {
        return TreeMap.keySpliteratorFor(m);
    }

    // 序列化 id
    private static final long serialVersionUID = -2479143000061671589L;
}

複製代碼

總結

• TreeSet 底層是使用 NavigableMap 來存儲元素的，NavigableMap 的默認狀況下是 TreeMap

• TreeSet 是有序的，他的有序依賴於 NavigableMap -> SortedMap 的有序性

  • SortedMap 的有序性依賴於天然排序的有序性，而天然排序的有序性又有兩種實現方法
  • 一種是 key 實現 Comparable 接口，一種是構造方法傳入 Comparator

• TreeSet 和 LinkedHashSet 的區別

  • LinkedHashSet 的有序性是依賴 LinkedHashMap 插入順序的有序性

  • TreeSet 的底層實現是 NavigableMap 默認是 TreeMap

  • LinkedHashMap 的底層實現是 LinkedHashMap

  • LinkedHashSet 並無實現 SortedSet 接口，由於他的有序主要依賴於 LinkedHashMap 的有序性，指的是按照插入順序，此時就算設置他的比較器也沒有意義由於只會按照插入順序排序

  • 而 TreeSet 的兩種排序方式以下

• TreeSet 是非線程安全的

• TreeSet 實現了 NavigableSet 接口，NavigableSet 又實現 SortedSet 接口

  • SortedSet 定義了有序 Set 必須須要實現的一些公用的方法好比 comparator(), subSet(), headSet(), tailSet(), first() 等等
  • NavigableSet 接口在此基礎上多了一些它特有的方法，lower(), floor(), ceiling() 等等