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

概要

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

轉載請註明出處：http://www.cnblogs.com/skywang12345/p/3311252.html

 

第1部分 HashSet介紹

HashSet 簡介

HashSet 是一個沒有重複元素的集合。
它是由HashMap實現的，不保證元素的順序，並且HashSet容許使用 null 元素。
HashSet是非同步的。若是多個線程同時訪問一個哈希 set，而其中至少一個線程修改了該 set，那麼它必須 保持外部同步。這一般是經過對天然封裝該 set 的對象執行同步操做來完成的。若是不存在這樣的對象，則應該使用 Collections.synchronizedSet 方法來「包裝」 set。最好在建立時完成這一操做，以防止對該 set 進行意外的不一樣步訪問：

Set s = Collections.synchronizedSet(new HashSet(...));

HashSet經過iterator()返回的迭代器是fail-fast的。

 

HashSet的構造函數

 // 默認構造函數
public HashSet() 

// 帶集合的構造函數
public HashSet(Collection<? extends E> c) 

// 指定HashSet初始容量和加載因子的構造函數
public HashSet(int initialCapacity, float loadFactor) 

// 指定HashSet初始容量的構造函數
public HashSet(int initialCapacity) 

// 指定HashSet初始容量和加載因子的構造函數,dummy沒有任何做用
HashSet(int initialCapacity, float loadFactor, boolean dummy) 

HashSet的主要API

boolean         add(E object)
void            clear()
Object          clone()
boolean         contains(Object object)
boolean         isEmpty()
Iterator<E>     iterator()
boolean         remove(Object object)
int             size()

 

第2部分 HashSet數據結構

HashSet的繼承關係以下：

java.lang.Object
   ↳     java.util.AbstractCollection<E>
         ↳     java.util.AbstractSet<E>
               ↳     java.util.HashSet<E>

public class HashSet<E>
    extends AbstractSet<E>
    implements Set<E>, Cloneable, java.io.Serializable { }

 

HashSet與Map關係以下圖：

從圖中能夠看出：
(01) HashSet繼承於AbstractSet，而且實現了Set接口。
(02) HashSet的本質是一個"沒有重複元素"的集合，它是經過HashMap實現的。HashSet中含有一個"HashMap類型的成員變量"map，HashSet的操做函數，實際上都是經過map實現的。

 

