Java HashSet 底層機制、原始碼剖析、逐行分析
阿新 • • 發佈：2022-12-02
HashSet 基礎說明
- HashSet 實現了 Set 介面
- HashSet 實際上是 HashMap
- 可以存放 null 值，但是隻能有一個 null
- HashSet 不保證元素是有序的，取決於 hash 後，再確定索引的結果
- 不能有重複元素/物件
HashSet 底層機制說明
HashSet 的底層實際就是 HashMap，HashMap 實際就是陣列 + 連結串列 + 紅黑樹的結構。陣列的每個索引位置預設存放的是單向連結串列，如果連結串列的長度到達了一個臨界值就會轉為紅黑樹。
add 第一個結點新增機制
import java.util.HashSet; public class HashSetSource { @SuppressWarnings({"all"}) public static void main(String[] args) { HashSet hashSet = new HashSet(); hashSet.add("java"); hashSet.add("php"); hashSet.add("java"); System.out.println("hashSet = " + hashSet); } }
第一步：建立 HashSet 物件
可以看到 HashSet 實際上就是 HashMap
public HashSet() {
map = new HashMap<>();
}
第二步：執行 add("java")
public boolean add(E e) {
return map.put(e, PRESENT)==null;
}
map 是上一步建立的 HashMap 物件，它的定義為：
private transient HashMap<E,Object> map;
PRESENT 主要起到佔位作用，是一個空物件，用來代替 HashMap 中的 value
private static final Object PRESENT = new Object();
第三步：執行 map.put(e, PRESENT)
來到了 HashMap 的原始碼，真正新增結點的操作是在 putVal 中執行的。
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
但在此之前需要先 執行 hash(key)
static final int hash(Object key) { int h; return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16); }
這個 hash 是一個 hash 演算法，並不一定是 key 的 hash 值。
如果 key 的 hash 值 < 216 - 1，那麼得到就是 key 的 hash 值，否則就不是。
為了後面方便講解，就將它稱為 hash 值。計算 hash 值可供後面計算結點應該存在陣列的哪個索引位置。
第四步：執行 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;
// table 其實就是陣列，定義：
// transient Node<K,V>[] table;
// 判斷陣列是否為空，如果為空呼叫 resize() 方法進行第一次擴容
// 並將擴容後的陣列大小返回給 n
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
// 此處省略一大堆程式碼
}
初始化 HashSet（或者是 HashMap）後，陣列是空值（null），需要進行陣列的擴容
第五步：呼叫 resize() 進行擴容
final Node<K,V>[] resize() {
// 定義輔助變數
Node<K,V>[] oldTab = table;
// 舊陣列長度 0
int oldCap = (oldTab == null) ? 0 : oldTab.length;
// 舊臨界值
int oldThr = threshold;
// 新的陣列長度和臨界值
int newCap, newThr = 0;
// 不滿足條件
if (oldCap > 0) {
if (oldCap >= MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return oldTab;
}
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
// 新的陣列長度預設為 16
newCap = DEFAULT_INITIAL_CAPACITY;
// 新的臨界值預設為 12
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) {
// 省略一大堆程式碼
}
// 返回新的陣列
return newTab;
}
第六步：繼續執行 putVal 方法
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);
// 如果不為空，則該位置有可能是連結串列或紅黑樹，目前不會執行這一步
else {
// 此處省略一大堆程式碼
}
++modCount; // 修改次數 +1
// 判斷新增後的節點數是否大於臨界值
if (++size > threshold)
// 如果大於，再次擴容
resize();
// 一個空方法，供繼承 HashMap 的類去實現
afterNodeInsertion(evict);
return null;
}
第 9 行：(n - 1) & hash 是計算索引的演算法，計算後可以得到一個 0 ~ n -1 範圍的值
這裡的 n 也就是陣列的長度是始終是 2 的 m 次冪，擴容後是 2m+1 ，例如初始大小 16 = 24 ，第二次擴容 32 = 25 等。
當前的陣列大小為 16，那麼 n -1 用二進位制表示就是 0000 1111（高位省略），二進位制與運算（&）可以用來隱藏和顯示某些位。這裡的 0000 1111 & hash 就是指顯示 hash 值的後 4 位，最終就會得到 0 ~ 15 之間的數，作為陣列的索引。
add 重複結點機制
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);
// 上面講過註釋省略，從這裡開始分析
// 如果當前索引位置不為空（是連結串列或紅黑樹）
else {
// 定義輔助變數
Node<K,V> e; K k;
// 判斷當前索引位置的結點的 hash 值是否和新結點的 hash 值相同
// 並且 key 物件相同或者 key 值相等（equlas）
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
// 將當前索引位置的結點賦值給 e
e = p;
// 判斷當前索引位置是否是紅黑樹
else if (p instanceof TreeNode)
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
// 當前索引位置是連結串列
else {
// 程式碼省略
}
// 用 e 是否為空來判斷是否存在重複結點
if (e != null) { // existing mapping for key
V oldValue = e.value;
// 判斷是否更新 value
// 這裡 value 始終是一個 object 物件，用來佔位，所以不需要更新
if (!onlyIfAbsent || oldValue == null)
e.value = value;
// 一個空方法，供 HashMap 的子類實現
afterNodeAccess(e);
// 返回舊的 value
return oldValue;
}
}
// 下面講過註釋省略
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
add 連結串列結點機制
通過自定義類，重寫 hashCode 返回一個定值，就可以使新增的結點的 hash 值相同，從而都新增到一個連結串列上
import java.util.HashSet;
public class HashSetIncrement {
@SuppressWarnings({"all"})
public static void main(String[] args) {
HashSet hashSet = new HashSet();
for (int i = 1; i < 5; i++) {
hashSet.add(new A(i));
}
System.out.println("hashSet = " + hashSet);
}
}
class A {
private int n;
public A(int n) {
this.n = n;
}
@Override
public int hashCode() {
return 100;
}
}
打上斷點，當 i == 2 時強制進入
來到 putVal 方法
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);
else {
Node<K,V> e; K k;
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
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);
// 判斷連結串列的結點數是否到達轉為紅黑樹的臨界值（8）
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
// bin 可以理解為連結串列的結點
// 當 binCount 為 7 時，此時的位置是第 8 個結點
// 但由於剛剛又加入了一個結點，所以實際連結串列上已經有 9 個結點了
// 所以準確的說應該是超過臨界值後會轉為紅黑樹，不是到達
// 只不過 binCount 是從 0 開始數的，導致結點數少了一個
// 轉為紅黑樹
treeifyBin(tab, hash);
break;
}
// 判斷當前結點的 hash 是否和新結點的 hash 相同
// 並且 key 物件相同或者 key 值相同
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;
afterNodeAccess(e);
return oldValue;
}
}
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
第 26 行：進入 treeifyBin(tab, hash) 後還要進行一下判斷，才可能轉成紅黑樹
final void treeifyBin(Node<K,V>[] tab, int hash) {
// 定義輔助變數
int n, index; Node<K,V> e;
// 判斷陣列是否為空，或者陣列長度小於一個臨界值（64）
if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
// 進行陣列擴容，而不是轉成紅黑樹
resize();
else if ((e = tab[index = (n - 1) & hash]) != null) {
// 轉紅黑樹的程式碼省略
}
}
也就是說，就算連結串列上的結點到達了 8 個，但此時陣列長度小於 64，是不會將其轉為紅黑樹的，而是進行一次擴容。
table 陣列擴容機制
final Node<K,V>[] resize() {
// 定義輔助變數
Node<K,V>[] oldTab = table;
// 舊陣列長度 0
int oldCap = (oldTab == null) ? 0 : oldTab.length;
// 舊臨界值
int oldThr = threshold;
// 新的陣列長度和臨界值
int newCap, newThr = 0;
// 第 n 此擴容，n > 1
if (oldCap > 0) {
// 判斷舊陣列長度是否大於最大值
if (oldCap >= MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return oldTab;
}
// 新陣列長度擴大兩倍
// 並判斷新陣列長度是否 < 最大值，同時舊陣列長度是否 >= 初始長度（16）
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
oldCap >= DEFAULT_INITIAL_CAPACITY)
// 新陣列長度臨界值擴大兩倍
newThr = oldThr << 1; // double threshold
}
// 判斷舊陣列長度臨界值是否 > 0
else if (oldThr > 0) // initial capacity was placed in threshold
// 新陣列長度為舊陣列長度臨界值
// oldCap 為 0，因為如果 > 0 就走第一個條件了
newCap = oldThr;
// 第一次擴容
else { // zero initial threshold signifies using defaults
// 新的陣列長度預設為 16
newCap = DEFAULT_INITIAL_CAPACITY;
// 新的臨界值預設為 12
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
// 判斷是否新臨界值為 0
if (newThr == 0) {
// 將新陣列大小的 0.75 倍賦值給 ft
// 初始化 HashMap 時就指定了 loadFactor 為預設臨界因子（0.75f）
float ft = (float)newCap * loadFactor;
// 如果新的陣列大小 < 最大長度，並且 ft < 最大長度，新的陣列長度臨界值就為 ft
// 否則為整數的最大值
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)
// 沒有下一個結點就直接將該結點移動到新陣列上
// 注意：索引是由陣列長度和 hash 值共同決定的
// 此時計算索引用的是新陣列的長度，結果可能會與舊陣列的索引不同
newTab[e.hash & (newCap - 1)] = e;
// 判斷該索引位置是不是一個紅黑樹
else if (e instanceof TreeNode)
// 移動樹上的結點
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
// 該索引位置是一個連結串列
else { // preserve order
// 定義 lowHead，lowTail，表示低位連結串列的頭結點和尾節點
Node<K,V> loHead = null, loTail = null;
// 定義 hightHead，hightTail，表示高位連結串列的頭結點和尾節點
// 低位連結串列和高位連結串列裡的位，表示的是陣列索引位
// 由於陣列長度的增加，新陣列的索引位置可能不變，也可能變大
// 如果不變，就用低位連結串列；如果變大，就用高位連結串列
Node<K,V> hiHead = null, hiTail = null;
Node<K,V> next; // 定義下一個結點
do {
// 獲取下一個結點
next = e.next;
// 計算新新陣列的索引位是否不變
if ((e.hash & oldCap) == 0) {
// 判斷當前結點是否是頭結點
// 因為最開始定義 loTail 為 null
// 而如果添加了一個結點後，loTail 就會指新的結點，不為 null
if (loTail == null)
// 將當前結點賦值給頭結點
loHead = e;
// 當前結點不是頭結點
else
// 將當前結點新增到最後
loTail.next = e;
// 尾節點指向最後的新結點
loTail = e;
}
// 新陣列的索引位變大，使用高位連結串列
else {
// 和上面的低位連結串列一樣的操作
if (hiTail == null)
hiHead = e;
else
hiTail.next = e;
hiTail = e;
}
// 繼續下一個結點
} while ((e = next) != null);
// 判斷低位連結串列是否為非空連結串列
if (loTail != null) {
loTail.next = null;
// 移動到新陣列上的索引不變
newTab[j] = loHead;
}
// 判斷高位連結串列是否為非空連結串列
if (hiTail != null) {
hiTail.next = null;
// 移動到新陣列上的索引變大，相差一箇舊陣列的長度
newTab[j + oldCap] = hiHead;
}
}
}
}
}
// 返回新的陣列
return newTab;
}
細節解釋
移動連結串列時並不是把整個連結串列直接移動到新陣列上，而是一個一個結點的移動。因為隨著陣列擴容後陣列長度的變大，每個結點計算出的索引會和之前的不一樣。
例如 陣列長度由 16 位擴容到 32 位，這時顯示的 hash 值就從之前的 4 位變大到 5位：
000****0 1111 & hash VS 000****1 1111 & hash，從之前的顯示 4 位，到新的顯示 5 位。假如 hash 值在第 5 位為 1，那麼這兩個結果就會不同，新的結果比舊的大 0001 0000 = 16 剛好就是舊陣列長度。假如 hash 值在第 5 位為 0，那麼這兩個結果就相同。
由於每個結點的 hash 是未知的，我們不知道 hash 的第 5 位是 0 還是 1，所以擴容後每個結點的新索引都有可能發生變化，我們需要一個結點一個結點的判斷。
在第 87 行：(e.hash & oldCap) == 0，換成二進位制就是 hash & 0001 0000，就可以判斷 hash 第 5 位的值。如果是 0，那索引就沒有變化，新增到低位連結串列；如果是 1，那索引就變大（相差一個 oldCap），新增到高位連結串列。
在第 122 行：newTab[j + oldCap] = hiHead; 將高位連結串列新增到新的陣列索引上
單步除錯
在進行單步除錯前，先調一下設定，否則無法看到 HashMap 裡的空值
擴大新增的數量，在 add 處打一個斷點
然後去 putVal 轉紅黑樹的位置打個斷點
取消第一個斷點，直接跳到下一個斷點
這樣就來到了轉紅黑樹的地方
可以看到，由於 hash 值固定，結點都放到了陣列索引為 4 的連結串列上。進入該方法：
這裡陣列長度 < 64，所以不會進行轉紅黑樹，而是進行陣列擴容。
由於 100 < 216 - 1，所以經過 hash 演算法後得到的值就是 hash 值本身：100，沒有改變（前面第三步解釋過），二進位制形式為：0110 0100 第 5 位為 0，故在轉移結點時，所有的結點都在低位連結串列上，新陣列的索引沒有改變。
這裡的 size 還是 8，因為這是剛剛出擴容方法（resize）時的情況，在 putVal 最後才會將 size + 1
第三次擴容
再新增一個結點還會進行擴容，因為此時的陣列長度為 32 < 64，這次擴容就要看 hash 的第 6 位了。此時的情況是：0010 0000 & hash ，前面說過 hash 是 100 也就是 0010 0000 & 0110 0100 得到第 6 位為 1，所以轉移結點時，所有結點都在高位連結串列上。新的陣列索引應該是 4 + 32 = 36。
直接跳到下一個結點，然後點選掉過，讓它擴容
陣列情況如下所示