1. 程式人生 > >原始碼分析HashSet、TreeSet以及LinkedHashSet

原始碼分析HashSet、TreeSet以及LinkedHashSet

      寫這篇部落格,主要是弄清楚HashSet的底層實現原理,其實我們大部分人對HashSet不是很熟的,畢竟面試時問的最多的都是HashMap,如果問道了二者關係,我們會經常這樣說:HashSet和HashMap都是基於hash表(陣列+連結串列)實現的,HashSet是基於HashMap實現的,具體怎麼實現的,二者關係如何,不理解(哈哈,畢竟大部分人還是在應付面試,停留在很淺的層次)

     既然是原始碼分析HashSet,那麼就首先摟一眼HashSet的實現類(ctrl+左鍵,進入):

以下是HashSet類的部分內容

      

我去,還真是基於HashMap實現的。HashSet是如何利用HashMap的呢,這點想必大家都特別關心,畢竟HashMap和HashSet還是不一樣的:

       1、HashMap是key - value的儲存方式;HashSet只儲存元素物件

       2、HashMap允許null值,key不重複,value可以重複;HashSet不允許重複,無序性

HashSet到底在HashMap的頭上做了啥?

         HashSet實現Set介面,由雜湊表(實際上是一個HashMap例項)支援。在HashSet中,元素都存到HashMap鍵值對的Key上面,而Value有一個統一的值private static final Object PRESENT = new Object();,(定義一個虛擬的Object物件作為HashMap的value,將此物件定義為static final。)

        分析原始碼 可知,利用HashMap 的containsKey()方法,將物件元素作為key傳入,然後就可以確保該元素在HashSet中的不重複性,另外根據add方法可以知道,HashSet在新增元素時,都是採用預設建立的PRESENT物件作為value填充到HashMap中的。因此可以實現利用HashMap來完成HashSet的操作。

HashSet中的常用方法,還是貼一份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();
        }
    }
}

小結:

  • 說白了,HashSet就是限制了功能的HashMap,所以瞭解HashMap的實現原理,這個HashSet自然就通
  • 對於HashSet中儲存的物件,主要要正確重寫equals方法和hashCode方法,以保證放入Set物件的唯一性
  • 雖說是Set是對於重複的元素不放入,倒不如直接說是底層的Map直接把原值替代了(這個Set的put方法的返回值真有意思)
  • HashSet沒有提供get()方法,願意是同HashMap一樣,Set內部是無序的,只能通過迭代的方式獲得

再說一說LinkedHashSet(可以實現有序插入)

      同HashSet相比並沒有實現新的功能(新的方法),只不過把HashSet中預留的構造方法啟用了,因而可以實現有序插入,而這個具體的實現要去看LinkedHashMap了,我們使用時是不需要再可以去設定引數的,直接拿來用即可。

      上原始碼:

    LinkedHashSet中的建構函式:

     啟用在hashset中預留的構造方法:

 現在去LinkedHashMap中找具體如何實現有序插入的,定義一個有序性的標誌位:accessOrder

      然後在HashSet的構造方法中,例項化一個LinkedHashMap物件時,會呼叫LinkedHashMap的以下構造方法,將標誌位accessOrder賦值為false,這是給了迭代器一個引數,false代表迭代時使用插入得順序。

偶然發現

        檢視原始碼時,我發現了一個奇怪的重寫的方法:public Spliterator<E> spliterator(),查了查資料發現叫做可分割迭代器,這個介面是為了並行遍歷資料來源中的元素而設計的迭代器,為了更好的發揮多核CPU的能力。  其實這樣我想起了要去關注一下集合框架中的併發安全了。

TreeSet

       根據Set的這個尿性,我先猜測一波,TreeSet的底層實現是TreeMap(而且我在猜TreeMap的底層實現藉助了HashMap)。

TreeMap預設按鍵的自然順序升序進行排序:

指定比較器的: TreeMap中有一個傳入比較器的建構函式, Map中的元素可按此比較器進行排序。

 

TreeSet特點與實現機制

       TreeSet中存放的元素是有序的(不是插入時的順序,是有按關鍵字大小排序的),且元素不能重複。  而如何實現有序儲存,就需要有一個比較器,其實說起來,TreeSet更受關注的是不重複且有序,這個有序就需要有一個compare的過程,因此會需要引數實現Comparable介面。

-

另外所有Set集合都不提供get方法,因為Set裡面沒有索引,若想遍歷Set集合元素,有如下兩種方式:

1、採用迭代器

2、增強for迴圈.

TreeMap底層實現資料結構是紅黑樹,有機會學習了,補上!