Java | 源碼閱讀之HashSet

這段時間再看JDK（1.8）的源碼，從util包的集合開始看，首先要看的確定是面試常常涉及的HashMap，HashSet，ArrayList等等，在這裏記錄一下讀碼時的一些疑惑以及重點。

爲何HashSet可以保證元素不惟一？

咱們都知道，HashSet是可以保證插入的元素不惟一，那麼其內部究竟是怎樣實現的呢？ 先上源碼：

public class HashSet<E>
    extends AbstractSet<E>
    implements Set<E>, Cloneable, java.io.Serializable
{
    static final long serialVersionUID = -5024744406713321676L;
    //內部經過HashMap來實現
    private transient HashMap<E,Object> map;

    // Dummy value to associate with an Object in the backing Map
    private static final Object PRESENT = new Object();

    /**
     * Constructs a new, empty set; the backing <tt>HashMap</tt> instance has
     * default initial capacity (16) and load factor (0.75).
     */
    public HashSet() {
        map = new HashMap<>();
    }
/**
*剩下的代碼...
**/

經過上述代碼能夠看到,HashSet的內部是由HashMap來實現的,可是HashMap是一個鍵值對,調用put方法都是要在key上來存放value,而HashSet的put方法爲何只有一個參數,實際上,看到那句//Dummy value to associate with an Object in the backing Map就知道了，原來HashSet內部插值時插的是HashMap的key，而HashMap的value則是這個靜態常量PRESENT。那麼整個HashSet代碼看下來，保證HashSet內部元素惟一的一個方法就是HashSet的put方法了，該方法很簡單，代碼以下：

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

不得不說這個鍋甩的漂亮啊，彷彿聽到HashSet在說，沒我什麼事了，去看HashMap吧，那麼咱們就先分析一下HashMap的put，再來看這個add。

HashMap的putVal方法

HashMap是Java中一個十分重要的數據結構，基本上全部Java開發都離不開它，那麼HashMap的一個重要的功能就是不斷的取數據，寫數據，在這裏主要看下HashMap是怎樣寫數據的，寫數據的源碼以下：

public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;                
        if ((tab = table) == null || (n = tab.length) == 0) 
            n = (tab = resize()).length;
        if ((p = tab[i = (n - 1) & hash]) == null)               
            tab[i] = newNode(hash, key, value, null);//若是p爲空，則插入新的對象，並返回null
        else {                                      
            Node<K,V> e; K k;                            //不爲空,則插入新的節點e
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))//若是p的key就是要修改的結點的key
                e = p;           
            else if (p instanceof TreeNode)          
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                for (int binCount = 0; ; ++binCount) {
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null); //鏈表後沒有值，插入新的
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    if (e.hash == hash &&                  //找到要插的,且此處有值
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;          //鏈表後有結點,又不是要插的,則日後
                }
            }
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;              //進行新的mapping
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null; //第一次插,返回的是null,後面再插,返回的就是oldValue;
    }

HashMap內部是經過一個結點數組，Node<k,V>[]來存放鍵值對的，在經過計算寫入對象的hash碼後找到對應的index，並進行寫入操做，遇到哈希碰撞則是經過鏈表的方式來處理，經過上述的代碼能夠看到HashMap插入對象的邏輯：

if 表爲空或者表的大小爲0，則進行resize，獲得一個新表
then if 插入位置爲空，則插入新的結點                     //在此處作了一個賦值，將結點p指向了表的某一個位置
     else if 插入位置的結點p就是要修改的結點，則新結點e指向結點p
          else if 插入的結點是TreeNode，則調用TreeNode的插入方法。
               else loop（對該位置存在的鏈表進行遍歷）：
                    if 節點p的下一個結點爲空，則插到鏈表後，退出循環
                    if 找到某一個不爲空的結點，則退出循環，此時新結點e指向該結點
               if 新節點不爲空，則進行新的mapping，即替換值內容並返回舊值
     if 表大小超過閾值，resize
     返回null；

那麼重點來了，當HashMap在某個位置首次插入時，因爲插入位置爲空，則插入了新的結點，此時直接返回null，然後續進行插入操做時，會進行新的mapping，從而返回舊值，那麼咱們再回頭看一下HashSet的add方法：

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

也就是說，HashSet裏的HashMap只有第一次插值的時候會返回true，後續的都返回的false，這樣就保證了HashSet中元素的惟一性。

PEACE OUT