JDK之TreeSet源码解析_inurl jdk treeset-优快云博客

本文链接：https://blog.youkuaiyun.com/wxl1234579/article/details/59536670

刚入java不久的程序猿，对于简单的使用已毫不满足，最终为了一探究竟，翻开了JDK的源码，以下观点为自己的理解及看了多篇博客的总结，欢迎各位大神指出不对的地方，当然也欢迎和我一样刚学的同学，一起加油努力吧~~

TreeSet源码解析

刚写完TreeMap，准备下手看看TreeSet是如何实现的，打开源码后，突然就没有了写这篇的冲动，然而想想为了补齐集合类的分析，还是写了这篇，相信之前看过源码的同学应该知道HashMap与HashSet是如何实现的，可以说懂了HashMap就懂了HashSet，毕竟HashSet是在HashMap的基础上来实现的，TreeSet也一样，是基于TreeMap来进行实现的，下面贴出代码，大家可以看看，就不做过多的解释了

public class TreeSet<E> extends AbstractSet<E>
    implements NavigableSet<E>, Cloneable, java.io.Serializable
{
    /**
     * 一个用于返回的map
     */
    private transient NavigableMap<E,Object> m;

    // 替代map的value值，虚值
    private static final Object PRESENT = new Object();

    /**
     * 构造方法，参数为NavigableMap
     */
    TreeSet(NavigableMap<E,Object> m) {
        this.m = m;
    }

    /**
     * 基于TreeMap的无参构造
     */
    public TreeSet() {
        this(new TreeMap<E,Object>());
    }

    /**
     * 基于TreeMap的构造，参数为比较器
     */
    public TreeSet(Comparator<? super E> comparator) {
        this(new TreeMap<>(comparator));
    }

    /**
     * 基于TreeMap的构造，参数为集合
     */
    public TreeSet(Collection<? extends E> c) {
        this();
        addAll(c);
    }

    /**
     * 基于TreeMap的构造，参数为SortedSet
     */
    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();
    }

    public NavigableSet<E> descendingSet() {
        return new 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();
    }

    /**
     * 将集合c中对象添加进map中
     */
    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<? super E> cc = (Comparator<? super E>) 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);
    }

    /**
     * 返回从fromElement到toElement的对象集合
     */
    public NavigableSet<E> subSet(E fromElement, boolean fromInclusive,
                                  E toElement,   boolean toInclusive) {
        return new TreeSet<>(m.subMap(fromElement, fromInclusive,
                                       toElement,   toInclusive));
    }

    /**
     * 返回从比toElement小的对象集合
     */
    public NavigableSet<E> headSet(E toElement, boolean inclusive) {
        return new TreeSet<>(m.headMap(toElement, inclusive));
    }

    /**
     * 返回比fromElement大的对象集合
     */
    public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
        return new TreeSet<>(m.tailMap(fromElement, inclusive));
    }

    /**
     * 与subSet(E fromElement, boolean fromInclusive,E toElement,   boolean toInclusive)相同
     */
    public SortedSet<E> subSet(E fromElement, E toElement) {
        return subSet(fromElement, true, toElement, false);
    }

    /**
     * 与headSet(E toElement, boolean inclusive)相同
     */
    public SortedSet<E> headSet(E toElement) {
        return headSet(toElement, false);
    }

    /**
     * 与tailSet(E fromElement, boolean inclusive)相同
     */
    public SortedSet<E> tailSet(E fromElement) {
        return tailSet(fromElement, true);
    }

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

    /**
     * 返回map的第一个key
     */
    public E first() {
        return m.firstKey();
    }

    /**
     * 返回map的最后一个key
     */
    public E last() {
        return m.lastKey();
    }

    /**
     * 返回最大且小于参数key的key
     */
    public E lower(E e) {
        return m.lowerKey(e);
    }

    /**
     * 返回最大且小于等于参数key的key
     */
    public E floor(E e) {
        return m.floorKey(e);
    }

    /**
     * 返回最小且大于等于参数key的key
     */
    public E ceiling(E e) {
        return m.ceilingKey(e);
    }

    /**
     * 返回最小且大于参数key的key
     */
    public E higher(E e) {
        return m.higherKey(e);
    }

    /**
     * 删除最小key值的entry并返回key值
     */
    public E pollFirst() {
        Map.Entry<E,?> e = m.pollFirstEntry();
        return (e == null) ? null : e.getKey();
    }

    /**
     * 删除最大key值的entry并返回key值
     */
    public E pollLast() {
        Map.Entry<E,?> e = m.pollLastEntry();
        return (e == null) ? null : e.getKey();
    }

    /**
     * 重写的clone方法
     */
    public Object clone() {
        TreeSet<E> clone = null;
        try {
            clone = (TreeSet<E>) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new InternalError();
        }

        clone.m = new TreeMap<>(m);
        return clone;
    }

    /**
     * 重写的writeObject方法
     */
    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);
    }

    /**
     * 重写的readObject方法
     */ 
    private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        // Read in any hidden stuff
        s.defaultReadObject();

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

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

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

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

    private static final long serialVersionUID = -2479143000061671589L;
}