HashMap源碼解讀（JDK1.7版）

一、數據結構

HashMap採用鏈地址法解決哈希衝突，因此其結構就是由數組+鏈表組成，數組是HashMap的主體，鏈表則主要是爲了解決哈希衝突而存在的，如果對應的數組位置不含鏈表，那麼查找的時間複雜度僅爲O(1),同時不管有無鏈表，插入操作的時間複雜度也一直爲O(1),因爲最新的Entry會插入鏈表頭部。當實例化一個HashMap時，系統會創建一個長度爲Capacity的Entry數組，這個長度被稱爲容量(Capacity)，在這個數組中可以存放元素的位置我們稱之爲“桶”(bucket)，每個bucket都有自己的索引，系統可以根據索引快速的查找bucket中的元素。每個桶中就可以有一個Entry對象，然後這個Entry對象可以用next指向下一個Entry,最終形成一個Entry鏈。Entry是HashMap的基本組成單元，每一個Entry都包含一個key-value鍵值對、指向下一個Entry對象的引用next以及對key的hashcode進行hash運算後得到的hash值，hash值就是爲了找到該key應該存儲的數組位置。如圖：

二、源碼解讀

1.重要屬性

//默認初始化容量是1向左移4位，即16，但並未直接寫16，因爲操作系統最終會使用二進制進行計算,這樣寫省略了轉換過程，提高了效率。
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; 

//最大容量是2的30次方，是30次方的主要原因是int類型是32位整型。
//Java的原始類型裏沒有無符號類型。因此首位是符號位 正數爲0，負數爲1
//所以剩下的31位就是正數佔30位，負數佔30位。
static final int MAXIMUM_CAPACITY = 1 << 30;

//threshold的最大值
static final int ALTERNATIVE_HASHING_THRESHOLD_DEFAULT = Integer.MAX_VALUE;

//默認負載因子，是0.75的原因主要是“哈希衝突”和“空間利用率”矛盾的一個折中
//加載因子越大,填滿的元素越多,空間利用率越高，但衝突的機會加大了。
//從源碼中的註釋可以知道hash桶中元素個數遵循泊松分佈，在負載因子爲0.75的時候
//桶中元素個數超過8個幾乎是不可能的，所以0.75是解決“哈希衝突”和“空間利用率”矛盾比較優的一個值。
static final float DEFAULT_LOAD_FACTOR = 0.75f;

//table數組用於存儲Entry對象
transient Entry<K,V>[] table = (Entry<K,V>[]) EMPTY_TABLE;  

//已使用的數組位置的個數，用於判斷是否需要擴容
transient int size;

//閾值，當table == {}時，該值爲初始容量（初始容量默認爲16）；當table被填充了
//也就是爲table分配內存空間後，threshold一般爲 capacity*loadFactory。
//HashMap在進行擴容時需要參考threshold
int threshold;

//負載因子，表示table的填充度，默認是0.75
final float loadFactor;

//由於HashMap不是線程安全的,所以在迭代的時候,會將modCount賦值到迭代器的expectedModCount屬性中
//如果在迭代的過程中HashMap被其他線程修改了,modCount的數值就會發生變化,
//這時候expectedModCount和ModCount不相等,迭代器就會拋出ConcurrentModificationException()異常
transient int modCount;

//對哈希值的散列優化產生影響
transient int hashSeed = 0;

2.構造方法

    //通過初始容量和狀態因子構造HashMap，其他三個構造方法都會調用此方法
    public HashMap(int initialCapacity, float loadFactor) {  
        if (initialCapacity < 0)//參數有效性檢查  
            throw new IllegalArgumentException("Illegal initial capacity: " +                                             initialCapacity);  
        if (initialCapacity > MAXIMUM_CAPACITY)//參數有效性檢查  
            initialCapacity = MAXIMUM_CAPACITY;  
        if (loadFactor <= 0 || Float.isNaN(loadFactor))//參數有效性檢查  
            throw new IllegalArgumentException("Illegal load factor: " +  
                                               loadFactor);  

        this.loadFactor = loadFactor;  
        threshold = initialCapacity;  
        init();//init方法在HashMap中沒有實際實現，不過在其子類如 linkedHashMap中就會有對應實現
    }  

    //通過擴容因子構造HashMap,容量爲默認值，即16  
    public HashMap(int initialCapacity) {  
        this(initialCapacity, DEFAULT_LOAD_FACTOR);  
    }  

    //裝載因子取0.75，容量取16，構造HashMap  
    public HashMap() {  
        this(DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR);  
    }  

    //通過其他Map來初始化HashMap,容量通過傳入map的size來計算，裝載因子取0.75  
    public HashMap(Map<? extends K, ? extends V> m) {  
        this(Math.max((int) (m.size() / DEFAULT_LOAD_FACTOR) + 1, DEFAULT_INITIAL_CAPACITY), DEFAULT_LOAD_FACTOR);  
        inflateTable(threshold);//初始化HashMap底層的數組結構  
        putAllForCreate(m);//添加m中的元素  
    }

