1. 程式人生 > >深入Java集合學習系列:HashSet的實現原理

深入Java集合學習系列:HashSet的實現原理

1.    HashSet概述:

   HashSet實現Set介面,由雜湊表(實際上是一個HashMap例項)支援。它不保證set 的迭代順序;特別是它不保證該順序恆久不變。此類允許使用null元素。

2.    HashSet的實現:

   對於HashSet而言,它是基於HashMap實現的,HashSet底層使用HashMap來儲存所有元素,因此HashSet 的實現比較簡單,相關HashSet的操作,基本上都是直接呼叫底層HashMap的相關方法來完成, HashSet的原始碼如下:

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

3. 相關說明:

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