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() 等等