Java 集合系列17之 TreeSet詳細介紹(源碼解析)和使用示例

概要

這一章，咱們對TreeSet進行學習。
咱們先對TreeSet有個總體認識，而後再學習它的源碼，最後再經過實例來學會使用TreeSet。內容包括：
第1部分 TreeSet介紹
第2部分 TreeSet數據結構
第3部分 TreeSet源碼解析(基於JDK1.6.0_45)
第4部分 TreeSet遍歷方式
第5部分 TreeSet示例

轉載請註明出處：http://www.cnblogs.com/skywang12345/admin/EditPosts.aspx?postid=3311268

 

第1部分 TreeSet介紹

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的構造函數

// 默認構造函數。使用該構造函數，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 object)
boolean                   addAll(Collection<? extends E> collection)
void                      clear()
Object                    clone()
boolean                   contains(Object object)
E                         first()
boolean                   isEmpty()
E                         last()
E                         pollFirst()
E                         pollLast()
E                         lower(E e)
E                         floor(E e)
E                         ceiling(E e)
E                         higher(E e)
boolean                   remove(Object object)
int                       size()
Comparator<? super E>     comparator()
Iterator<E>               iterator()
Iterator<E>               descendingIterator()
SortedSet<E>              headSet(E end)
NavigableSet<E>           descendingSet()
NavigableSet<E>           headSet(E end, boolean endInclusive)
SortedSet<E>              subSet(E start, E end)
NavigableSet<E>           subSet(E start, boolean startInclusive, E end, boolean endInclusive)
NavigableSet<E>           tailSet(E start, boolean startInclusive)
SortedSet<E>              tailSet(E start)

說明：

