Java HashMap深入理解增刪改查 原始碼學習 學習筆記
阿新 • • 發佈：2022-03-27
Java原始碼解讀（三）— HashMap深入理解之增刪查改
學習地址：[HashMap深入理解之增刪查改]: https://blog.csdn.net/dongmuyang/article/details/98751508
本文為Java 8原始碼解讀，已有紅黑樹。
主要成員變數
// 儲存鍵值對的陣列，其length為capacity transient Node<K,V>[] table; // 實際儲存的鍵值對的個數，超過threshold(capacity*load factory),則resize() transient int size; // 修改次數，當put/remove/clear等改變集合的操作時，都會加一 // 用於併發情況下：A執行緒迭代器遍歷，B執行緒改變集合，此時出現fail-fast異常 transient int modCount; // resize()的閾值，預設值是(int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY)=0.75*16=12 int threshold; // 負載因子，預設為0.75 final float loadFactor;
靜態變數
// 預設容量，即table的預設長度 static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16 // 最大容量 static final int MAXIMUM_CAPACITY = 1 << 30; // 預設負載因子 static final float DEFAULT_LOAD_FACTOR = 0.75f; // 解決雜湊衝突，小於這個閾值時用的鏈地址法，大於等於這個閾值時變為紅黑樹 static final int TREEIFY_THRESHOLD = 8; // 小於這個閾值時，重新變為鏈地址法，只會在resize()的時候出現 // remove的時候，是否從紅黑樹轉為連結串列的判斷條件不是這個 static final int UNTREEIFY_THRESHOLD = 6; // 當table的長度小於這個閾值時，只使用resize()擴充table；大於等於它的時候才會用紅黑樹解決雜湊衝突 static final int MIN_TREEIFY_CAPACITY = 64;
建構函式
// tableSizeFor()會將initialCapacity變為不小於它的2^n值，並暫存於threshold中，注意是暫存，後面resize()的時候會改變 // 當第一次呼叫put()的時候，會啟動resize()函式 // 而在resize()中，capacity=threshold，為tab申請capacity大小的記憶體，即tab的length為capacity // 並且重置threshold=capacity*loadFactor 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; this.threshold = tableSizeFor(initialCapacity); } public HashMap(int initialCapacity) { this(initialCapacity, DEFAULT_LOAD_FACTOR); } // DEFAULT_LOAD_FACTOR=0.75 public HashMap() { this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted } // 拷貝建構函式 public HashMap(Map<? extends K, ? extends V> m) { this.loadFactor = DEFAULT_LOAD_FACTOR; putMapEntries(m, false); }
內部類
// 儲存鍵值對的類
static class Node<K,V> implements Map.Entry<K,V> {...}
// 紅黑樹節點，構造方法與Node一致
static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {...}
// HashMap中的迭代器的父類，可以使用remove
abstract class HashIterator {
public final boolean hasNext() {...}
final Node<K,V> nextNode() {...}
public final void remove() {...}
}
// 用於遍歷keySet的迭代器
final class KeyIterator extends HashIterator
implements Iterator<K> {
public final K next() { return nextNode().key; }
}
// 用於遍歷valuse的迭代器
final class ValueIterator extends HashIterator
implements Iterator<V> {
public final V next() { return nextNode().value; }
}
// 用於遍歷entrySet的迭代器
final class EntryIterator extends HashIterator
implements Iterator<Map.Entry<K,V>> {
public final Map.Entry<K,V> next() { return nextNode(); }
}
// iterator()返回keyIterator，並且可呼叫remove，forEach
final class KeySet extends AbstractSet<K> {...}
// 沒有remove，其他與keySet差不多
final class Values extends AbstractCollection<V> {...}
final class EntrySet extends AbstractSet<Map.Entry<K,V>> {...}
// 還有spliterator迭代器，用於並行迭代的，但是不常用
// 用了幾次還會出Bug：元素沒有迭代完。具體原因有待考究
查
// 若存在該key，則返回對應的value；否則返回null
public V get(Object key) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
// 若存在該key，則返回對應的value；否則返回defaultValue
public V getOrDefault(Object key, V defaultValue) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? defaultValue : e.value;
}
// 查詢是否存在該key
public boolean containsKey(Object key) {
return getNode(hash(key), key) != null;
}
// 若存在該key，則返回該key所在的節點；否則返回null
final Node<K,V> getNode(int hash, Object key) {
Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
// 如果table不為空，且該hash所在的bucket不為空，繼續查詢
if ((tab = table) != null && (n = tab.length) > 0 &&
(first = tab[(n - 1) & hash]) != null) {
// 如果第一個節點的key就是，直接返回
if (first.hash == hash && // always check first node
((k = first.key) == key || (key != null && key.equals(k))))
return first;
// 如果第一個節點不是我們要找的
if ((e = first.next) != null) {
// 如果是紅黑樹節點，則呼叫紅黑樹的方法查詢，快一點：O(logn)
if (first instanceof TreeNode)
return ((TreeNode<K,V>)first).getTreeNode(hash, key);
// 否則就是連結串列節點，直接使用next屬性
do {
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
return e;
} while ((e = e.next) != null);
}
}
return null;
}
// 確保從根節點開始，呼叫find()方法查詢
final TreeNode<K,V> getTreeNode(int h, Object k) {
return ((parent != null) ? root() : this).find(h, k, null);
}
// 若存在該key，則返回該key所在的節點；否則返回null
final TreeNode<K,V> find(int h, Object k, Class<?> kc) {
TreeNode<K,V> p = this;
do {
int ph, dir; K pk;
TreeNode<K,V> pl = p.left, pr = p.right, q;
// 要查詢的hash值小於當前節點hash值，進入左子樹
if ((ph = p.hash) > h)
p = pl;
// 要查詢的hash值大於當前節點hash值，進入右子樹
else if (ph < h)
p = pr;
// 若hash值相等，且key相等，則返回該節點
else if ((pk = p.key) == k || (k != null && k.equals(pk)))
return p;
// 若無右子樹，則直接進入左子樹
else if (pl == null)
p = pr;
// 若無左子樹，則直接進入右子樹
else if (pr == null)
p = pl;
// 若hash相等，key不相等，且左右子樹皆在，則用key的class判斷去左邊還是右邊
// 具體見下方連結
else if ((kc != null ||
(kc = comparableClassFor(k)) != null) &&
(dir = compareComparables(kc, k, pk)) != 0)
p = (dir < 0) ? pl : pr;
// 若key的class還是無法判斷，即dir == 0，則窮舉所有孩子節點
// 先窮舉右子樹
else if ((q = pr.find(h, k, kc)) != null)
return q;
// 右子樹搜尋不到，再窮舉左孩子的右子樹
else
p = pl;
} while (p != null);
// 實在找不到，返回null
return null;
}
// 若存在一個或者多個節點包括該value，返回true；否則返回false
public boolean containsValue(Object value) {
Node<K,V>[] tab; V v;
if ((tab = table) != null && size > 0) {
for (int i = 0; i < tab.length; ++i) {
// 使用next屬性遍歷，Node和TreeNode都有該屬性，比查詢key慢
for (Node<K,V> e = tab[i]; e != null; e = e.next) {
if ((v = e.value) == value ||
(value != null && value.equals(v)))
return true;
}
}
}
return false;
}
增
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
// 如果是更新節點，則返回舊的value；如果是插入節點，返回null
// onlyIfAbsent預設為false，直接更新value的值；若為true，只有當vaule是null的時候才會更新
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申請空間，則先為其申請空間
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
// 若當前bucket節點為空，則直接新建節點賦值
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
else {
Node<K,V> e; K k;
// 若當前bucket的節點的key與要put的key一致，則先記錄，後面更新value
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
e = p;
// 若是紅黑樹節點，呼叫putTreeVal()；
// 若在putTreeVal()中未找到該key，並且成功插入，則返回null；
// 若在putTreeVal()中找到了該key，返回找到的節點，用於後面更新value
else if (p instanceof TreeNode)
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
// 連結串列節點
else {
// 記錄當前bucket中連結串列節點的個數，若大於等於8，則轉為紅黑樹
for (int binCount = 0; ; ++binCount) {
// 若沒找到，則在連結串列結尾插入並跳出；此時e為null
if ((e = p.next) == null) {
p.next = newNode(hash, key, value, null);
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
treeifyBin(tab, hash);
break;
}
// 若在連結串列中找到key一致的節點，直接跳出，此時e為要更新的節點
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
// 更新value，返回舊的value
if (e != null) { // existing mapping for key
V oldValue = e.value;
// 若為false，直接更新；若為true，只有當oldValue為null才更新
if (!onlyIfAbsent || oldValue == null)
e.value = value;
// 為LinkedHashMap提供的服務，由於LinkedashMap有befor和after屬性指向前後的bucket
// 若LinkedHashMap按訪問順序排序，則該方法將當前節點放入雙向bucket連結串列的末尾
// 若LinkedHashMap按插入順序排序，該方法無用
afterNodeAccess(e);
return oldValue;
}
}
// 若是插入操作，記錄變化
++modCount;
// 若超過負載的閾值，擴容
if (++size > threshold)
resize();
// 為子類LinkedHashMap服務的，刪除最早放入Map的物件
// 雖然evict預設為true，但是由於LinkedHashMap的removeEldestEntry()方法預設返回false，一般呼叫不會成功
// 如果確實需要該功能，需要重寫removeEldestEntry()方法
afterNodeInsertion(evict);
return null;
}
// 若找到key一致的節點，返回該節點；未找到則插入，並返回null
final TreeNode<K,V> putTreeVal(HashMap<K,V> map, Node<K,V>[] tab,
int h, K k, V v) {
Class<?> kc = null;
boolean searched = false;
TreeNode<K,V> root = (parent != null) ? root() : this;
for (TreeNode<K,V> p = root;;) {
int dir, ph; K pk;
// 判斷是在當前節點的左邊還是右邊
if ((ph = p.hash) > h)
dir = -1;
else if (ph < h)
dir = 1;
// 若雜湊一致，且key一致，則返回該節點用於更新
else if ((pk = p.key) == k || (k != null && k.equals(pk)))
return p;
// 若雜湊一致，但key不一致，用key的class來區分在左子樹還是右子樹
else if ((kc == null &&
(kc = comparableClassFor(k)) == null) ||
(dir = compareComparables(kc, k, pk)) == 0) {
// 若dir還等於0，即還未區分左右子樹，則在該節點的左右子樹中尋找
if (!searched) {
TreeNode<K,V> q, ch;
searched = true;
// 若找到，返回找到的節點
if (((ch = p.left) != null &&
(q = ch.find(h, k, kc)) != null) ||
((ch = p.right) != null &&
(q = ch.find(h, k, kc)) != null))
return q;
}
// 若還未找到，用這個方法來比較兩個物件，返回值要麼大於0，要麼小於0，不會為0，用於區分左右子樹
dir = tieBreakOrder(k, pk);
}
TreeNode<K,V> xp = p;
// 如果p為null，根據dir插入
if ((p = (dir <= 0) ? p.left : p.right) == null) {
Node<K,V> xpn = xp.next;
// 呼叫建構函式時，已經指定了next關係，x.next = xpn
TreeNode<K,V> x = map.newTreeNode(h, k, v, xpn);
if (dir <= 0)
xp.left = x;
else
xp.right = x;
xp.next = x;
x.parent = x.prev = xp;
if (xpn != null)
((TreeNode<K,V>)xpn).prev = x;
// balanceInsertion()調整紅黑樹的平衡，返回紅黑樹的根節點
// moveRootToFront()確保當前bucket儲存的是紅黑樹的根節點
moveRootToFront(tab, balanceInsertion(root, x));
return null;
}
}
}
改
在put()中已經可以更新value的值了，但是還是有更新專用的方法的：
// 只有在key和oldValue都匹配的情況下，才更新value的值
public boolean replace(K key, V oldValue, V newValue) {
Node<K,V> e; V v;
if ((e = getNode(hash(key), key)) != null &&
((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) {
e.value = newValue;
afterNodeAccess(e);
return true;
}
return false;
}
// 只需key匹配到，即可更新value
public V replace(K key, V value) {
Node<K,V> e;
if ((e = getNode(hash(key), key)) != null) {
V oldValue = e.value;
e.value = value;
afterNodeAccess(e);
return oldValue;
}
return null;
}
刪
// matchValue為false，key相等即可刪除該節點；返回刪除節點的value
public V remove(Object key) {
Node<K,V> e;
return (e = removeNode(hash(key), key, null, false, true)) == null ?
null : e.value;
}
// matchValue為true，只有當key和value都相等的時候才刪除該節點；返回是否刪除成功
public boolean remove(Object key, Object value) {
return removeNode(hash(key), key, value, true, true) != null;
}
// 刪除
final Node<K,V> removeNode(int hash, Object key, Object value,
boolean matchValue, boolean movable) {
Node<K,V>[] tab; Node<K,V> p; int n, index;
// 確保table不為空且該hash所在bucket有值
if ((tab = table) != null && (n = tab.length) > 0 &&
(p = tab[index = (n - 1) & hash]) != null) {
Node<K,V> node = null, e; K k; V v;
// 如果第一個節點即為要刪除節點，先賦值給node，刪除操作在後面
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
node = p;
// 如果第一個節點不是
else if ((e = p.next) != null) {
// 如果是紅黑樹節點，則呼叫紅黑樹查詢得到要刪除的節點，快一點
if (p instanceof TreeNode)
node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
// 如果是連結串列節點，直接使用next屬性查詢
else {
do {
if (e.hash == hash &&
((k = e.key) == key ||
(key != null && key.equals(k)))) {
node = e;
break;
}
p = e;
} while ((e = e.next) != null);
}
}
// matchValue為true時，還會判定value是否相等
if (node != null && (!matchValue || (v = node.value) == value ||
(value != null && value.equals(v)))) {
// 若是紅黑樹節點，需要使用紅黑樹的刪除節點的方法
if (node instanceof TreeNode)
((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
// 若是第一個節點，則將bucket的地址指向其next節點
else if (node == p)
tab[index] = node.next;
// 否則直接刪除
else
p.next = node.next;
// 累計修改次數
++modCount;
--size;
// 為LinkedHashMap提供的服務，由於LinkedHashMap使用雙向連結串列串聯所有bucket
// 每個節點具有before和after屬性，該方法修改雙向連結串列
afterNodeRemoval(node);
return node;
}
}
// 沒找到要刪除的節點，返回null
return null;
}
final void removeTreeNode(HashMap<K,V> map, Node<K,V>[] tab,
boolean movable) {
int n;
if (tab == null || (n = tab.length) == 0)
return;
int index = (n - 1) & hash;
TreeNode<K,V> first = (TreeNode<K,V>)tab[index], root = first, rl;
TreeNode<K,V> succ = (TreeNode<K,V>)next, pred = prev;
// 如果是第一個節點，直接賦值next
if (pred == null)
tab[index] = first = succ;
// 否則 ，將next節點賦給prev節點的next
else
pred.next = succ;
// 如果next節點不為空，還要修改它的prev屬性
if (succ != null)
succ.prev = pred;
// 如果刪除之後，該bucket為空，直接結束
if (first == null)
return;
// 確保root為根節點
if (root.parent != null)
root = root.root();
// 如果根節點、右子樹、左子樹、左孩子的左子樹，這四個中有一個為空，都會變為連結串列
if (root == null
|| (movable
&& (root.right == null
|| (rl = root.left) == null
|| rl.left == null))) {
tab[index] = first.untreeify(map); // too small
return;
}
// 確保紅黑樹的平衡
......
}