TreeSet源码分析

TreeSet

TreeSet简介

java.lang.Object
   ↳     java.util.AbstractCollection
         ↳     java.util.AbstractSet
               ↳     java.util.TreeSet

public class TreeSet extends AbstractSet        
    implements NavigableSet, Cloneable, java.io.Serializable{}

image.png

TreeSet 是一个有序的集合，它的作用是提供有序的Set集合。它继承于AbstractSet抽象类，实现了NavigableSet, Cloneable, java.io.Serializable接口。
TreeSet 继承于AbstractSet，所以它是一个Set集合，具有Set的属性和方法。
TreeSet 实现了NavigableSet接口，意味着它支持一系列的导航方法。比如查找与指定目标最匹配项。
TreeSet 实现了Cloneable接口，意味着它能被克隆。
TreeSet 实现了java.io.Serializable接口，意味着它支持序列化。

TreeSet是基于TreeMap实现的。TreeSet中的元素支持2种排序方式：自然排序 或者 根据创建TreeSet 时提供的 Comparator 进行排序。这取决于使用的构造方法。
TreeSet的本质是一个“有序的，并且没有重复元素”的集合，它是通过TreeMap实现的。TreeSet中含有一个“NavigableMap类型的成员变量”m，而m实际上是"TreeMap的实例"。
TreeSet为基本操作（add、remove 和 contains）提供受保证的 log(n) 时间开销。
另外，TreeSet是非同步的。 它的iterator 方法返回的迭代器是fail-fast的。

TreeSet的构造函数

// 不带参数的构造函数。以自然排序方法创建一个空的TreeMap
public TreeSet() {
    this(new TreeMap());
}

// 将TreeMap赋值给 "NavigableMap对象m"
TreeSet(NavigableMap m) {
    this.m = m;
}

// 带比较器的构造函数。以定制排序的方式创建一个新的TreeMap。
public TreeSet(Comparator comparator) {
    this(new TreeMap(comparator));
}

// 创建TreeSet，并将集合c中的全部元素都添加到TreeSet中
public TreeSet(Collection c) {
    this();
    // 将集合c中的元素全部添加到TreeSet中
    addAll(c);
}

// 创建TreeSet，并将s中的全部元素都添加到TreeSet中
public TreeSet(SortedSet s) {
    this(s.comparator());
    addAll(s);
}

TreeSet属性

• private transient NavigableMap m

使用NavigableMap对象的key来保存Set集合的元素。

• private static final Object PRESENT = new Object()

使用PRESENT作为Map集合中的value。

TreeSet方法

// 返回TreeSet的顺序排列的迭代器。
// 因为TreeSet时TreeMap实现的，所以这里实际上时返回TreeMap的“键集”对应的迭代器
public Iterator iterator() {
    return m.navigableKeySet().iterator();
}

// 返回TreeSet的逆序排列的迭代器。
// 因为TreeSet时TreeMap实现的，所以这里实际上时返回TreeMap的“键集”对应的迭代器
public Iterator descendingIterator() {
    return m.descendingKeySet().iterator();
}

