死磕 java集合之TreeSet源碼分析

問題

（1）TreeSet真的是使用TreeMap來存儲(chǔ)元素的嗎？

（2）TreeSet是有序的嗎？

（3）TreeSet和LinkedHashSet有何不同？

簡介

TreeSet底層是采用TreeMap實(shí)現(xiàn)的一種Set，所以它是有序的，同樣也是非線程安全的。

源碼分析

經(jīng)過前面我們學(xué)習(xí)HashSet和LinkedHashSet，基本上已經(jīng)掌握了Set實(shí)現(xiàn)的套路了。

所以，也不廢話了，直接上源碼：

package java.util;

// TreeSet實(shí)現(xiàn)了NavigableSet接口，所以它是有序的
public class TreeSet<E> extends AbstractSet<E>
    implements NavigableSet<E>, Cloneable, java.io.Serializable
{
    // 元素存儲(chǔ)在NavigableMap中
    // 注意它不一定就是TreeMap
    private transient NavigableMap<E,Object> m;

    // 虛擬元素, 用來作為value存儲(chǔ)在map中
    private static final Object PRESENT = new Object();

    // 直接使用傳進(jìn)來的NavigableMap存儲(chǔ)元素
    // 這里不是深拷貝,如果外面的map有增刪元素也會(huì)反映到這里
    // 而且, 這個(gè)方法不是public的, 說明只能給同包使用
    TreeSet(NavigableMap<E,Object> m) {
        this.m = m;
    }

    // 使用TreeMap初始化
    public TreeSet() {
        this(new TreeMap<E,Object>());
    }

    // 使用帶comparator的TreeMap初始化
    public TreeSet(Comparator<? super E> comparator) {
        this(new TreeMap<>(comparator));
    }

    // 將集合c中的所有元素添加的TreeSet中
    public TreeSet(Collection<? extends E> c) {
        this();
        addAll(c);
    }

    // 將SortedSet中的所有元素添加到TreeSet中
    public TreeSet(SortedSet<E> s) {
        this(s.comparator());
        addAll(s);
    }

    // 迭代器
    public Iterator<E> iterator() {
        return m.navigableKeySet().iterator();
    }

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

    // 以逆序返回一個(gè)新的TreeSet
    public NavigableSet<E> descendingSet() {
        return new TreeSet<>(m.descendingMap());
    }

    // 元素個(gè)數(shù)
    public int size() {
        return m.size();
    }

    // 判斷是否為空
    public boolean isEmpty() {
        return m.isEmpty();
    }

    // 判斷是否包含某元素
    public boolean contains(Object o) {
        return m.containsKey(o);
    }

    // 添加元素, 調(diào)用map的put()方法, value為PRESENT
    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();
    }

    // 添加集合c中的所有元素
    public  boolean addAll(Collection<? extends E> c) {
        // 滿足一定條件時(shí)直接調(diào)用TreeMap的addAllForTreeSet()方法添加元素
        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;
            }
        }
        // 不滿足上述條件, 調(diào)用父類的addAll()通過遍歷的方式一個(gè)一個(gè)地添加元素
        return super.addAll(c);
    }

    // 子set（NavigableSet中的方法）
    public NavigableSet<E> subSet(E fromElement, boolean fromInclusive,
                                  E toElement,   boolean toInclusive) {
        return new TreeSet<>(m.subMap(fromElement, fromInclusive,
                                       toElement,   toInclusive));
    }

    // 頭set（NavigableSet中的方法）
    public NavigableSet<E> headSet(E toElement, boolean inclusive) {
        return new TreeSet<>(m.headMap(toElement, inclusive));
    }

    // 尾set（NavigableSet中的方法）
    public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
        return new TreeSet<>(m.tailMap(fromElement, inclusive));
    }

    // 子set（SortedSet接口中的方法）
    public SortedSet<E> subSet(E fromElement, E toElement) {
        return subSet(fromElement, true, toElement, false);
    }

    // 頭set（SortedSet接口中的方法）
    public SortedSet<E> headSet(E toElement) {
        return headSet(toElement, false);
    }

    // 尾set（SortedSet接口中的方法）
    public SortedSet<E> tailSet(E fromElement) {
        return tailSet(fromElement, true);
    }

    // 比較器
    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();
    }

    // 克隆方法
    @SuppressWarnings("unchecked")
    public Object clone() {
        TreeSet<E> clone;
        try {
            clone = (TreeSet<E>) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new InternalError(e);
        }

        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;
}

源碼比較簡單，基本都是調(diào)用map相應(yīng)的方法。

總結(jié)

（1）TreeSet底層使用NavigableMap存儲(chǔ)元素；

（2）TreeSet是有序的；

（3）TreeSet是非線程安全的；

（4）TreeSet實(shí)現(xiàn)了NavigableSet接口，而NavigableSet繼承自SortedSet接口；

（5）TreeSet實(shí)現(xiàn)了SortedSet接口；（彤哥年輕的時(shí)候面試被問過TreeSet和SortedSet的區(qū)別^^）

彩蛋

（1）通過之前的學(xué)習(xí)，我們知道TreeSet和LinkedHashSet都是有序的，那它們有何不同？

LinkedHashSet并沒有實(shí)現(xiàn)SortedSet接口，它的有序性主要依賴于LinkedHashMap的有序性，所以它的有序性是指按照插入順序保證的有序性；

而TreeSet實(shí)現(xiàn)了SortedSet接口，它的有序性主要依賴于NavigableMap的有序性，而NavigableMap又繼承自SortedMap，這個(gè)接口的有序性是指按照key的自然排序保證的有序性，而key的自然排序又有兩種實(shí)現(xiàn)方式，一種是key實(shí)現(xiàn)Comparable接口，一種是構(gòu)造方法傳入Comparator比較器。

（2）TreeSet里面真的是使用TreeMap來存儲(chǔ)元素的嗎？

通過源碼分析我們知道TreeSet里面實(shí)際上是使用的NavigableMap來存儲(chǔ)元素，雖然大部分時(shí)候這個(gè)map確實(shí)是TreeMap，但不是所有時(shí)候都是TreeMap。

因?yàn)橛幸粋€(gè)構(gòu)造方法是TreeSet(NavigableMap<E,Object> m)，而且這是一個(gè)非public方法，通過調(diào)用關(guān)系我們可以發(fā)現(xiàn)這個(gè)構(gòu)造方法都是在自己類中使用的，比如下面這個(gè)：

    public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
        return new TreeSet<>(m.tailMap(fromElement, inclusive));
    }

而這個(gè)m我們姑且認(rèn)為它是TreeMap，也就是調(diào)用TreeMap的tailMap()方法：

    public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive) {
        return new AscendingSubMap<>(this,
                                     false, fromKey, inclusive,
                                     true,  null,    true);
    }

可以看到，返回的是AscendingSubMap對(duì)象，這個(gè)類的繼承鏈?zhǔn)窃趺礃拥哪兀?/p>

可以看到，這個(gè)類并沒有繼承TreeMap，不過通過源碼分析也可以看出來這個(gè)類是組合了TreeMap，也算和TreeMap有點(diǎn)關(guān)系，只是不是繼承關(guān)系。

所以，TreeSet的底層不完全是使用TreeMap來實(shí)現(xiàn)的，更準(zhǔn)確地說，應(yīng)該是NavigableMap。

歡迎關(guān)注我的公眾號(hào)“彤哥讀源碼”，查看更多源碼系列文章, 與彤哥一起暢游源碼的海洋。