1. 程式人生 > >java HashSet實現原理

java HashSet實現原理

1.    HashSet概述:

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

2.    HashSet的實現:

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

public class HashSet<E>   extends AbstractSet<E>   implements
 Set<E>, Cloneablejava.io.Serializable{

   static final long serialVersionUID = -5024744406713321676L;

   // 底層使用HashMap來儲存HashSet中所有元素。
   private transient HashMap<E,Object> map;
   
   // 定義一個虛擬的Object物件作為HashMap的value,將此物件定義為static final。
   private static final Object PRESENT = new Object();

   /**
    * 預設的無參構造器,構造一個空的HashSet。
    * 
    * 實際底層會初始化一個空的HashMap,並使用預設初始容量為16和載入因子0.75。
    */

   public HashSet() {
 map = new HashMap<E,Object>();
   }

   /**
    * 構造一個包含指定collection中的元素的新set。
    *
    * 實際底層使用預設的載入因子0.75和足以包含指定
    * collection中所有元素的初始容量來建立一個HashMap。
    * @param c 其中的元素將存放在此set中的collection。
    */

   public HashSet(Collection<? extends E> c) {
 map = new HashMap<E,Object>(Math.max((int
) (c.size()/.75f) + 116));
 addAll(c);
   }

   /**
    * 以指定的initialCapacity和loadFactor構造一個空的HashSet。
    *
    * 實際底層以相應的引數構造一個空的HashMap。
    * @param initialCapacity 初始容量。
    * @param loadFactor 載入因子。
    */

   public HashSet(int initialCapacity, float loadFactor) {
 map = new HashMap<E,Object>(initialCapacity, loadFactor);
   }

   /**
    * 以指定的initialCapacity構造一個空的HashSet。
    *
    * 實際底層以相應的引數及載入因子loadFactor為0.75構造一個空的HashMap。
    * @param initialCapacity 初始容量。
    */

   public HashSet(int initialCapacity) {
 map = new HashMap<E,Object>(initialCapacity);
   }

   /**
    * 以指定的initialCapacity和loadFactor構造一個新的空連結雜湊集合。
    * 此建構函式為包訪問許可權,不對外公開,實際只是是對LinkedHashSet的支援。
    *
    * 實際底層會以指定的引數構造一個空LinkedHashMap例項來實現。
    * @param initialCapacity 初始容量。
    * @param loadFactor 載入因子。
    * @param dummy 標記。
    */

   HashSet(int initialCapacity, float loadFactor, boolean dummy) {
 map = new LinkedHashMap<E,Object>(initialCapacity, loadFactor);
   }

   /**
    * 返回對此set中元素進行迭代的迭代器。返回元素的順序並不是特定的。
    * 
    * 底層實際呼叫底層HashMap的keySet來返回所有的key。
    * 可見HashSet中的元素,只是存放在了底層HashMap的key上,
    * value使用一個static final的Object物件標識。
    * @return 對此set中元素進行迭代的Iterator。
    */

   public Iterator<E> iterator() {
 return map.keySet().iterator();
   }

   /**
    * 返回此set中的元素的數量(set的容量)。
    *
    * 底層實際呼叫HashMap的size()方法返回Entry的數量,就得到該Set中元素的個數。
    * @return 此set中的元素的數量(set的容量)。
    */

   public int size() {
 return map.size();
   }

   /**
    * 如果此set不包含任何元素,則返回true。
    *
    * 底層實際呼叫HashMap的isEmpty()判斷該HashSet是否為空。
    * @return 如果此set不包含任何元素,則返回true。
    */

   public boolean isEmpty() {
 return map.isEmpty();
   }

   /**
    * 如果此set包含指定元素,則返回true。
    * 更確切地講,當且僅當此set包含一個滿足(o==null ? e==null : o.equals(e))
    * 的e元素時,返回true。
    *
    * 底層實際呼叫HashMap的containsKey判斷是否包含指定key。
    * @param o 在此set中的存在已得到測試的元素。
    * @return 如果此set包含指定元素,則返回true。
    */

   public boolean contains(Object o) {
 return map.containsKey(o);
   }

   /**
    * 如果此set中尚未包含指定元素,則新增指定元素。
    * 更確切地講,如果此 set 沒有包含滿足(e==null ? e2==null : e.equals(e2))
    * 的元素e2,則向此set 新增指定的元素e。
    * 如果此set已包含該元素,則該呼叫不更改set並返回false。
    *
    * 底層實際將將該元素作為key放入HashMap。
    * 由於HashMap的put()方法新增key-value對時,當新放入HashMap的Entry中key
    * 與集合中原有Entry的key相同(hashCode()返回值相等,通過equals比較也返回true),
    * 新新增的Entry的value會將覆蓋原來Entry的value,但key不會有任何改變,
    * 因此如果向HashSet中新增一個已經存在的元素時,新新增的集合元素將不會被放入HashMap中,
    * 原來的元素也不會有任何改變,這也就滿足了Set中元素不重複的特性。
    * @param e 將新增到此set中的元素。
    * @return 如果此set尚未包含指定元素,則返回true。
    */

   public boolean add(E e) {
 return map.put(e, PRESENT)==null;
   }

   /**
    * 如果指定元素存在於此set中,則將其移除。
    * 更確切地講,如果此set包含一個滿足(o==null ? e==null : o.equals(e))的元素e,
    * 則將其移除。如果此set已包含該元素,則返回true
    * (或者:如果此set因呼叫而發生更改,則返回true)。(一旦呼叫返回,則此set不再包含該元素)。
    *
    * 底層實際呼叫HashMap的remove方法刪除指定Entry。
    * @param o 如果存在於此set中則需要將其移除的物件。
    * @return 如果set包含指定元素,則返回true。
    */

   public boolean remove(Object o) {
 return map.remove(o)==PRESENT;
   }

   /**
    * 從此set中移除所有元素。此呼叫返回後,該set將為空。
    *
    * 底層實際呼叫HashMap的clear方法清空Entry中所有元素。
    */

   public void clear() {
 map.clear();
   }

   /**
    * 返回此HashSet例項的淺表副本:並沒有複製這些元素本身。
    *
    * 底層實際呼叫HashMap的clone()方法,獲取HashMap的淺表副本,並設定到HashSet中。
    */

   public Object clone() {
       try {
           HashSet<E> newSet = (HashSet<E>) super.clone();
           newSet.map = (HashMap<E, Object>) map.clone();
           return newSet;
       } catch (CloneNotSupportedException e) {
           throw new InternalError();
       }
   }
}
對於HashSet中儲存的物件,請注意正確重寫其equalshashCode方法,以保證放入的物件的唯一性。