JDK 原始碼分析：HashMap（一）
概述
HashMap 是 Java 開發中最常用的容器類之一，也是面試的常客。 它其實就是前文「 資料結構與演算法筆記（二） 」中 「散列表」的實現，處理雜湊衝突用的是“連結串列法”，並且在 JDK 1.8 做了優化，當連結串列長度達到一定數量時會把連結串列轉為紅黑樹。
因此，JDK 1.8 中的 HashMap 實現可以理解為「陣列 + 連結串列 + 紅黑樹」。內部結構示意圖：
HashMap 的繼承結構和類簽名如下：
public class HashMap<K,V> extends AbstractMap<K,V>
implements Map<K,V>, Cloneable, Serializable {}
PS: 還記得以前初讀 HashMap 原始碼時，用了週末兩天的時間，而且讀完腦子裡還是一頭霧水。 當時也沒做什麼筆記，這次記錄一下。
程式碼分析
一些成員變數
// 預設初始化容量（必須是 2 的次冪）
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
// 最大容量（必須是 2 的次冪，且小於等於 2^30）
static final int MAXIMUM_CAPACITY = 1 << 30;
// 預設負載因子
static final float DEFAULT_LOAD_FACTOR = 0.75f;
// 將連結串列轉為樹的閾值（當 bin 的數量大於等於該值時，將連結串列轉為樹）
// 該值必須大於 2 且至少是 8，
static final int TREEIFY_THRESHOLD = 8;
// 將樹轉為連結串列的閾值
static final int UNTREEIFY_THRESHOLD = 6;
Node 類
先看 HashMap 中的一個巢狀類 Node，如下（部分方法省略）：
/**
* Basic hash bin node, used for most entries. (See below for
* TreeNode subclass, and in LinkedHashMap for its Entry subclass.)
*/
static class Node<K,V> implements Map.Entry<K,V> {
final int hash;
final K key;
V value;
Node<K,V> next;
Node(int hash, K key, V value, Node<K,V> next) {
this.hash = hash;
this.key = key;
this.value = value;
this.next = next;
}
public final int hashCode() {
return Objects.hashCode(key) ^ Objects.hashCode(value);
}
public final boolean equals(Object o) {
if (o == this)
return true;
if (o instanceof Map.Entry) {
Map.Entry<?,?> e = (Map.Entry<?,?>)o;
if (Objects.equals(key, e.getKey()) &&
Objects.equals(value, e.getValue()))
return true;
}
return false;
}
}
該 Node 類實現了 Map.Entry 介面，是 HashMap 中基本的 bin 節點，此外還有 TreeNode。參考上面的結構圖。
構造器
構造器 1 ：無引數構造器
// 負載因子
final float loadFactor;
/**
* Constructs an empty HashMap with the default initial capacity
* (16) and the default load factor (0.75).
*/
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}
通過註釋可知，該構造器使用預設的初始化容量（16）和預設的負載因子（0.75）構造了一個空的 HashMap。
構造器 2、3：
// 使用指定的初始化容量和預設負載因子（0.75）構造一個空的 HashMap
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
// 擴容的閾值（容量 * 負載因子）
int threshold;
// 使用指定的初始化容量和負載因子構造一個空的 HashMap
public HashMap(int initialCapacity, float loadFactor) {
if (initialCapacity < 0)
throw new IllegalArgumentException("Illegal initial capacity: " +
initialCapacity);
if (initialCapacity > MAXIMUM_CAPACITY)
initialCapacity = MAXIMUM_CAPACITY;
// PS: 負載因子可以大於 1
if (loadFactor <= 0 || Float.isNaN(loadFactor))
throw new IllegalArgumentException("Illegal load factor: " +
loadFactor);
this.loadFactor = loadFactor;
this.threshold = tableSizeFor(initialCapacity);
}
可以看到，這兩個構造器實質上是同一個。 值得注意的是構造器中用到了一個 tableSizeFor 方法對初始化容量（initialCapacity）進行了處理：
/**
* Returns a power of two size for the given target capacity.
*/
static final int tableSizeFor(int cap) {
int n = cap - 1;
n |= n >>> 1;
n |= n >>> 2;
n |= n >>> 4;
n |= n >>> 8;
n |= n >>> 16;
return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
}
該方法的作用的是對給定的容量 cap 進行處理，把它轉為大於等於 cap 的 2 次冪的數字。 例如：
若給定 cap 為 5，則返回是 8 (2^3)；
若給定 cap 為 8，返回還是 8 (2^3)；
若給定 cap 為 12，則返回是 16 (2^4).
而且，這裡賦值的是 threshold 變數，即閾值。
構造器 4：
// 使用指定的 Map 構造一個 HashMap，預設負載因子為 0.75，容量充足
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
putMapEntries(m, false);
}
通過構造器可以看到，建立一個 HashMap 的時候，其內部只是初始化了一些變數，並未分配空間。
常用&核心方法
接下來分析最常用，也是 HashMap 的核心方法：put、get 和 resize 方法。
put 方法：
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
該方法首先會對 key 做一個處理，即 hash(key) 方法，如下：
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
該方法獲取 key 的 hashCode，並且將其 hashCode 與右移 16 位後的值做“異或（^）”處理。 這一步的目的是什麼？先看一個該操作的例子：
hashCode 是一個 32 位的整數，將其無符號右移 16 位之後，它的高 16 位就全部變成了 0，再與它的 hashCode 做異或運算之後，hashCode 的高 16 位不變，而低 16 位也以某種形式保留了高 16 位的資訊。這樣做目的是增大低位數字的隨機性，從而儘可能減少雜湊衝突。
此處可參考：
https://www.zhihu.com/question/20733617/answer/111577937
下面的程式碼將前面生成的 hash 值和陣列的長度減一（ n - 1）做了一個按位與操作（相當於對 n - 1 取餘數，位操作效率更高），從而確定元素的位置。相當於散列表的雜湊函式。
繼續分析 put 方法：
// 散列表陣列
transient Node<K,V>[] table;
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
Node<K,V>[] tab; Node<K,V> p; int n, i;
// 若 table 為空，則呼叫 resize 方法初始化
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
// 若要存放的 bin 位置為空，則直接插入到該節點
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
// 要存放的 bin 的位置不為空（即雜湊衝突）
else {
Node<K,V> e; K k;
// key 已存在
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
e = p;
// 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;
}
}
// 處理 key 已存在的情況
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value; // 替換舊值
afterNodeAccess(e);
return oldValue;
}
}
++modCount;
// 若超過閾值（capacity * 0.75），則進行擴容
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
其中：
1. 涉及紅 黑樹的相關操作可參考「 JDK原始碼分析-TreeMap(2) 」有關 TreeMap 分析以及前文的紅黑樹；
2. 有兩個方法 afterNodeAccess(e) 和 after NodeInsertion(evict) 是用於 LinkedHashMap (HashMap 的子類) 的回撥方法，這裡暫不分析。
put 方法操作流程如圖所示：
下面分析 resize 方法，該方法也是 HashMap 擴容的核心方法：
// 初始化 table 或者對其進行擴容
final Node<K,V>[] resize() {
Node<K,V>[] oldTab = table;
int oldCap = (oldTab == null) ? 0 : oldTab.length;
int oldThr = threshold;
int newCap, newThr = 0;
// 原 table 不為空
if (oldCap > 0) {
// 若 table 容量大於最大值，則將閾值調整為 Integer.MAX_VALUE，不擴容
if (oldCap >= MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return oldTab;
}
// 新容量擴大為原先的 2 倍
// 若翻倍後的容量小於 int 最大值，且原容量大於等於預設初始容量（16），將閾值擴大為原先的 2 倍
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
oldCap >= DEFAULT_INITIAL_CAPACITY)
newThr = oldThr << 1; // double threshold
}
// 用閾值替代初始容量（指定初始容量的構造器）
else if (oldThr > 0) // initial capacity was placed in threshold
newCap = oldThr;
// 無參構造器（預設的容量和閾值）
else { // zero initial threshold signifies using defaults
newCap = DEFAULT_INITIAL_CAPACITY;
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
// 新的閾值
if (newThr == 0) {
float ft = (float)newCap * loadFactor;
newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
(int)ft : Integer.MAX_VALUE);
}
threshold = newThr;
// 建立一個新的陣列（大小為擴容後的容量大小）
@SuppressWarnings({"rawtypes","unchecked"})
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;
// 原陣列不為空，則進行擴容
if (oldTab != null) {
for (int j = 0; j < oldCap; ++j) {
Node<K,V> e;
if ((e = oldTab[j]) != null) {
oldTab[j] = null;
// 該位置只有一個元素，將該元素移到新的位置
if (e.next == null)
newTab[e.hash & (newCap - 1)] = e;
// 該位置是紅黑樹結構，將樹節點拆分或轉為連結串列
else if (e instanceof TreeNode)
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
// 該位置是連結串列結構
else { // preserve order
Node<K,V> loHead = null, loTail = null;
Node<K,V> hiHead = null, hiTail = null;
Node<K,V> next;
do {
next = e.next;
// 原索引位置（注意 oldCap 是 2 的次冪，因此其 2 進製表示只有一位是 1，其他全是 0）
if ((e.hash & oldCap) == 0) {
// 連結串列為空
if (loTail == null)
loHead = e;
// 新節點新增到上個節點末尾
else
loTail.next = e;
loTail = e;
}
// 原索引位置+oldCap
else {
if (hiTail == null)
hiHead = e;
else
hiTail.next = e;
hiTail = e;
}
} while ((e = next) != null);
// 設定 j 和 oldCap+j 位置的頭結點
if (loTail != null) {
loTail.next = null;
newTab[j] = loHead;
}
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
return newTab;
}
擴容後的新容量為原先的 2 倍，下面分析其擴容的原理：
擴容前：
原容量為 16，key1 和 key2 對應的 hash 值只有倒數第 5 位不同，此時對 oldCap-1 (15) 執行按位與操作，二者得到的結果都是 1111，都存放在第 15 個位置；
擴容後的位置選擇：
程式碼中的判斷條件為：if( (e.hash & oldCap) == 0) ，也就是 將 hash1 和 hash2 分別與 oldCap (16, 0b10000) 進行按位與操作，根據其是否為 0 來決定它在擴容後的新陣列中的位置。可以看到倒數第五位中，key1 是 0，key2 是1.
擴容後：
新容量為 32，原 hash 值倒數第 5 位為 0 的 key1 在新陣列中的位置仍是 15 (0b1111)，而原 hash 值倒數第五位為 1 的 key2 在新陣列中的位置是 0b11111，即 15 + 16 = 31.
如圖所示：
get 方法
前面分析了 put 方法，get 方法有不少地方與之類似，因此分析起來就簡單不少。程式碼如下：
public V get(Object key) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
final Node<K,V> getNode(int hash, Object key) {
Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
if ((tab = table) != null && (n = tab.length) > 0 &&
(first = tab[(n - 1) & hash]) != null) {
// 第一個節點即為要找的元素
if (first.hash == hash && // always check first node
((k = first.key) == key || (key != null && key.equals(k))))
return first;
// 該位置有後序節點（為連結串列或紅黑樹）
if ((e = first.next) != null) {
// 若是樹節點，說明該位置是紅黑樹，在紅黑樹中查詢
if (first instanceof TreeNode)
return ((TreeNode<K,V>)first).getTreeNode(hash, key);
// 在連結串列中遍歷查詢
do {
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
return e;
} while ((e = e.next) != null);
}
}
return null;
}
小結
本文主要分析了 HashMap 的內部結構，以及最核心的三個方法：put、resize 和 get 方法。小結如下：
1. HashMap 是散列表的實現，它使用“連結串列法”處理雜湊衝突用，並在 JDK 1.8 引入紅黑樹進一步優化；
2. 內部結構為「陣列 + 連結串列 + 紅黑樹」；
3. 預設初始化容量為 16，負載因子為 0.75，擴容的閾值為 16 * 0.75 = 12；
4. 當容器中元素的容量大於閾值時，HashMap 會自動擴容為原先的 2 倍。
參考文章：
https://tech.meituan.com/2016/06/24/java-hashmap.html
相關閱讀：
Stay hungry, stay foolish.
