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

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

是否 abstract arc html 源代碼 cat param body static

0.參考文獻

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

1.HashSet概述:

  HashSet實現Set接口,由哈希表(實際上是一個HashMap實例)支持。它不保證set 的叠代順序;特別是它不保證該順序恒久不變。此類允許使用null元素。HashSet中不允許有重復元素,這是因為HashSet是基於HashMap實現的,HashSet中的元素都存放在HashMap的key上面,而value中的值都是統一的一個private static final Object PRESENT = new Object();。HashSet跟HashMap一樣,都是一個存放鏈表的數組。

  HashSet中add方法調用的是底層HashMap中的put()方法,而如果是在HashMap中調用put,首先會判斷key是否存在,如果key存在則修改value值,如果key不存在這插入這個key-value。而在set中,因為value值沒有用,也就不存在修改value值的說法,因此往HashSet中添加元素,首先判斷元素(也就是key)是否存在,如果不存在這插入,如果存在著不插入,這樣HashSet中就不存在重復值。

2.HashSet的實現:

  對於HashSet而言,它是基於HashMap實現的,HashSet底層使用HashMap來保存所有元素,更確切的說,HashSet中的元素,只是存放在了底層HashMap的key上, 而value使用一個static final的Object對象標識。因此HashSet 的實現比較簡單,相關HashSet的操作,基本上都是直接調用底層HashMap的相關方法來完成, HashSet的源代碼如下:

技術分享 技術分享
public class HashSet<E>
    extends AbstractSet<E>
    implements Set<E>, Cloneable, java.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) + 1, 16));
    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();
        }
    }
}
技術分享

3. 相關說明:

  1. 相關HashMap的實現原理,請參考我的上一遍總結:深入Java集合學習系列:HashMap的實現原理。
  2. 對於HashSet中保存的對象,請註意正確重寫其equals和hashCode方法,以保證放入的對象的唯一性。

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