第1 部分 TreeSet介绍

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

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

在TreeSet中定义了如下几个变量

private transient NavigableMap<E,Object> m;

//PRESENT会被当做Map的value与key构建成键值对

 private static final Object PRESENT = new Object();

TreeSet的构造函数

// 默认构造函数。使用该构造函数，TreeSet中的元素按照自然排序进行排列。

TreeSet()

// 创建的TreeSet包含collection

TreeSet(Collection<? extends E> collection)

// 指定TreeSet的比较器

TreeSet(Comparator<? super E> comparator)

// 创建的TreeSet包含set

TreeSet(SortedSet<E> set)

TreeSet的API

 boolean add(E e)

          将指定的元素添加到此 set（如果该元素尚未存在于 set 中）。

 boolean addAll(Collection<? extends E> c)

          将指定 collection 中的所有元素添加到此 set 中。

 E ceiling(E e)

          返回此 set 中大于等于给定元素的最小元素；如果不存在这样的元素，则返回 null。

 void clear()

          移除此 set 中的所有元素。

 Object clone()

          返回 TreeSet 实例的浅表副本。

 Comparator<? super E> comparator()

          返回对此 set 中的元素进行排序的比较器；如果此 set 使用其元素的自然顺序，则返回 null。

 boolean contains(Object o)

          如果此 set 包含指定的元素，则返回 true。

 Iterator<E> descendingIterator()

          返回在此 set 元素上按降序进行迭代的迭代器。

 NavigableSet<E> descendingSet()

          返回此 set 中所包含元素的逆序视图。

 E first()

          返回此 set 中当前第一个（最低）元素。

 E floor(E e)

          返回此 set 中小于等于给定元素的最大元素；如果不存在这样的元素，则返回 null。

 SortedSet<E> headSet(E toElement)

          返回此 set 的部分视图，其元素严格小于 toElement。

 NavigableSet<E> headSet(E toElement, boolean inclusive)

          返回此 set 的部分视图，其元素小于（或等于，如果 inclusive 为 true）toElement。

 E higher(E e)

          返回此 set 中严格大于给定元素的最小元素；如果不存在这样的元素，则返回 null。

 boolean isEmpty()

          如果此 set 不包含任何元素，则返回 true。

 Iterator<E> iterator()

          返回在此 set 中的元素上按升序进行迭代的迭代器。

 E last()

          返回此 set 中当前最后一个（最高）元素。

 E lower(E e)

          返回此 set 中严格小于给定元素的最大元素；如果不存在这样的元素，则返回 null。

 E pollFirst()

          获取并移除第一个（最低）元素；如果此 set 为空，则返回 null。

 E pollLast()

          获取并移除最后一个（最高）元素；如果此 set 为空，则返回 null。

 boolean remove(Object o)

          将指定的元素从 set 中移除（如果该元素存在于此 set 中）。

 int size()

          返回 set 中的元素数（set 的容量）。

 NavigableSet<E> subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)

          返回此 set 的部分视图，其元素范围从 fromElement 到 toElement。

 SortedSet<E> subSet(E fromElement, E toElement)

          返回此 set 的部分视图，其元素从 fromElement（包括）到 toElement（不包括）。

 SortedSet<E> tailSet(E fromElement)

          返回此 set 的部分视图，其元素大于等于 fromElement。

 NavigableSet<E> tailSet(E fromElement, boolean inclusive)

          返回此 set 的部分视图，其元素大于（或等于，如果 inclusive 为 true）fromElement。

说明：

(01) TreeSet是有序的Set集合，因此支持add、remove、get等方法。
(02) 和NavigableSet一样，TreeSet的导航方法大致可以区分为两类，一类是提供元素项的导航方法，返回某个元素；另一类时提供集合的导航方法，返回某个集合。
lower、floor、ceiling 和 higher 分别返回小于、小于等于、大于等于、大于给定元素的元素，如果不存在这样的元素，则返回 null。

第2 部分 TreeSet数据结构

TreeSet的继承关系

java.lang.Object

   ↳     java.util.AbstractCollection<E>

         ↳     java.util.AbstractSet<E>

               ↳     java.util.TreeSet<E>

public class TreeSet<E> extends AbstractSet<E>

    implements NavigableSet<E>, Cloneable, java.io.Serializable{}

TreeSet与Collection关系如下图：

从图中可以看出：
(01) TreeSet继承于AbstractSet，并且实现了NavigableSet接口。
(02) TreeSet的本质是一个"有序的，并且没有重复元素"的集合，它是通过TreeMap实现的。TreeSet中含有一个"NavigableMap类型的成员变量"m，而m实际上是"TreeMap的实例"。

第3 部分 TreeSet 源码分析

 package java.util;

 public class TreeSet<E> extends AbstractSet<E>

     implements NavigableSet<E>, Cloneable, java.io.Serializable

 {

     // NavigableMap对象

     private transient NavigableMap<E,Object> m;

         // TreeSet是通过TreeMap实现的，

     // PRESENT是键-值对中的值。

     private static final Object PRESENT = new Object();

     // 将TreeMap赋值给 "NavigableMap对象m"

     TreeSet(NavigableMap<E,Object> m) {

         this.m = m;

     }

    // 不带参数的构造函数。创建一个空的TreeMap

     public TreeSet() {

         this(new TreeMap<E,Object>());

     }

     // 带比较器的构造函数。

     public TreeSet(Comparator<? super E> comparator) {

         this(new TreeMap<>(comparator));

     }

    // 创建TreeSet，并将集合c中的全部元素都添加到TreeSet中

     public TreeSet(Collection<? extends E> c) {

         this();

         // 将集合c中的元素全部添加到TreeSet中

         addAll(c);

     }

     // 创建TreeSet，并将s中的全部元素都添加到TreeSet中

     public TreeSet(SortedSet<E> s) {

         this(s.comparator());

         addAll(s);

     }

     // 返回TreeSet的顺序排列的迭代器。

     // 因为TreeSet时TreeMap实现的，所以这里实际上时返回TreeMap的“键集”对应的迭代器

     public Iterator<E> iterator() {

         return m.navigableKeySet().iterator();

     }

     // 返回TreeSet的逆序排列的迭代器。

     // 因为TreeSet时TreeMap实现的，所以这里实际上时返回TreeMap的“键集”对应的迭代器

     public Iterator<E> descendingIterator() {

         return m.descendingKeySet().iterator();

     }

     /**

      * @since 1.6

      */

     public NavigableSet<E> descendingSet() {

         return new TreeSet<>(m.descendingMap());

     }

     // 返回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<? 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);

     }

     // 返回子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对象

     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;

     }

     // 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

         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;

 }

总结：

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

巴特西

Java 集合系列 17 TreeSet

第1 部分 TreeSet介绍

第2 部分 TreeSet数据结构

第3 部分 TreeSet 源码分析

最新文章

热门文章