JDK1.8源码阅读记录TreeSet类

JDK1.8源码阅读记录

JAVA.Util包

TreeSet类

说明

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

TreeSet可克隆，序列化，不是线程安全的，基于TreeMap实现。
TreeSet类跟TreeMap类相似，也是底层原理基于红黑树实现的类，可保证在log(n)时间复杂度内完成 contains、add 和 remove 操作，效率很高。另外，由于是基于红黑树实现，因此TreeSet的键也是有序的。

TreeSet实现了NavigableSet接口，而NavigableSet接口继承于SortedSet接口，

public interface NavigableSet<E> extends SortedSet<E>

SortedSet接口中声明了一个返回比较器的方法

Comparator<? super E> comparator();

和SortedMap一样，支持自然排序和自定义排序。自然排序要求添加到Set中的元素实现Comparable接口，自定义排序要求实现一个Comparator比较器。

源码分析

首先看第一段源码，这是TreeSet是基于TreeMap实现的基础。

	private transient NavigableMap<E,Object> m;

    // Dummy value to associate with an Object in the backing Map
    private static final Object PRESENT = new Object();

在TreeSet源码中，只有三个属性，其中一个是序列化ID，其他两个便是上图的两个属性。
在这里，m声明了NavigableMap，用来保存元素。上文说过TreeSet是基于TreeMap实现，那为什么这里不是TreeMap而是NavigableMap？我们知道，TreeMap实现了NavigableMap接口，可以在TreeSet构造方法中实例化TreeMap，而在这里使用NavigableMap声明，可以让TreeSet更加灵活。
PRESENT 和HashSet中的PRESENT作用一样，作为固定Value值进行占位的。

构造方法

    public TreeSet() {
        this(new TreeMap<E,Object>());
    }
	public TreeSet(Comparator<? super E> comparator) {
        this(new TreeMap<>(comparator));
    }
    public TreeSet(Collection<? extends E> c) {
        this();
        addAll(c);
    }
    public TreeSet(SortedSet<E> s) {
        this(s.comparator());
        addAll(s);
    }
    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);
    }

TreeSet构造方法有四个，这四个构造方法内部代码中均出现了TreeMap类的声明，验证了我们之前说的“在TreeSet构造方法中实例化TreeMap”。

增删操作

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

增加删除元素操作，和HashSet的实现一样，也是利用了Map保存的Key-Value键值对的Key不会重复的特点。

导航方法

public E first() {
        return m.firstKey(); // 返回第一个元素
    }
    
public E lower(E e) {
        return m.lowerKey(e); // 返回小于e的第一个元素
    }
    
public NavigableSet<E> headSet(E toElement, boolean inclusive) {
        return new TreeSet<>(m.headMap(toElement, inclusive)); // 取前几个元素构成子集
    }
    
public E pollFirst() { // 弹出第一个元素
        Map.Entry<E,?> e = m.pollFirstEntry();
        return (e == null) ? null : e.getKey();
    }

public NavigableSet<E> descendingSet() { // 倒排Set
        return new TreeSet<>(m.descendingMap());
    }

本类实现了NavigableSet，自然要对NavigableSet接口中的导航方法进行实现，而他们的实现均是调用m对象也就是TreeMap类中的导航方法，这也就说明了TreeSet是基于TreeMap实现的。

小结

1. TreeSet是基于TreeMap实现的，支持自然排序和自定义排序，
2. TreeSet不允许null值，
3. TreeSet不是线程安全的，
4. TreeSet实现了descendingIterator，可以进行逆序输出，
5. TreeSet基本操作的时间复杂度为log（n）。