第3部分 HashSet源碼解析(基於JDK1.6.0_45)

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

  1 package java.util;
  2 
  3 public class HashSet<E>
  4     extends AbstractSet<E>
  5     implements Set<E>, Cloneable, java.io.Serializable
  6 {
  7     static final long serialVersionUID = -5024744406713321676L;
  8 
  9     // HashSet是經過map(HashMap對象)保存內容的
 10     private transient HashMap<E,Object> map;
 11 
 12     // PRESENT是向map中插入key-value對應的value
 13     // 由於HashSet中只須要用到key，而HashMap是key-value鍵值對；
 14     // 因此，向map中添加鍵值對時，鍵值對的值固定是PRESENT
 15     private static final Object PRESENT = new Object();
 16 
 17     // 默認構造函數
 18     public HashSet() {
 19         // 調用HashMap的默認構造函數，建立map
 20         map = new HashMap<E,Object>();
 21     }
 22 
 23     // 帶集合的構造函數
 24     public HashSet(Collection<? extends E> c) {
 25         // 建立map。
 26         // 爲何要調用Math.max((int) (c.size()/.75f) + 1, 16)，從 (c.size()/.75f) + 1 和 16 中選擇一個比較大的樹呢？        
 27         // 首先，說明(c.size()/.75f) + 1
 28         //   由於從HashMap的效率(時間成本和空間成本)考慮，HashMap的加載因子是0.75。
 29         //   當HashMap的「閾值」(閾值=HashMap總的大小*加載因子) < 「HashMap實際大小」時，
 30         //   就須要將HashMap的容量翻倍。
 31         //   因此，(c.size()/.75f) + 1 計算出來的正好是總的空間大小。
 32         // 接下來，說明爲何是 16 。
 33         //   HashMap的總的大小，必須是2的指數倍。若建立HashMap時，指定的大小不是2的指數倍；
 34         //   HashMap的構造函數中也會從新計算，找出比「指定大小」大的最小的2的指數倍的數。
 35         //   因此，這裏指定爲16是從性能考慮。避免重複計算。
 36         map = new HashMap<E,Object>(Math.max((int) (c.size()/.75f) + 1, 16));
 37         // 將集合(c)中的所有元素添加到HashSet中
 38         addAll(c);
 39     }
 40 
 41     // 指定HashSet初始容量和加載因子的構造函數
 42     public HashSet(int initialCapacity, float loadFactor) {
 43         map = new HashMap<E,Object>(initialCapacity, loadFactor);
 44     }
 45 
 46     // 指定HashSet初始容量的構造函數
 47     public HashSet(int initialCapacity) {
 48         map = new HashMap<E,Object>(initialCapacity);
 49     }
 50 
 51     HashSet(int initialCapacity, float loadFactor, boolean dummy) {
 52         map = new LinkedHashMap<E,Object>(initialCapacity, loadFactor);
 53     }
 54 
 55     // 返回HashSet的迭代器
 56     public Iterator<E> iterator() {
 57         // 實際上返回的是HashMap的「key集合的迭代器」
 58         return map.keySet().iterator();
 59     }
 60 
 61     public int size() {
 62         return map.size();
 63     }
 64 
 65     public boolean isEmpty() {
 66         return map.isEmpty();
 67     }
 68 
 69     public boolean contains(Object o) {
 70         return map.containsKey(o);
 71     }
 72 
 73     // 將元素(e)添加到HashSet中
 74     public boolean add(E e) {
 75         return map.put(e, PRESENT)==null;
 76     }
 77 
 78     // 刪除HashSet中的元素(o)
 79     public boolean remove(Object o) {
 80         return map.remove(o)==PRESENT;
 81     }
 82 
 83     public void clear() {
 84         map.clear();
 85     }
 86 
 87     // 克隆一個HashSet，並返回Object對象
 88     public Object clone() {
 89         try {
 90             HashSet<E> newSet = (HashSet<E>) super.clone();
 91             newSet.map = (HashMap<E, Object>) map.clone();
 92             return newSet;
 93         } catch (CloneNotSupportedException e) {
 94             throw new InternalError();
 95         }
 96     }
 97 
 98     // java.io.Serializable的寫入函數
 99     // 將HashSet的「總的容量，加載因子，實際容量，全部的元素」都寫入到輸出流中
100     private void writeObject(java.io.ObjectOutputStream s)
101         throws java.io.IOException {
102         // Write out any hidden serialization magic
103         s.defaultWriteObject();
104 
105         // Write out HashMap capacity and load factor
106         s.writeInt(map.capacity());
107         s.writeFloat(map.loadFactor());
108 
109         // Write out size
110         s.writeInt(map.size());
111 
112         // Write out all elements in the proper order.
113         for (Iterator i=map.keySet().iterator(); i.hasNext(); )
114             s.writeObject(i.next());
115     }
116 
117 
118     // java.io.Serializable的讀取函數
119     // 將HashSet的「總的容量，加載因子，實際容量，全部的元素」依次讀出
120     private void readObject(java.io.ObjectInputStream s)
121         throws java.io.IOException, ClassNotFoundException {
122         // Read in any hidden serialization magic
123         s.defaultReadObject();
124 
125         // Read in HashMap capacity and load factor and create backing HashMap
126         int capacity = s.readInt();
127         float loadFactor = s.readFloat();
128         map = (((HashSet)this) instanceof LinkedHashSet ?
129                new LinkedHashMap<E,Object>(capacity, loadFactor) :
130                new HashMap<E,Object>(capacity, loadFactor));
131 
132         // Read in size
133         int size = s.readInt();
134 
135         // Read in all elements in the proper order.
136         for (int i=0; i<size; i++) {
137             E e = (E) s.readObject();
138             map.put(e, PRESENT);
139         }
140     }
141 }

說明： HashSet的代碼實際上很是簡單，經過上面的註釋應該很可以看懂。它是經過HashMap實現的，若對HashSet的理解有困難，建議先學習如下HashMap；學完HashMap以後，在學習HashSet就很是容易了。

 

第4部分 HashSet遍歷方式

4.1 經過Iterator遍歷HashSet

第一步：根據iterator()獲取HashSet的迭代器。
第二步：遍歷迭代器獲取各個元素。

// 假設set是HashSet對象
for(Iterator iterator = set.iterator();
       iterator.hasNext(); ) { 
    iterator.next();
}   

 

4.2 經過for-each遍歷HashSet

第一步：根據toArray()獲取HashSet的元素集合對應的數組。
第二步：遍歷數組，獲取各個元素。

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