3.get()

 // 獲取key對應的value 
 public V get(Object key) {
        if (key == null)
            //如果key爲null,調用getForNullKey()
            return getForNullKey();
        //key不爲null,調用getEntry(key);
        Entry<K,V> entry = getEntry(key);
        return null == entry ? null : entry.getValue();
}

 //當key爲null時,獲取value
 private V getForNullKey() {
        if (size == 0) {
            return null;//鏈表爲空,返回null
        }
        //鏈表不爲空,將“key爲null”的元素存儲在table[0]位置，但不一定是該鏈表的第一個位置！
        for (Entry<K,V> e = table[0]; e != null; e = e.next) {
            if (e.key == null)
                return e.value;
        }
        return null;
 }

//key不爲null,獲取value
final Entry<K,V> getEntry(Object key) {
        if (size == 0) {//判斷鏈表中是否有值
         //鏈表中沒值,也就是沒有value
            return null;
        }
       //鏈表中有值,獲取key的hash值 
        int hash = (key == null) ? 0 : hash(key);
        // 在“該hash值對應的鏈表”上查找“鍵值等於key”的元素 
        for (Entry<K,V> e = table[indexFor(hash, table.length)];
             e != null;
             e = e.next) {
            Object k;
            //判斷key是否相同
            if (e.hash == hash &&
                ((k = e.key) == key || (key != null && key.equals(k))))
                return e;//key相等,返回相應的value
             }
        return null;//鏈表中沒有相應的key
}

4.put()/putForNullKey()

// 將“key-value”添加到HashMap中 
  public V put(K key, V value) {
        if (table == EMPTY_TABLE) {
            inflateTable(threshold);
        }
        if (key == null)// 若“key爲null”，則將該鍵值對添加到table[0]中。 
            return putForNullKey(value); 
      // 若“key不爲null”，則計算該key的哈希值，然後將其添加到該哈希值對應的鏈表中。 
        int hash = hash(key);//獲取key的hash值
        int i = indexFor(hash, table.length);
        for (Entry<K,V> e = table[i]; e != null; e = e.next) {
            Object k;

            if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
             // 若“該key”對應的鍵值對已經存在，則用新的value取代舊的value。然後退出！
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue;
            }
        }
   // 若“key”對應的鍵值對不存在，則將“key-value”添加到table中 
        modCount++;
   //將key-value添加到table[i]處
        addEntry(hash, key, value, i);
        return null;
    }

    //插入鍵爲null的值
    private V putForNullKey(V value) {
        //key爲null的值永遠被放在哈希表的第一個桶中
        for (Entry<K,V> e = table[0]; e != null; e = e.next) {
            //一旦找到鍵爲null，替換舊值
            if (e.key == null) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue;
            }
        }
        //如果第一個桶還是空則插入新節點
        modCount++;
        addEntry(0, null, value, 0);
        return null;
    }

5.addEntry()/createEntry()

void addEntry(int hash, K key, V value, int bucketIndex) {
 //先判斷大小   
  if ((size >= threshold) && (null != table[bucketIndex])) {
            //若HashMap的實際大小不小於 “閾值”，則進行擴容    
            resize(2 * table.length);//每次擴容2倍
            hash = (null != key) ? hash(key) : 0;
            bucketIndex = indexFor(hash, table.length);
        }
       //新增Entry,將“key-value”插入指定位置，bucketIndex是位置索引
       createEntry(hash, key, value, bucketIndex);
}
void createEntry(int hash, K key, V value, int bucketIndex) {
        // 保存“bucketIndex”位置的值到“e”中 
        Entry<K,V> e = table[bucketIndex];
        // 設置“bucketIndex”位置的元素爲“新Entry”，  
        // 設置“e”爲“新Entry的下一個節點”  
        table[bucketIndex] = new Entry<>(hash, key, value, e);
        //已使用數組位置+1
        size++;
}
//進行頭插，創建一個新的entry
 Entry(int h, K k, V v, Entry<K,V> n) {
            value = v;
            next = n;
            key = k;
            hash = h;
 }

