問題
(1)TreeSet真的是使用TreeMap來儲存元素的嗎?
(2)TreeSet是有序的嗎?
(3)TreeSet和LinkedHashSet有何不同?
簡介
TreeSet底層是採用TreeMap實現的一種Set,所以它是有序的,同樣也是非執行緒安全的。
原始碼分析
經過前面我們學習HashSet和LinkedHashSet,基本上已經掌握了Set實現的套路了。
所以,也不廢話了,直接上原始碼:
package java.util;
// TreeSet實現了NavigableSet介面,所以它是有序的
public class TreeSet<E> extends AbstractSet<E>
implements NavigableSet<E>, Cloneable, java.io.Serializable
{
// 元素儲存在NavigableMap中
// 注意它不一定就是TreeMap
private transient NavigableMap<E,Object> m;
// 虛擬元素, 用來作為value儲存在map中
private static final Object PRESENT = new Object();
// 直接使用傳進來的NavigableMap儲存元素
// 這裡不是深拷貝,如果外面的map有增刪元素也會反映到這裡
// 而且, 這個方法不是public的, 說明只能給同包使用
TreeSet(NavigableMap<E,Object> m) {
this.m = m;
}
// 使用TreeMap初始化
public TreeSet() {
this(new TreeMap<E,Object>());
}
// 使用帶comparator的TreeMap初始化
public TreeSet(Comparator<? super E> comparator) {
this(new TreeMap<>(comparator));
}
// 將集合c中的所有元素新增的TreeSet中
public TreeSet(Collection<? extends E> c) {
this();
addAll(c);
}
// 將SortedSet中的所有元素新增到TreeSet中
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();
}
// 以逆序返回一個新的TreeSet
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);
}
// 新增元素, 呼叫map的put()方法, value為PRESENT
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中的所有元素
public boolean addAll(Collection<? extends E> c) {
// 滿足一定條件時直接呼叫TreeMap的addAllForTreeSet()方法新增元素
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;
}
}
// 不滿足上述條件, 呼叫父類的addAll()通過遍歷的方式一個一個地新增元素
return super.addAll(c);
}
// 子set(NavigableSet中的方法)
public NavigableSet<E> subSet(E fromElement, boolean fromInclusive,
E toElement, boolean toInclusive) {
return new TreeSet<>(m.subMap(fromElement, fromInclusive,
toElement, toInclusive));
}
// 頭set(NavigableSet中的方法)
public NavigableSet<E> headSet(E toElement, boolean inclusive) {
return new TreeSet<>(m.headMap(toElement, inclusive));
}
// 尾set(NavigableSet中的方法)
public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
return new TreeSet<>(m.tailMap(fromElement, inclusive));
}
// 子set(SortedSet介面中的方法)
public SortedSet<E> subSet(E fromElement, E toElement) {
return subSet(fromElement, true, toElement, false);
}
// 頭set(SortedSet介面中的方法)
public SortedSet<E> headSet(E toElement) {
return headSet(toElement, false);
}
// 尾set(SortedSet介面中的方法)
public SortedSet<E> tailSet(E fromElement) {
return tailSet(fromElement, true);
}
// 比較器
public Comparator<? super E> comparator() {
return m.comparator();
}
// 返回最小的元素
public E first() {
return m.firstKey();
}
// 返回最大的元素
public E last() {
return m.lastKey();
}
// 返回小於e的最大的元素
public E lower(E e) {
return m.lowerKey(e);
}
// 返回小於等於e的最大的元素
public E floor(E e) {
return m.floorKey(e);
}
// 返回大於等於e的最小的元素
public E ceiling(E e) {
return m.ceilingKey(e);
}
// 返回大於e的最小的元素
public E higher(E e) {
return m.higherKey(e);
}
// 彈出最小的元素
public E pollFirst() {
Map.Entry<E,?> e = m.pollFirstEntry();
return (e == null) ? null : e.getKey();
}
public E pollLast() {
Map.Entry<E,?> e = m.pollLastEntry();
return (e == null) ? null : e.getKey();
}
// 克隆方法
@SuppressWarnings("unchecked")
public Object clone() {
TreeSet<E> clone;
try {
clone = (TreeSet<E>) super.clone();
} catch (CloneNotSupportedException e) {
throw new InternalError(e);
}
clone.m = new TreeMap<>(m);
return clone;
}
// 序列化寫出方法
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);
}
// 序列化寫入方法
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// Read in any hidden stuff
s.defaultReadObject();
// Read in Comparator
@SuppressWarnings("unchecked")
Comparator<? super E> c = (Comparator<? super E>) s.readObject();
// Create backing TreeMap
TreeMap<E,Object> tm = new TreeMap<>(c);
m = tm;
// Read in size
int size = s.readInt();
tm.readTreeSet(size, s, PRESENT);
}
// 可分割的迭代器
public Spliterator<E> spliterator() {
return TreeMap.keySpliteratorFor(m);
}
// 序列化id
private static final long serialVersionUID = -2479143000061671589L;
}
複製程式碼
原始碼比較簡單,基本都是呼叫map相應的方法。
總結
(1)TreeSet底層使用NavigableMap儲存元素;
(2)TreeSet是有序的;
(3)TreeSet是非執行緒安全的;
(4)TreeSet實現了NavigableSet介面,而NavigableSet繼承自SortedSet介面;
(5)TreeSet實現了SortedSet介面;(彤哥年輕的時候面試被問過TreeSet和SortedSet的區別^^)
彩蛋
(1)通過之前的學習,我們知道TreeSet和LinkedHashSet都是有序的,那它們有何不同?
LinkedHashSet並沒有實現SortedSet介面,它的有序性主要依賴於LinkedHashMap的有序性,所以它的有序性是指按照插入順序保證的有序性;
而TreeSet實現了SortedSet介面,它的有序性主要依賴於NavigableMap的有序性,而NavigableMap又繼承自SortedMap,這個介面的有序性是指按照key的自然排序保證的有序性,而key的自然排序又有兩種實現方式,一種是key實現Comparable介面,一種是構造方法傳入Comparator比較器。
(2)TreeSet裡面真的是使用TreeMap來儲存元素的嗎?
通過原始碼分析我們知道TreeSet裡面實際上是使用的NavigableMap來儲存元素,雖然大部分時候這個map確實是TreeMap,但不是所有時候都是TreeMap。
因為有一個構造方法是TreeSet(NavigableMap<E,Object> m)
,而且這是一個非public方法,通過呼叫關係我們可以發現這個構造方法都是在自己類中使用的,比如下面這個:
public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
return new TreeSet<>(m.tailMap(fromElement, inclusive));
}
複製程式碼
而這個m我們姑且認為它是TreeMap,也就是呼叫TreeMap的tailMap()方法:
public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive) {
return new AscendingSubMap<>(this,
false, fromKey, inclusive,
true, null, true);
}
複製程式碼
可以看到,返回的是AscendingSubMap物件,這個類的繼承鏈是怎麼樣的呢?
可以看到,這個類並沒有繼承TreeMap,不過通過原始碼分析也可以看出來這個類是組合了TreeMap,也算和TreeMap有點關係,只是不是繼承關係。
所以,TreeSet的底層不完全是使用TreeMap來實現的,更準確地說,應該是NavigableMap。
歡迎關注我的公眾號“彤哥讀原始碼”,檢視更多原始碼系列文章, 與彤哥一起暢遊原始碼的海洋。