精尽 JDK 源码解析 —— 集合（七）TreeSet - 《精尽 JDK》

本文，和《精尽 JDK 源码解析 —— 集合（五）哈希集合 HashSet》基本是一致的。

TreeSet ，基于 TreeSet 的 Set 实现类。在业务中，如果我们有排重 + 排序的需求，一般会考虑使用 TreeSet 。不过，貌似很少会出现排重 + 排序的双重需求。所以呢，TreeSet 反正艿艿是木有使用过。

TreeSet 实现的接口、继承的类，如下图所示：
类图

实现 java.util.NavigableSet 接口，并继承 java.util.AbstractSet 抽像类。
实现 java.io.Serializable 接口。
实现 java.lang.Cloneable 接口。

对于 NavigableSet 和 SortedMap 接口，已经添加注释，胖友可以直接点击查看。

TreeSet 只有一个属性，那就是 m 。代码如下：

private transient NavigableMap m;

m 的 key ，存储 HashSet 的每个 key 。
map 的 value ，因为 TreeSet 没有 value 的需要，所以使用一个统一的 PRESENT 即可。代码如下：
private static final Object PRESENT = new Object();

TreeSet 一共有 5 个构造方法，代码如下：

TreeSet(NavigableMap m) {
this.m = m;
}

public TreeSet() {
this(new TreeMap<>());
}

public TreeSet(Comparator<? super E> comparator) {
this(new TreeMap<>(comparator));
}

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

addAll(c);
}

public TreeSet(SortedSet s) {
this(s.comparator());

addAll(s);
}

在构造方法中，会创建 TreeMap 对象，赋予到 m 属性。

#add(E e) 方法，添加单个元素。代码如下：

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

m 的 value 值，就是我们看到的 PRESENT 。

#addAll(Collection<? extends E> c) 方法，批量添加。代码如下：

public boolean addAll(Collection<? extends E> c) {

if (m.size()==0 && c.size() > 0 &&
c instanceof SortedSet &&
m instanceof TreeMap) {
SortedSet<? extends E> set = (SortedSet<? extends E>) c;
TreeMap map = (TreeMap) m;
if (Objects.equals(set.comparator(), map.comparator())) {
map.addAllForTreeSet(set, PRESENT);
return true;
}
}

return super.addAll(c);
}

在实现上，和 TreeMap 的批量添加是一样的，对于情况一，会进行优化。

#remove(Object o) 方法，移除 o 对应的 value ，并返回是否成功。代码如下：

public boolean remove(Object o) {
return m.remove(o)==PRESENT;
}

#contains(Object key) 方法，判断 key 是否存在。代码如下：

public boolean contains(Object o) {
return m.containsKey(o);
}

艿艿：后面的内容，快速看即可。

在 NavigableSet 中，定义了四个查找接近的元素：

#lower(E e) 方法，小于 e 的 key
#floor(E e) 方法，小于等于 e 的 key
#higher(E e) 方法，大于 e 的 key
#ceiling(E e) 方法，大于等于 e 的 key

我们一起来看看哈。

public E lower(E e) {
return m.lowerKey(e);
}

public E floor(E e) {
return m.floorKey(e);
}

public E ceiling(E e) {
return m.ceilingKey(e);
}

public E higher(E e) {
return m.higherKey(e);
}

#first() 方法，获得首个 key 。代码如下：

public E first() {
return m.firstKey();
}

#pollFirst() 方法，获得并移除首个 key 。代码如下：
public E pollFirst() {
Map.Entry e = m.pollFirstEntry();
return (e == null) ? null : e.getKey();
}

#last() 方法，获得尾部 key 。代码如下：

public E last() {
return m.lastKey();
}

#pollLast() 方法，获得并移除尾部 key 。代码如下：
public E pollLast() {
Map.Entry e = m.pollLastEntry();
return (e == null) ? null : e.getKey();
}

#clear() 方法，清空。代码如下：

public void clear() {
m.clear();
}

#clone() 方法，克隆 TreeSet 。代码如下：

public Object clone() {

TreeSet clone;
try {
clone = (TreeSet) super.clone();
} catch (CloneNotSupportedException e) {
throw new InternalError(e);
}

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

#writeObject(ObjectOutputStream s) 方法，序列化 TreeSet 对象。代码如下：

@java.io.Serial
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {

s.defaultWriteObject();

s.writeObject(m.comparator());

s.writeInt(m.size());

for (E e : m.keySet())
s.writeObject(e);
}

#readObject(ObjectInputStream s) 方法，反序列化成 TreeSet 对象。代码如下：

@java.io.Serial
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {

s.defaultReadObject();

@SuppressWarnings(“unchecked”)
Comparator<? super E> c = (Comparator<? super E>) s.readObject();

TreeMap tm = new TreeMap<>(c);
m = tm;

int size = s.readInt();

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

void readTreeSet(int size, java.io.ObjectInputStream s, V defaultVal)
throws java.io.IOException, ClassNotFoundException {
buildFromSorted(size, null, s, defaultVal);
}

public Iterator iterator() {
return m.navigableKeySet().iterator();
}

public Iterator descendingIterator() {
return m.descendingKeySet().iterator();
}

public NavigableSet descendingSet() {
return new TreeSet<>(m.descendingMap());
}

public NavigableSet subSet(E fromElement, boolean fromInclusive,
E toElement, boolean toInclusive) {
return new TreeSet<>(m.subMap(fromElement, fromInclusive,
toElement, toInclusive));
}
public SortedSet subSet(E fromElement, E toElement) {
return subSet(fromElement, true, toElement, false);
}

public NavigableSet headSet(E toElement, boolean inclusive) {
return new TreeSet<>(m.headMap(toElement, inclusive));
}
public SortedSet headSet(E toElement) {
return headSet(toElement, false);
}

public NavigableSet tailSet(E fromElement, boolean inclusive) {
return new TreeSet<>(m.tailMap(fromElement, inclusive));
}

public SortedSet tailSet(E fromElement) {
return tailSet(fromElement, true);
}

😈 总的来说，比较简单，相信胖友一会会时间就已经看完了。

关于 TreeSet 的总结，只有一句话：TreeSet 是基于 TreeMap 的 Set 实现类。
http://svip.iocoder.cn/JDK/Collection-TreeSet/