6.resize()

// 重新調整HashMap的大小，newCapacity是調整後的新容量 
void resize(int newCapacity) {
        Entry[] oldTable = table;
        int oldCapacity = oldTable.length;
        if (oldCapacity == MAXIMUM_CAPACITY) {
            //當舊容量已達上限，閾值則也取上限，因爲不可能再擴容了
            //所以此時也管不了性能問題了，能擴多大擴多大
            threshold = Integer.MAX_VALUE;
            return;
        }
        //新建一個HashMap，將“舊HashMap”的全部元素添加到“新HashMap”中，  
        //然後，將“新HashMap”賦值給“舊HashMap”。 
        Entry[] newTable = new Entry[newCapacity];
        transfer(newTable, initHashSeedAsNeeded(newCapacity));
        table = newTable;
        threshold = (int)Math.min(newCapacity * loadFactor, MAXIMUM_CAPACITY + 1);
}

7.transfer()

// 將HashMap中的全部元素都添加到newTable中
void transfer(Entry[] newTable, boolean rehash) {
        int newCapacity = newTable.length;
        for (Entry<K,V> e : table) {
            while(null != e) {
                Entry<K,V> next = e.next;
                //重新計算元素在新數組中的索引位置
                if (rehash) {
                    e.hash = null == e.key ? 0 : hash(e.key);
                }
                int i = indexFor(e.hash, newCapacity);
                //擴容後的新數組的桶中鏈表元素順序顛倒
                e.next = newTable[i];
                newTable[i] = e;
                e = next;
            }
        }
    }

8.inflateTable()

//初始化底層數組
private void inflateTable(int toSize) {
        // Find a power of 2 >= toSize
        int capacity = roundUpToPowerOf2(toSize);
        //獲取閾值
        threshold = (int) Math.min(capacity * loadFactor, MAXIMUM_CAPACITY + 1);
        table = new Entry[capacity];
        initHashSeedAsNeeded(capacity);//初始化hashSeed變量
    }

 //獲取不小於初始容量的最小的2的指數倍數的數作爲數組的大小
 private static int roundUpToPowerOf2(int number) {
        return number >= MAXIMUM_CAPACITY
                ? MAXIMUM_CAPACITY
                : (number > 1) ? Integer.highestOneBit((number - 1) << 1) : 1;
    }

9.hash()/indexFor()

//獲取key的哈希值
final int hash(Object k) {
        //通過更新hashSeed來修改hash值達到分散的目的
        int h = hashSeed;//默認爲0
        if (0 != h && k instanceof String) {
            return sun.misc.Hashing.stringHash32((String) k);
        }
        //異或運算保證不會影響返回的hashCode值（異1同0）
        h ^= k.hashCode();
        h ^= (h >>> 20) ^ (h >>> 12);
        return h ^ (h >>> 7) ^ (h >>> 4);
}

//通過hash值和數組長度返回數組下標
//length-1是因爲數組長度都是2的n次冪，只要再減去1，轉換成二進制最高位肯定爲0，其他位全爲1
//此時進行位與運算就不會對hashcode值產生任何影響，會完整的得到原hashcode值的低位值，也有效降低了發生哈希衝突的概率
static int indexFor(int h, int length) {
    return h & (length-1);
}

10.remove()

public V remove(Object key) {
        Entry<K,V> e = removeEntryForKey(key);
        return (e == null ? null : e.value);
    }


    final Entry<K,V> removeEntryForKey(Object key) {
        if (size == 0) {
            return null;
        }
        //計算hash值
        int hash = (key == null) ? 0 : hash(key);
        //得到桶索引
        int i = indexFor(hash, table.length);
        //記錄待刪除節點的前一個節點
        Entry<K,V> prev = table[i];
        //待刪除節點
        Entry<K,V> e = prev;

        //遍歷
        while (e != null) {
            Entry<K,V> next = e.next;
            Object k;
            //如果匹配，則刪除節點
            if (e.hash == hash &&
                ((k = e.key) == key || (key != null && key.equals(k)))) {
                modCount++;
                size--;
                if (prev == e)
                    table[i] = next;
                else
                    prev.next = next;
                e.recordRemoval(this);
                return e;
            }
            prev = e;
            e = next;
        }

        return e;
    }