Java基础知识之容器（六：TreeSet详解）

java框架系列文章相关地址：

Java基础知识之容器（一：容器整体框架探索）
Java基础知识之容器（二：ArrayList详解）
Java基础知识之容器（三：LinkedList详解）
Java基础知识之容器（四：Vector详解）
Java基础知识之容器（五：HashSet详解）
Java基础知识之容器（六：TreeSet详解）
Java基础知识之容器（七：HashMap详解）
Java基础知识之容器（八：HashMap在jdk8数据结构的改进）

一：TreeSet简介

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

• TreeSet继承于AbstractSet 该类提供了Set 接口的骨架实现，以最大限度地减少实现此接口所需的工作量。
• TreeSet实现了NavigableSet接口，意味着它支持一系列的导航方法。比如查找与指定目标最匹配项。
• 实现Cloneable接口，意味着可以它可以被复制。
• 实现Serializable接口，意味着可被序列化。

TreeSet是基于TreeMap实现的。TreeSet中的元素支持2种排序方式：自然排序 或者 根据创建TreeSet 时提供的 Comparator 进行排序。这取决于使用的构造方法。
TreeSet为基本操作（add、remove 和 contains）提供受保证的 log(n) 时间开销。
另外，TreeSet是非同步的。 它的iterator 方法返回的迭代器是fail-fast的。

二：TreeSet源码

public class TreeSet<E> extends AbstractSet<E>
    implements NavigableSet<E>, Cloneable, java.io.Serializable
{
    //使用NavigableMap来保存TreeSet元素
    private transient NavigableMap<E,Object> m;

    // 与NavigableMap中的对象关联的虚拟值
    private static final Object PRESENT = new Object();

    /**
     * 构造由指定的NavigableMap的集合。
     */
    TreeSet(NavigableMap<E,Object> m) {
        this.m = m;
    }

    /**
     * 构造一个新的空TreeSet，根据元素的自然排序进行排序。 插入到集合中的所有元素都必须实现Comparable接口。 
     * 此外，所有这些元素必须可以相互比较 如果用户尝试向违反此约束的集合添加元素，那么add调用将抛出一个
     * ClassClassException。
     */
    public TreeSet() {
        this(new TreeMap<E,Object>());
    }

    /**
     * 构造一个新的空TreeSet，根据指定的比较器进行排序。 插入到集合中的所有元素必须与指定的比较器可相互比较
     * 如果用户尝试向违反此约束的集合添加元素，那么add调用将抛出ClassCastException。
     */
    public TreeSet(Comparator<? super E> comparator) {
        this(new TreeMap<>(comparator));
    }

    /**
     *构造一个新的TreeSet，其中包含指定集合中的元素，并根据元素的 自然排序 进行排序。 
     *插入到集合中的所有元素都必须实现 Comparable接口。 此外，所有这些元素必须可以相互比较
     */
    public TreeSet(Collection<? extends E> c) {
        this();
        addAll(c);
    }

    /**
     * 构造一个包含相同元素并使用与指定的排序集相同顺序的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();
    }

    /**
     * @since 1.6
     */
    public NavigableSet<E> descendingSet() {
        return new TreeSet<>(m.descendingMap());
    }

    /**
     * 返回此集合中元素的数量（基数）。返回此集合中元素的数量。
     */
    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<?> cc = 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<>(m.subMap(fromElement, fromInclusive,
                                       toElement,   toInclusive));
    }

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

    /**
     * 返回Set的尾部，范围是：从fromElement到结尾。
     * inclusive是是否包含fromElement的标志
     */
    public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
        return new TreeSet<>(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 last() {
        return m.lastKey();
    }

    // NavigableSet API methods

    /**
     * 返回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对象
     */
    @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;
    }

    /**
     * java.io.Serializable的写入函数
     *将TreeSet的“比较器、容量，所有的元素值”都写入到输出流中
     */
    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);
    }

    /**
     *  java.io.Serializable的读取函数：根据写入方式读出
     *  先将TreeSet的“比较器、容量、所有的元素值”依次读出
     */
    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);
    }

    private static final long serialVersionUID = -2479143000061671589L;
}

三：总结

• TreeSet实际上是TreeMap实现的。当我们构造TreeSet时；若使用不带参数的构造函数，则TreeSet的使用自然比较器；若用户需要使用自定义的比较器，则需要使用带比较器的参数。
• TreeSet是非线程安全的。
• TreeSet实现java.io.Serializable的方式。当写入到输出流时，依次写入“比较器、容量、全部元素”；当读出输入流时，再依次读取。