HashMap原始碼分析
目錄
目錄
1. 概述
HashMap是一種key/value形式的儲存結構. 它綜合了陣列(查詢容易, 插入和刪除困難)和連結串列(插入和刪除容易, 查詢困難)的特點.
HashMap的核心點就是hash演算法和紅黑樹演算法.
HashMap是無序的.
2. 儲存結構
HashMap的儲存結構為陣列 + 連結串列/紅黑樹.
其中陣列就是普通的陣列, 連結串列是為了解決hash衝突而產生的, 如果衝突元素大於指定值, 就會由連結串列變為紅黑樹, 如果衝突元素少於指定的值, 就會由紅黑樹變為連結串列.
2-1. 什麼是hash衝突?
當產生hash衝突的時候就產生了連結串列或紅黑樹, 一個完美的HashMap是單純的陣列結構, 並不會存在連結串列或紅黑樹結構的, 不過完美的事是不存在的, 只能儘可能的接近完美.
假設元素A被成功的新增到HashMap中, 儲存在陣列下標為0的地方, 這時元素B要被新增進來, 但是經過hash演算法計算, 元素B要也要儲存在陣列下標為0的地方上, 這時候就產生了hash衝突.
2-2. 如何解決hash衝突?
出現了hash衝突, 解決方法就是在陣列下標0處, 產生一個連結串列, 元素A為連結串列的表頭, 新元素B放到連結串列的尾部.
2-3. 負載因子的作用
是這樣的, 預設負載因子是0.75, 也就是HashMap中的陣列填滿了75%之後就會進行擴容.
- 如果負載因子過大, 則會導致hash衝突的機會越大, 但是空間使用率高;
- 如果負載因子過小, 則會導致空間的過度浪費, 但是hash衝突的機會越小.
所以, 必須在衝突的機會和空間利用率之間尋求一種平衡, 這種平衡本質上是資料結構中有名的時間和空間的平衡.
2-4. HashMap的陣列容量(桶容量)為什麼必須是2的冪次方?
首先給出答案: 為了使元素坐落於HashMap的承載量(size)之間.
答案和問題看起來毫無關係, 下面來分析一下是如何聯絡在一起的?
比如: 把"1"存入HashMap中, 會進行如下幾步
- 計算key的hashCode(key.hashCode()), 得到h
- 然後對h進行低16位和高16位的異或運算, 得到hash (異或運算: 兩個值不同為1, 相同為0)
- 然後進行 (size - 1) & hash 的運算得到 (與運算: 只要有一個為1, 結果就是1)
第二步中的低16位與高16位進行運算是為了更好的進行雜湊(如果兩個元素的低16位相同, 不進行高低16位運算的話, 出現hash衝突的機會就會變大), 高低16位運算之後, 可以減少hash衝突的機會.
最重要的就是第三步了, 也就是問題的答案, 如果桶容量大小是2的倍數(預設值16), 進行(size - 1)運算之後的值為15, 15的二進位制為0001111, 15與第二步得到的hash進行運算後, 只會保留低4位的值, 高於4位的值都被去掉了(運算後為0). 既然只有低4位的值, 那麼轉化為十進位制之後, 必然小於16, 正確的坐落於桶上. 完美!
3. 建構函式
只說這個比較重要的建構函式
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);
}
預設的負載因子為: DEFAULT_LOAD_FACTOR(0.75).
使用者自定義初始化容量, 但是HashMap會對傳入的初始化容量進行校驗(tableSizeFor), 需要確保這個值必須是2的冪次方.
4. 操作
4-1. 新增
新增操作分為三種情況:
- 在陣列上新增
- 在連結串列上新增
- 在紅黑樹上新增(比較菜, 不做討論)
4-1-1. 在陣列上新增
所謂在陣列上新增, 就是沒有發生hash衝突的情況下進行元素的新增, 這是最好的情況.
4-1-2. 在連結串列上新增
在連結串列上新增, 出現了hash衝突, 元素會被新增到連結串列的尾端
4-1-3. 在紅黑樹上新增
在紅黑樹上新增, 就是衝突的元素太多了, 連結串列的長度大於了指定的長度, 由於對連結串列的查詢比較耗效能, 所以會轉變為紅黑樹.
有紅黑樹生成的情況下是HashMap效能最差的情況.
新增原始碼如下
/**
* Implements Map.put and related methods
*
* @param hash hash for key
* @param key the key
* @param value the value to put
* @param onlyIfAbsent if true, don't change existing value
* @param evict if false, the table is in creation mode.
* @return previous value, or null if none
*/
final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict) {
HashMap.Node<K,V>[] tab; // 引用HashMap的table
HashMap.Node<K,V> p; // HashMap中的一個節點
int n, i; // n:HashMap中元素的個數; i:新元素的在陣列中的下標
// 如果table沒有進行初始化, 先進行初始化操作
if ((tab = table) == null || (n = tab.length) == 0) {
n = (tab = resize()).length;
}
// 通過上面的說明: (n - 1) & hash 這段程式碼就是進行陣列下標的運算
if ((p = tab[i = (n - 1) & hash]) == null) {
// 這是最好的情況: 沒有出現hash衝突, 直接在建立一個節點放到該位置上
tab[i] = newNode(hash, key, value, null);
} else {
// 出現了hash衝突, 需要區分幾種情況:
// 1. 判斷p的hash, key是否與傳入的相同, 如果相同, 則預設會使用傳入的value替換原先的value值.
// 2. 如果有不同, 判斷p節點是否是樹, 如果是, 則進行紅黑樹的新增操作.
// 3. 如果有不同, 並且不是樹, 則只能是連結串列, 使用迴圈找到連結串列的最後一個元素, 連結在連結串列的尾部, 如果連結串列的長度大於一定長度, 就會由連結串列變為紅黑樹
HashMap.Node<K,V> e;
K k;
// 這裡比較了 hash, key 是否相同
if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k)))) {
e = p;
} else if (p instanceof HashMap.TreeNode) {
// 進行紅黑樹的新增操作
e = ((HashMap.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;
}
// 每次迴圈時都要判斷一下連結串列上元素的hash, key是否與傳入的相同, 如果相同, 則預設會使用傳入的value替換原先的value值.
// 相同時, e物件即為衝突元素
if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k)))) {
break;
}
p = e;
}
}
// 如果e不為空, 則表示發生了衝突
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null) {
e.value = value;
}
// 這個在HashMap中實現為空, LinkedHashMap需要實現它
afterNodeAccess(e);
return oldValue;
}
}
// HashMap結構的改變次數
++modCount;
// 判斷是否需要擴容
if (++size > threshold) {
resize();
}
// 這個在HashMap中實現為空, LinkedHashMap需要實現它
afterNodeInsertion(evict);
return null;
}
4-2. 刪除
由HashMap的資料結構可以想得到, 刪除分為三種情況
- 在陣列上刪除, 這種情況是最簡單的, 只需指向null即可.
- 在連結串列上刪除, 由於連結串列對刪除比較擅長, 直接讓
- 在紅黑樹上刪除, 母雞呀.
4-2-1. 刪除原始碼如下
/**
* Implements Map.remove and related methods
*
* @param hash hash for key
* @param key the key
* @param value the value to match if matchValue, else ignored
* @param matchValue if true only remove if value is equal
* @param movable if false do not move other nodes while removing
* @return the node, or null if none
*/
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;
// 計算得到陣列的下標, 判斷是否有元素
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;
// hash, key相同, 說明要刪除該元素, 這種情況: node = p
if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k)))) {
node = p;
} else if ((e = p.next) != null) { // 如果hash,key不同, 判斷是否有下一個元素
// 如果下一個元素的節點型別是 TreeNode, 則去獲取紅黑樹的節點
if (p instanceof TreeNode)
node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
else {
// 是連結串列, 迴圈, 依次判斷連結串列上的元素的hash和key是否相同, 找到即退出.
do {
if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k)))) {
node = e;
break;
}
// p的值永遠是相同節點的上一個節點
p = e;
} while ((e = e.next) != null);
}
}
// 上面只是進行元素的查詢, 這裡才是真正的刪除
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);
// 陣列上的刪除
else if (node == p)
tab[index] = node.next;
// 連結串列上的刪除
else
p.next = node.next;
// 記錄集合元素改變次數
++modCount;
// 集合元素數量減1
--size;
// 這個在HashMap中實現為空, LinkedHashMap需要實現它
afterNodeRemoval(node);
// 返回刪除的節點, 具體返回刪除節點的value值.
return node;
}
}
return null;
}
4-3. 查詢
通過分析上面的刪除操作, 很明顯, 在刪除操作的前半部分是一個常規的查詢操作.
4-4. 替換
替換操作也可以想象的到, 先找到要替換的元素(就是查詢操作), 然後把value替換了即可.
5. 遍歷
HashMap的的遍歷有幾種
5-1. 使用foreach進行遍歷
實際上這種方式被編譯之後是Iterator的方式.
例如
HashMap<String, String> map = new HashMap<>();
for (Map.Entry<String, String> entry : map.entrySet()) {
System.out.println(entry.getKey() + ":" + entry.getValue());
}
反編譯class檔案
HashMap<String, String> map = new HashMap();
Iterator var2 = map.entrySet().iterator();
while(var2.hasNext()) {
Entry<String, String> entry = (Entry)var2.next();
System.out.println((String)entry.getKey() + ":" + (String)entry.getValue());
}
可以看到實際上是使用的entrySet().iterator()的方式, 語法糖?
5-2. 使用keySet進行遍歷
這種方式不如使用foreach的效能好, 可以發現, 這種方式還要進行一次map.get(key)操作.
Iterator<String> iterator = map.keySet().iterator();
while (iterator.hasNext()) {
String key = iterator.next();
System.out.println(key + ":" + map.get(key));
}
5-3. 遍歷所有的key
這種方式就可以簡單的通過map.keySet()進行實現.
5-4. 遍歷所有的value
這種方式可以通過map.values()進行獲取.
6. 擴容 & rehash
這是一個比較重要的點, 擴容的同時還會帶有rehash操作.
正常狀態下, 會進行2倍擴容.
/**
* Initializes or doubles table size. If null, allocates in
* accord with initial capacity target held in field threshold.
* Otherwise, because we are using power-of-two expansion, the
* elements from each bin must either stay at same index, or move
* with a power of two offset in the new table.
*
* @return the table
*/
final Node<K,V>[] resize() {
// 獲取桶引用
Node<K,V>[] oldTab = table;
// new HashMap()時oldCap=0
// 有元素時, oldCap即為oldTab.length
int oldCap = (oldTab == null) ? 0 : oldTab.length;
// new HashMap()時threshold為0
// 有元素時, threshold為桶長度的0.75
int oldThr = threshold;
// 定義新的桶容量, 新的threshold
int newCap, newThr = 0;
// new HashMap()時不會進入if
// 有元素時, 舊桶的容量大於0, 會進入
if (oldCap > 0) {
// 舊桶的容量是否大於MAXIMUM_CAPACITY(1 << 30, 也就是Integer.MAX_VALUE / 2 + 1)
// 直接返回 Integer.MAX_VALUE, 這裡校驗是防止 oldCap * 2 之後發生整型溢位.
if (oldCap >= MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return oldTab;
}
// 新桶的大小是舊桶大小的2倍(2倍擴容).
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
// 舊桶的長度大於等於16了
oldCap >= DEFAULT_INITIAL_CAPACITY) {
// 2倍, 桶的長度擴大2倍,threshold也同時擴大2倍, 保持0.75不變.
newThr = oldThr << 1; // double threshold
}
}
// oldCap = 0 & oldThr > 0; 這種情況是使用 new HashMap(int initialCapacity)
// 或 new HashMap(int initialCapacity, float loadFactor)產生的
else if (oldThr > 0) { // initial capacity was placed in threshold
newCap = oldThr;
}
// new HashMap()時, 走這裡
else { // zero initial threshold signifies using defaults
newCap = DEFAULT_INITIAL_CAPACITY; // 16
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY); // 16 * 0.75 = 12
}
// 如果newThr還是為0, 可能是走了else if (oldThr > 0)這個條件
if (newThr == 0) {
float ft = (float)newCap * loadFactor;
newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
(int)ft : Integer.MAX_VALUE);
}
// new HashMap()時 threshold = 12
threshold = newThr;
// 根據newCap建立新的桶
@SuppressWarnings({"rawtypes","unchecked"})
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
// 改變table的指向
table = newTab;
// 進行舊桶中元素的rehash
if (oldTab != null) {
// 迴圈整個舊陣列(桶)
for (int j = 0; j < oldCap; ++j) {
// 臨時儲存當前節點
Node<K,V> e;
// 節點不為null, 進行處理
if ((e = oldTab[j]) != null) {
// 先將桶的該位置置為null
oldTab[j] = null;
// 如果該節點的next屬性為null, 說明這個節點處既沒有連結串列也沒有紅黑樹.
// 直接用其hash值與新陣列的長度進行一次與運算, 得到新的下標, 將該元素填充到這裡
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;
// 構造計算之後等於0的一條連結串列
if ((e.hash & oldCap) == 0) {
if (loTail == null)
loHead = e;
else
loTail.next = e;
loTail = e;
}
// 構造計算之後不等於0的一條連結串列
else {
if (hiTail == null)
hiHead = e;
else
hiTail.next = e;
hiTail = e;
}
} while ((e = next) != null);
// 等於0的這條連結串列放在原先的位置不變
if (loTail != null) {
loTail.next = null;
newTab[j] = loHead;
}
// 不等於0的這條連結串列放在 j+oldCap 的位置上
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
return newTab;
}
7. 總結
- HashMap是無序的, 有序的Map可以參考LinkedHashMap.
- HashMap是執行緒不安全的, 安全的Map可以參考ConcurrentHashMap.
- HashMap的儲存結構是陣列 + 連結串列/紅黑樹.
- 不要隨便更改HashMap的負載因子: loadFactor.
- 遍歷HashMap時, 儘可能使用foreach語法或者使用entry().iterator().
- HashMap擴容是2倍擴容, 並且伴隨著rehash操作.
不要因為知識簡單就忽略, 不積跬步無以至千里.