HashSet的遍歷測試程序以下： 

 1 import java.util.Random;
 2 import java.util.Iterator;
 3 import java.util.HashSet;
 4 
 5 /*
 6  * @desc 介紹HashSet遍歷方法
 7  *
 8  * @author skywang
 9  */
10 public class HashSetIteratorTest {
11 
12     public static void main(String[] args) {
13         // 新建HashSet
14         HashSet set = new HashSet();
15 
16         // 添加元素 到HashSet中
17         for (int i=0; i<5; i++)
18             set.add(""+i);
19 
20         // 經過Iterator遍歷HashSet
21         iteratorHashSet(set) ;
22 
23         // 經過for-each遍歷HashSet
24         foreachHashSet(set);
25     }
26 
27     /*
28      * 經過Iterator遍歷HashSet。推薦方式
29      */
30     private static void iteratorHashSet(HashSet set) {
31         for(Iterator iterator = set.iterator();
32                iterator.hasNext(); ) {
33             System.out.printf("iterator : %s\n", iterator.next());
34         }
35     }
36 
37     /*
38      * 經過for-each遍歷HashSet。不推薦！此方法須要先將Set轉換爲數組
39      */
40     private static void foreachHashSet(HashSet set) {
41         String[] arr = (String[])set.toArray(new String[0]);
42         for (String str:arr)
43             System.out.printf("for each : %s\n", str);
44     }
45 }

運行結果： 

iterator : 3
iterator : 2
iterator : 1
iterator : 0
iterator : 4
for each : 3
for each : 2
for each : 1
for each : 0
for each : 4

 

第5部分 HashSet示例

下面咱們經過實例學習如何使用HashSet

 1 import java.util.Iterator;
 2 import java.util.HashSet;
 3 
 4 /*
 5  * @desc HashSet經常使用API的使用。
 6  *
 7  * @author skywang
 8  */
 9 public class HashSetTest {
10 
11     public static void main(String[] args) {
12         // HashSet經常使用API
13         testHashSetAPIs() ;
14     }
15 
16     /*
17      * HashSet除了iterator()和add()以外的其它經常使用API
18      */
19     private static void testHashSetAPIs() {
20         // 新建HashSet
21         HashSet set = new HashSet();
22 
23         // 將元素添加到Set中
24         set.add("a");
25         set.add("b");
26         set.add("c");
27         set.add("d");
28         set.add("e");
29 
30         // 打印HashSet的實際大小
31         System.out.printf("size : %d\n", set.size());
32 
33         // 判斷HashSet是否包含某個值
34         System.out.printf("HashSet contains a :%s\n", set.contains("a"));
35         System.out.printf("HashSet contains g :%s\n", set.contains("g"));
36 
37         // 刪除HashSet中的「e」
38         set.remove("e");
39 
40         // 將Set轉換爲數組
41         String[] arr = (String[])set.toArray(new String[0]);
42         for (String str:arr)
43             System.out.printf("for each : %s\n", str);
44 
45         // 新建一個包含b、c、f的HashSet
46         HashSet otherset = new HashSet();
47         otherset.add("b");
48         otherset.add("c");
49         otherset.add("f");
50 
51         // 克隆一個removeset，內容和set如出一轍
52         HashSet removeset = (HashSet)set.clone();
53         // 刪除「removeset中，屬於otherSet的元素」
54         removeset.removeAll(otherset);
55         // 打印removeset
56         System.out.printf("removeset : %s\n", removeset);
57 
58         // 克隆一個retainset，內容和set如出一轍
59         HashSet retainset = (HashSet)set.clone();
60         // 保留「retainset中，屬於otherSet的元素」
61         retainset.retainAll(otherset);
62         // 打印retainset
63         System.out.printf("retainset : %s\n", retainset);
64 
65 
66         // 遍歷HashSet
67         for(Iterator iterator = set.iterator();
68                iterator.hasNext(); ) 
69             System.out.printf("iterator : %s\n", iterator.next());
70 
71         // 清空HashSet
72         set.clear();
73 
74         // 輸出HashSet是否爲空
75         System.out.printf("%s\n", set.isEmpty()?"set is empty":"set is not empty");
76     }
77 
78 }

運行結果： 

size : 5
HashSet contains a :true
HashSet contains g :false
for each : d
for each : b
for each : c
for each : a
removeset : [d, a]
retainset : [b, c]
iterator : d
iterator : b
iterator : c
iterator : a
set is empty