(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源碼解析(基於JDK1.6.0_45)

爲了更瞭解TreeSet的原理，下面對TreeSet源碼代碼做出分析。

  1 package java.util;
  2 
  3 public class TreeSet<E> extends AbstractSet<E>
  4     implements NavigableSet<E>, Cloneable, java.io.Serializable
  5 {
  6     // NavigableMap對象
  7     private transient NavigableMap<E,Object> m;
  8 
  9     // TreeSet是經過TreeMap實現的，
 10     // PRESENT是鍵-值對中的值。
 11     private static final Object PRESENT = new Object();
 12 
 13     // 不帶參數的構造函數。建立一個空的TreeMap
 14     public TreeSet() {
 15         this(new TreeMap<E,Object>());
 16     }
 17 
 18     // 將TreeMap賦值給 "NavigableMap對象m"
 19     TreeSet(NavigableMap<E,Object> m) {
 20         this.m = m;
 21     }
 22 
 23     // 帶比較器的構造函數。
 24     public TreeSet(Comparator<? super E> comparator) {
 25         this(new TreeMap<E,Object>(comparator));
 26     }
 27 
 28     // 建立TreeSet，並將集合c中的所有元素都添加到TreeSet中
 29     public TreeSet(Collection<? extends E> c) {
 30         this();
 31         // 將集合c中的元素所有添加到TreeSet中
 32         addAll(c);
 33     }
 34 
 35     // 建立TreeSet，並將s中的所有元素都添加到TreeSet中
 36     public TreeSet(SortedSet<E> s) {
 37         this(s.comparator());
 38         addAll(s);
 39     }
 40 
 41     // 返回TreeSet的順序排列的迭代器。
 42     // 由於TreeSet時TreeMap實現的，因此這裏實際上時返回TreeMap的「鍵集」對應的迭代器
 43     public Iterator<E> iterator() {
 44         return m.navigableKeySet().iterator();
 45     }
 46 
 47     // 返回TreeSet的逆序排列的迭代器。
 48     // 由於TreeSet時TreeMap實現的，因此這裏實際上時返回TreeMap的「鍵集」對應的迭代器
 49     public Iterator<E> descendingIterator() {
 50         return m.descendingKeySet().iterator();
 51     }
 52 
 53     // 返回TreeSet的大小
 54     public int size() {
 55         return m.size();
 56     }
 57 
 58     // 返回TreeSet是否爲空
 59     public boolean isEmpty() {
 60         return m.isEmpty();
 61     }
 62 
 63     // 返回TreeSet是否包含對象(o)
 64     public boolean contains(Object o) {
 65         return m.containsKey(o);
 66     }
 67 
 68     // 添加e到TreeSet中
 69     public boolean add(E e) {
 70         return m.put(e, PRESENT)==null;
 71     }
 72 
 73     // 刪除TreeSet中的對象o
 74     public boolean remove(Object o) {
 75         return m.remove(o)==PRESENT;
 76     }
 77 
 78     // 清空TreeSet
 79     public void clear() {
 80         m.clear();
 81     }
 82 
 83     // 將集合c中的所有元素添加到TreeSet中
 84     public  boolean addAll(Collection<? extends E> c) {
 85         // Use linear-time version if applicable
 86         if (m.size()==0 && c.size() > 0 &&
 87             c instanceof SortedSet &&
 88             m instanceof TreeMap) {
 89             SortedSet<? extends E> set = (SortedSet<? extends E>) c;
 90             TreeMap<E,Object> map = (TreeMap<E, Object>) m;
 91             Comparator<? super E> cc = (Comparator<? super E>) set.comparator();
 92             Comparator<? super E> mc = map.comparator();
 93             if (cc==mc || (cc != null && cc.equals(mc))) {
 94                 map.addAllForTreeSet(set, PRESENT);
 95                 return true;
 96             }
 97         }
 98         return super.addAll(c);
 99     }
100 
101     // 返回子Set，其實是經過TreeMap的subMap()實現的。
102     public NavigableSet<E> subSet(E fromElement, boolean fromInclusive,
103                                   E toElement,   boolean toInclusive) {
104         return new TreeSet<E>(m.subMap(fromElement, fromInclusive,
105                                        toElement,   toInclusive));
106     }
107 
108     // 返回Set的頭部，範圍是：從頭部到toElement。
109     // inclusive是是否包含toElement的標誌
110     public NavigableSet<E> headSet(E toElement, boolean inclusive) {
111         return new TreeSet<E>(m.headMap(toElement, inclusive));
112     }
113 
114     // 返回Set的尾部，範圍是：從fromElement到結尾。
115     // inclusive是是否包含fromElement的標誌
116     public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
117         return new TreeSet<E>(m.tailMap(fromElement, inclusive));
118     }
119 
120     // 返回子Set。範圍是：從fromElement(包括)到toElement(不包括)。
121     public SortedSet<E> subSet(E fromElement, E toElement) {
122         return subSet(fromElement, true, toElement, false);
123     }
124 
125     // 返回Set的頭部，範圍是：從頭部到toElement(不包括)。
126     public SortedSet<E> headSet(E toElement) {
127         return headSet(toElement, false);
128     }
129 
130     // 返回Set的尾部，範圍是：從fromElement到結尾(不包括)。
131     public SortedSet<E> tailSet(E fromElement) {
132         return tailSet(fromElement, true);
133     }
134 
135     // 返回Set的比較器
136     public Comparator<? super E> comparator() {
137         return m.comparator();
138     }
139 
140     // 返回Set的第一個元素
141     public E first() {
142         return m.firstKey();
143     }
144 
145     // 返回Set的最後一個元素
146     public E first() {
147     public E last() {
148         return m.lastKey();
149     }
150 
151     // 返回Set中小於e的最大元素
152     public E lower(E e) {
153         return m.lowerKey(e);
154     }
155 
156     // 返回Set中小於/等於e的最大元素
157     public E floor(E e) {
158         return m.floorKey(e);
159     }
160 
161     // 返回Set中大於/等於e的最小元素
162     public E ceiling(E e) {
163         return m.ceilingKey(e);
164     }
165 
166     // 返回Set中大於e的最小元素
167     public E higher(E e) {
168         return m.higherKey(e);
169     }
170 
171     // 獲取第一個元素，並將該元素從TreeMap中刪除。
172     public E pollFirst() {
173         Map.Entry<E,?> e = m.pollFirstEntry();
174         return (e == null)? null : e.getKey();
175     }
176 
177     // 獲取最後一個元素，並將該元素從TreeMap中刪除。
178     public E pollLast() {
179         Map.Entry<E,?> e = m.pollLastEntry();
180         return (e == null)? null : e.getKey();
181     }
182 
183     // 克隆一個TreeSet，並返回Object對象
184     public Object clone() {
185         TreeSet<E> clone = null;
186         try {
187             clone = (TreeSet<E>) super.clone();
188         } catch (CloneNotSupportedException e) {
189             throw new InternalError();
190         }
191 
192         clone.m = new TreeMap<E,Object>(m);
193         return clone;
194     }
195 
196     // java.io.Serializable的寫入函數
197     // 將TreeSet的「比較器、容量，全部的元素值」都寫入到輸出流中
198     private void writeObject(java.io.ObjectOutputStream s)
199         throws java.io.IOException {
200         s.defaultWriteObject();
201 
202         // 寫入比較器
203         s.writeObject(m.comparator());
204 
205         // 寫入容量
206         s.writeInt(m.size());
207 
208         // 寫入「TreeSet中的每個元素」
209         for (Iterator i=m.keySet().iterator(); i.hasNext(); )
210             s.writeObject(i.next());
211     }
212 
213     // java.io.Serializable的讀取函數：根據寫入方式讀出
214     // 先將TreeSet的「比較器、容量、全部的元素值」依次讀出
215     private void readObject(java.io.ObjectInputStream s)
216         throws java.io.IOException, ClassNotFoundException {
217         // Read in any hidden stuff
218         s.defaultReadObject();
219 
220         // 從輸入流中讀取TreeSet的「比較器」
221         Comparator<? super E> c = (Comparator<? super E>) s.readObject();
222 
223         TreeMap<E,Object> tm;
224         if (c==null)
225             tm = new TreeMap<E,Object>();
226         else
227             tm = new TreeMap<E,Object>(c);
228         m = tm;
229 
230         // 從輸入流中讀取TreeSet的「容量」
231         int size = s.readInt();
232 
233         // 從輸入流中讀取TreeSet的「所有元素」
234         tm.readTreeSet(size, s, PRESENT);
235     }
236 
237     // TreeSet的序列版本號
238     private static final long serialVersionUID = -2479143000061671589L;
239 }

總結：

(01) TreeSet其實是TreeMap實現的。當咱們構造TreeSet時；若使用不帶參數的構造函數，則TreeSet的使用天然比較器；若用戶須要使用自定義的比較器，則須要使用帶比較器的參數。
(02) TreeSet是非線程安全的。
(03) TreeSet實現java.io.Serializable的方式。當寫入到輸出流時，依次寫入「比較器、容量、所有元素」；當讀出輸入流時，再依次讀取。

 

第4部分 TreeSet遍歷方式

4.1 Iterator順序遍歷

for(Iterator iter = set.iterator(); iter.hasNext(); ) { 
    iter.next();
}   

4.2 Iterator順序遍歷

// 假設set是TreeSet對象
for(Iterator iter = set.descendingIterator(); iter.hasNext(); ) { 
    iter.next();
}

4.3 for-each遍歷HashSet

// 假設set是TreeSet對象，而且set中元素是String類型
String[] arr = (String[])set.toArray(new String[0]);
for (String str:arr)
    System.out.printf("for each : %s\n", str);

TreeSet不支持快速隨機遍歷，只能經過迭代器進行遍歷！

 

TreeSet遍歷測試程序以下：

 1 import java.util.*;
 2 
 3 /**
 4  * @desc TreeSet的遍歷程序
 5  *
 6  * @author skywang
 7  * @email kuiwu-wang@163.com
 8  */
 9 public class TreeSetIteratorTest {
10 
11     public static void main(String[] args) {
12         TreeSet set = new TreeSet();
13         set.add("aaa");
14         set.add("aaa");
15         set.add("bbb");
16         set.add("eee");
17         set.add("ddd");
18         set.add("ccc");
19 
20         // 順序遍歷TreeSet
21         ascIteratorThroughIterator(set) ;
22         // 逆序遍歷TreeSet
23         descIteratorThroughIterator(set);
24         // 經過for-each遍歷TreeSet。不推薦！此方法須要先將Set轉換爲數組
25         foreachTreeSet(set);
26     }
27 
28     // 順序遍歷TreeSet
29     public static void ascIteratorThroughIterator(TreeSet set) {
30         System.out.print("\n ---- Ascend Iterator ----\n");
31         for(Iterator iter = set.iterator(); iter.hasNext(); ) {
32             System.out.printf("asc : %s\n", iter.next());
33         }
34     }
35 
36     // 逆序遍歷TreeSet
37     public static void descIteratorThroughIterator(TreeSet set) {
38         System.out.printf("\n ---- Descend Iterator ----\n");
39         for(Iterator iter = set.descendingIterator(); iter.hasNext(); )
40             System.out.printf("desc : %s\n", (String)iter.next());
41     }
42 
43     // 經過for-each遍歷TreeSet。不推薦！此方法須要先將Set轉換爲數組
44     private static void foreachTreeSet(TreeSet set) {
45         System.out.printf("\n ---- For-each ----\n");
46         String[] arr = (String[])set.toArray(new String[0]);
47         for (String str:arr)
48             System.out.printf("for each : %s\n", str);
49     }
50 }

運行結果：

 ---- Ascend Iterator ----
asc : aaa
asc : bbb
asc : ccc
asc : ddd
asc : eee

 ---- Descend Iterator ----
desc : eee
desc : ddd
desc : ccc
desc : bbb
desc : aaa

 ---- For-each ----
for each : aaa
for each : bbb
for each : ccc
for each : ddd
for each : eee

 

第5部分 TreeSet示例

下面經過實例學習如何使用TreeSet

 1 import java.util.*;
 2 
 3 /**
 4  * @desc TreeSet的API測試
 5  *
 6  * @author skywang
 7  * @email kuiwu-wang@163.com
 8  */
 9 public class TreeSetTest {
10 
11     public static void main(String[] args) {
12         testTreeSetAPIs();
13     }
14     
15     // 測試TreeSet的api
16     public static void testTreeSetAPIs() {
17         String val;
18 
19         // 新建TreeSet
20         TreeSet tSet = new TreeSet();
21         // 將元素添加到TreeSet中
22         tSet.add("aaa");
23         // Set中不容許重複元素，因此只會保存一個「aaa」
24         tSet.add("aaa");
25         tSet.add("bbb");
26         tSet.add("eee");
27         tSet.add("ddd");
28         tSet.add("ccc");
29         System.out.println("TreeSet:"+tSet);
30 
31         // 打印TreeSet的實際大小
32         System.out.printf("size : %d\n", tSet.size());
33 
34         // 導航方法
35         // floor(小於、等於)
36         System.out.printf("floor bbb: %s\n", tSet.floor("bbb"));
37         // lower(小於)
38         System.out.printf("lower bbb: %s\n", tSet.lower("bbb"));
39         // ceiling(大於、等於)
40         System.out.printf("ceiling bbb: %s\n", tSet.ceiling("bbb"));
41         System.out.printf("ceiling eee: %s\n", tSet.ceiling("eee"));
42         // ceiling(大於)
43         System.out.printf("higher bbb: %s\n", tSet.higher("bbb"));
44         // subSet()
45         System.out.printf("subSet(aaa, true, ccc, true): %s\n", tSet.subSet("aaa", true, "ccc", true));
46         System.out.printf("subSet(aaa, true, ccc, false): %s\n", tSet.subSet("aaa", true, "ccc", false));
47         System.out.printf("subSet(aaa, false, ccc, true): %s\n", tSet.subSet("aaa", false, "ccc", true));
48         System.out.printf("subSet(aaa, false, ccc, false): %s\n", tSet.subSet("aaa", false, "ccc", false));
49         // headSet()
50         System.out.printf("headSet(ccc, true): %s\n", tSet.headSet("ccc", true));
51         System.out.printf("headSet(ccc, false): %s\n", tSet.headSet("ccc", false));
52         // tailSet()
53         System.out.printf("tailSet(ccc, true): %s\n", tSet.tailSet("ccc", true));
54         System.out.printf("tailSet(ccc, false): %s\n", tSet.tailSet("ccc", false));
55 
56 
57         // 刪除「ccc」
58         tSet.remove("ccc");
59         // 將Set轉換爲數組
60         String[] arr = (String[])tSet.toArray(new String[0]);
61         for (String str:arr)
62             System.out.printf("for each : %s\n", str);
63 
64         // 打印TreeSet
65         System.out.printf("TreeSet:%s\n", tSet);
66 
67         // 遍歷TreeSet
68         for(Iterator iter = tSet.iterator(); iter.hasNext(); ) {
69             System.out.printf("iter : %s\n", iter.next());
70         }
71 
72         // 刪除並返回第一個元素
73         val = (String)tSet.pollFirst();
74         System.out.printf("pollFirst=%s, set=%s\n", val, tSet);
75 
76         // 刪除並返回最後一個元素
77         val = (String)tSet.pollLast();
78         System.out.printf("pollLast=%s, set=%s\n", val, tSet);
79 
80         // 清空HashSet
81         tSet.clear();
82 
83         // 輸出HashSet是否爲空
84         System.out.printf("%s\n", tSet.isEmpty()?"set is empty":"set is not empty");
85     }
86 }

運行結果： 

TreeSet:[aaa, bbb, ccc, ddd, eee]
size : 5
floor bbb: bbb
lower bbb: aaa
ceiling bbb: bbb
ceiling eee: eee
higher bbb: ccc
subSet(aaa, true, ccc, true): [aaa, bbb, ccc]
subSet(aaa, true, ccc, false): [aaa, bbb]
subSet(aaa, false, ccc, true): [bbb, ccc]
subSet(aaa, false, ccc, false): [bbb]
headSet(ccc, true): [aaa, bbb, ccc]
headSet(ccc, false): [aaa, bbb]
tailSet(ccc, true): [ccc, ddd, eee]
tailSet(ccc, false): [ddd, eee]
for each : aaa
for each : bbb
for each : ddd
for each : eee
TreeSet:[aaa, bbb, ddd, eee]
iter : aaa
iter : bbb
iter : ddd
iter : eee
pollFirst=aaa, set=[bbb, ddd, eee]
pollLast=eee, set=[bbb, ddd]
set is empty