// 返回TreeSet的大小
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 c) {
    // Use linear-time version if applicable
    if (m.size()==0 && c.size() > 0 &&
        c instanceof SortedSet &&
        m instanceof TreeMap) {
        SortedSet set = (SortedSet) c;
        TreeMap map = (TreeMap) m;
        Comparator cc = (Comparator) set.comparator();
        Comparator 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 subSet(E fromElement, boolean fromInclusive,
                              E toElement,   boolean toInclusive) {
    return new TreeSet(m.subMap(fromElement, fromInclusive,
                                   toElement,   toInclusive));
}

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

// 返回Set的尾部，范围是：从fromElement到结尾。
// inclusive是是否包含fromElement的标志
public NavigableSet tailSet(E fromElement, boolean inclusive) {
    return new TreeSet(m.tailMap(fromElement, inclusive));
}

// 返回子Set。范围是：从fromElement(包括)到toElement(不包括)。
public SortedSet subSet(E fromElement, E toElement) {
    return subSet(fromElement, true, toElement, false);
}

// 返回Set的头部，范围是：从头部到toElement(不包括)。
public SortedSet headSet(E toElement) {
    return headSet(toElement, false);
}

// 返回Set的尾部，范围是：从fromElement到结尾(不包括)。
public SortedSet tailSet(E fromElement) {
    return tailSet(fromElement, true);
}

// 返回Set的比较器
public Comparator comparator() {
    return m.comparator();
}

// 返回Set的第一个元素
public E first() {
    return m.firstKey();
}

// 返回Set的最后一个元素
public E first() {
public E last() {
    return m.lastKey();
}

// 返回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 = m.pollFirstEntry();
    return (e == null)? null : e.getKey();
}

// 获取最后一个元素，并将该元素从TreeMap中删除。
public E pollLast() {
    Map.Entry e = m.pollLastEntry();
    return (e == null)? null : e.getKey();
}

// 克隆一个TreeSet，并返回Object对象
public Object clone() {
    TreeSet clone = null;
    try {
        clone = (TreeSet) super.clone();
    } catch (CloneNotSupportedException e) {
        throw new InternalError();
    }

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

// java.io.Serializable的写入函数
// 将TreeSet的“比较器、容量，所有的元素值”都写入到输出流中
private void writeObject(java.io.ObjectOutputStream s)
    throws java.io.IOException {
    s.defaultWriteObject();

    // 写入比较器
    s.writeObject(m.comparator());

    // 写入容量
    s.writeInt(m.size());

    // 写入“TreeSet中的每一个元素”
    for (Iterator i=m.keySet().iterator(); i.hasNext(); )
        s.writeObject(i.next());
}

// java.io.Serializable的读取函数：根据写入方式读出
// 先将TreeSet的“比较器、容量、所有的元素值”依次读出
private void readObject(java.io.ObjectInputStream s)
    throws java.io.IOException, ClassNotFoundException {
    // Read in any hidden stuff
    s.defaultReadObject();

    // 从输入流中读取TreeSet的“比较器”
    Comparator c = (Comparator) s.readObject();

    TreeMap tm;
    if (c==null)
        tm = new TreeMap();
    else
        tm = new TreeMap(c);
    m = tm;

    // 从输入流中读取TreeSet的“容量”
    int size = s.readInt();

    // 从输入流中读取TreeSet的“全部元素”
    tm.readTreeSet(size, s, PRESENT);
}

TreeSet和HashSet

相同点：
元素都是唯一不重复的Set集合。

不同点：
底层来说，HashSet是用Hash表来存储数据，而TreeSet是用二叉平衡树来存储数据。 功能上来说，由于TreeSet是有序的Set，可以使用SortedSet接口的first()、last()等方法。但由于要排序，势必要影响速度。所以，如果不需要顺序的话，还是使用HashSet吧，使用Hash表存储数据的HashSet在速度上更胜一筹。如果需要顺序则TreeSet更为明智。

底层来说，HashSet是用Hash表来存储数据，而TreeSet是用二叉平衡树来存储数据。

总结

1、不能有重复的元素。
2、具有排序功能。
3、TreeSet中的元素必须实现Comparable接口并重写compareTo()方法（或者通过TreeSet的构造函数指定一个自定义的比较器），TreeSet判断元素是否重复 、以及确定元素的顺序靠的都是这个方法。
①对于java类库中定义的类，TreeSet可以直接对其进行存储，如String，Integer等，因为这些类已经实现了Comparable接口；
②对于自定义类，如果不做适当的处理，TreeSet中只能存储一个该类型的对象实例，否则无法判断是否重复。
4、依赖TreeMap。
5、相对HashSet，TreeSet的优势是有序，劣势是相对读取慢。根据不同的场景选择不同的集合。