Java集合---HashSet的源碼分析

標籤：style   blog   color   io   使用   java   ar   div   cti   

一、  HashSet概述：

   HashSet實現Set介面，由雜湊表（實際上是一個HashMap執行個體）支援。它不保證set 的迭代順序；特別是它不保證該順序恒久不變。此類允許使用null元素。

 

二、  HashSet的實現：

   對於HashSet而言，它是基於HashMap實現的，HashSet底層使用HashMap來儲存所有元素，因此HashSet 的實現比較簡單，相關HashSet的操作，基本上都是直接調用底層HashMap的相關方法來完成， 

HashSet的原始碼如下：

 

1 public class HashSet<E>  2    extends AbstractSet<E>  3    implements Set<E>, Cloneable, java.io.Serializable  4{  5    static final long serialVersionUID = -5024744406713321676L;  6  7    // 底層使用HashMap來儲存HashSet中所有元素。  8    private transient HashMap<E,Object> map;  9      10    // 定義一個虛擬Object對象作為HashMap的value，將此對象定義為static final。  11    private static final Object PRESENT = new Object();  12  13    /** 14     * 預設的無參構造器，構造一個空的HashSet。 15     *  16     * 實際底層會初始化一個空的HashMap，並使用預設初始容量為16和載入因子0.75。 17     */  18    public HashSet() {  19    map = new HashMap<E,Object>();  20    }  21  22    /** 23     * 構造一個包含指定collection中的元素的新set。 24     * 25     * 實際底層使用預設的載入因子0.75和足以包含指定 26     * collection中所有元素的初始容量來建立一個HashMap。 27     * @param c 其中的元素將存放在此set中的collection。 28     */  29    public HashSet(Collection<? extends E> c) {  30    map = new HashMap<E,Object>(Math.max((int) (c.size()/.75f) + 1, 16));  31    addAll(c);  32    }  33  34    /** 35     * 以指定的initialCapacity和loadFactor構造一個空的HashSet。 36     * 37     * 實際底層以相應的參數構造一個空的HashMap。 38     * @param initialCapacity 初始容量。 39     * @param loadFactor 載入因子。 40     */  41    public HashSet(int initialCapacity, float loadFactor) {  42    map = new HashMap<E,Object>(initialCapacity, loadFactor);  43    }  44  45    /** 46     * 以指定的initialCapacity構造一個空的HashSet。 47     * 48     * 實際底層以相應的參數及載入因子loadFactor為0.75構造一個空的HashMap。 49     * @param initialCapacity 初始容量。 50     */  51    public HashSet(int initialCapacity) {  52    map = new HashMap<E,Object>(initialCapacity);  53    }  54  55    /** 56     * 以指定的initialCapacity和loadFactor構造一個新的空連結雜湊集合。 57     * 此建構函式為包存取權限，不對外公開，實際只是是對LinkedHashSet的支援。 58     * 59     * 實際底層會以指定的參數構造一個空LinkedHashMap執行個體來實現。 60     * @param initialCapacity 初始容量。 61     * @param loadFactor 載入因子。 62     * @param dummy 標記。 63     */  64    HashSet(int initialCapacity, float loadFactor, boolean dummy) {  65    map = new LinkedHashMap<E,Object>(initialCapacity, loadFactor);  66    }  67  68    /** 69     * 返回對此set中元素進行迭代的迭代器。返回元素的順序並不是特定的。 70     *  71     * 底層實際調用底層HashMap的keySet來返回所有的key。 72     * 可見HashSet中的元素，只是存放在了底層HashMap的key上， 73     * value使用一個static final的Object對象標識。 74     * @return 對此set中元素進行迭代的Iterator。 75     */  76    public Iterator<E> iterator() {  77    return map.keySet().iterator();  78    }  79  80    /** 81     * 返回此set中的元素的數量（set的容量）。 82     * 83     * 底層實際調用HashMap的size()方法返回Entry的數量，就得到該Set中元素的個數。 84     * @return 此set中的元素的數量（set的容量）。 85     */  86    public int size() {  87    return map.size();  88    }  89  90    /** 91     * 如果此set不包含任何元素，則返回true。 92     * 93     * 底層實際調用HashMap的isEmpty()判斷該HashSet是否為空白。 94     * @return 如果此set不包含任何元素，則返回true。 95     */  96    public boolean isEmpty() {  97    return map.isEmpty();  98    }  99  100    /** 101     * 如果此set包含指定元素，則返回true。 102     * 更確切地講，若且唯若此set包含一個滿足(o==null ? e==null : o.equals(e)) 103     * 的e元素時，返回true。 104     * 105     * 底層實際調用HashMap的containsKey判斷是否包含指定key。 106     * @param o 在此set中的存在已得到測試的元素。 107     * @return 如果此set包含指定元素，則返回true。 108     */  109    public boolean contains(Object o) {  110    return map.containsKey(o);  111    }  112  113    /** 114     * 如果此set中尚未包含指定元素，則添加指定元素。 115     * 更確切地講，如果此 set 沒有包含滿足(e==null ? e2==null : e.equals(e2)) 116     * 的元素e2，則向此set 添加指定的元素e。 117     * 如果此set已包含該元素，則該調用不更改set並返回false。 118     * 119     * 底層實際將將該元素作為key放入HashMap。 120     * 由於HashMap的put()方法添加key-value對時，當新放入HashMap的Entry中key 121     * 與集合中原有Entry的key相同（hashCode()傳回值相等，通過equals比較也返回true）， 122     * 新添加的Entry的value會將覆蓋原來Entry的value，但key不會有任何改變， 123     * 因此如果向HashSet中添加一個已經存在的元素時，新添加的集合元素將不會被放入HashMap中， 124     * 原來的元素也不會有任何改變，這也就滿足了Set中元素不重複的特性。 125     * @param e 將添加到此set中的元素。 126     * @return 如果此set尚未包含指定元素，則返回true。 127     */  128    public boolean add(E e) {  129    return map.put(e, PRESENT)==null;  130    }  131  132    /** 133     * 如果指定元素存在於此set中，則將其移除。 134     * 更確切地講，如果此set包含一個滿足(o==null ? e==null : o.equals(e))的元素e， 135     * 則將其移除。如果此set已包含該元素，則返回true 136     * （或者：如果此set因調用而發生更改，則返回true）。（一旦調用返回，則此set不再包含該元素）。 137     * 138     * 底層實際調用HashMap的remove方法刪除指定Entry。 139     * @param o 如果存在於此set中則需要將其移除的對象。 140     * @return 如果set包含指定元素，則返回true。 141     */  142    public boolean remove(Object o) {  143    return map.remove(o)==PRESENT;  144    }  145  146    /** 147     * 從此set中移除所有元素。此調用返回後，該set將為空白。 148     * 149     * 底層實際調用HashMap的clear方法清空Entry中所有元素。 150     */  151    public void clear() {  152    map.clear();  153    }  154  155    /** 156     * 返回此HashSet執行個體的淺表副本：並沒有複製這些元素本身。 157     * 158     * 底層實際調用HashMap的clone()方法，擷取HashMap的淺表副本，並設定到  HashSet中。 159     */  160    public Object clone() {  161        try {  162            HashSet<E> newSet = (HashSet<E>) super.clone();  163            newSet.map = (HashMap<E, Object>) map.clone();  164            return newSet;  165        } catch (CloneNotSupportedException e) {  166            throw new InternalError();  167        }  168    }  } 

 

三、 相關說明：

   對於HashSet中儲存的對象，請注意正確重寫其equals和hashCode方法，以保證放入的對象的唯一性。

 

Java集合---HashSet的源碼分析