菜鳥看原始碼之HashMap
先扯點別的:聽說拳皇97界的大魔王老K退役了,不知道以後還能不能見到那麼犀利的大門。最近感覺自己的拳皇水平有點提升,應該能排到100多線的水平吧。
今天記錄一下看HashMap原始碼的過程,感覺HashMap的原始碼要比ArrayList難一點。所以只看主要流程,不可能每一行程式碼都搞懂什麼意思。
先看一下HashMap的繼承結構圖
HashMap:它根據鍵的hashCode值儲存資料,大多數情況下可以直接定位到它的值,因而具有很快的訪問速度,但遍歷順序卻是不確定的。 HashMap最多隻允許一條記錄的鍵為null,允許多條記錄的值為null。HashMap非執行緒安全,即任一時刻可以有多個執行緒同時寫HashMap,可能會導致資料的不一致。如果需要滿足執行緒安全,可以用 Collections的synchronizedMap方法使HashMap具有執行緒安全的能力,或者使用ConcurrentHashMap。
HashMap 的儲存結構:陣列+連結串列+紅黑樹(JDK1.8增加了紅黑樹部分)實現的,如下如所示。
HashMap的部分成員變數
//序列化id private static final long serialVersionUID = 362498820763181265L; //預設初始容量16 static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; //最大容量 static final int MAXIMUM_CAPACITY = 1 << 30; //預設的負載因子 static final float DEFAULT_LOAD_FACTOR = 0.75f; //樹化連結串列節點的閾值 static final int TREEIFY_THRESHOLD = 8; //儲存資料的Node陣列,長度必須是2的冪。 transient Node<K,V>[] table; //entrySet transient Set<Map.Entry<K,V>> entrySet; //table中Node的數量 transient int size; //hashmap 物件被結構化修改的次數 transient int modCount; //負載因子 final float loadFactor; // 所能容納的key-value對極限 ,容量乘以負載因子所得結果,如果key-value的 數量等於該值,則呼叫resize方法,擴大容量,同時修改threshold的值。 int threshold; static final int UNTREEIFY_THRESHOLD = 6;
Node 節點的資料結構:是一個單鏈表
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 K getKey() { return key; } public final V getValue() { return value; } public final String toString() { return key + "=" + value; } public final int hashCode() { return Objects.hashCode(key) ^ Objects.hashCode(value); } public final V setValue(V newValue) { V oldValue = value; value = newValue; return oldValue; } 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; } }
使用HashMap的時候通常會使用無參建構函式來例項化一個HashMap。
/**
*使用預設的初始容量(16)構造一個空的HashMap,預設的負載因子是(0.75)
*/
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR; // 其他的成員變數使用預設值
}
例項化HashMap的時候也可以指定初始容量(initialCapacity)和負載因子(loadFactor)*
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
只指定初始容量的建構函式會在內部呼叫兩個引數的建構函式,如下所示。
/**
* Constructs an empty <tt>HashMap</tt> with the specified initial
* capacity and load factor.
*使用指定的初始化容量和負載因子構造一個空的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;
//呼叫tableSizeFor方法為threshold 賦值
this.threshold = tableSizeFor(initialCapacity);
}
tableSizeFor(int cap)方法會返回一個大於或者等於cap的一個值,並且這個值必須是2的冪,比如32,64,等等。
通過上面的建構函式看出,內部就是為了給loadFactor和threshold賦值的,這個時候儲存資料的Node<K,V>[] table
還是空的。
HashMap確定雜湊桶陣列索引位置的方法
這裡的Hash演算法就是三步:取key的hashCode值、高位運算、位與運算。
//取key的hashCode值、高位運算
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
//位與運算,n為table的長度
(n - 1) & hash
然後就是HashMap的put(K key, V value)方法
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
把一個鍵值對key-newValue 放入到map中,如果這個map中已經包含一個鍵值對key-oldValue那麼oldValue會被newValue替換,返回oldValue。如果不存在舊的鍵值對,就直接把key-newValue 放入到map中,返回null。內部通過putVal實現。
/**
*
* @param hash 鍵的hash值
* @param key 鍵
* @param value 要放入的value值
* @param onlyIfAbsent 如果為true,不改變已存在的value。
* @param evict 如果為false,table處在建立模式
* @return 鍵對應的舊的值,如果沒有,返回null。
*/
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
Node<K,V>[] tab;
Node<K,V> p;
int n;
int i;
//第一步:判斷如果table為null或者table的長度為空就先初始化table
if ((tab = table) == null || (n = tab.length) == 0)
//初始化table
n = (tab = resize()).length;
if ((p = tab[i = (n - 1) & hash]) == null)
//如果i=((n - 1) & hash)位置上沒有元素,即p為null,就直接把元素放入tab[i]的位置上
tab[i] = newNode(hash, key, value, null);
else {
//如果p不為null
Node<K,V> e; K k;
//如果p的key的雜湊值hash值同時p的key值和key值相等,這時候put方法就會更新p元素的value。
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
e = p;
else if (p instanceof TreeNode)
//如果p是一個TreeNode,就把要put的元素加入到樹中
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
else {
//如果p不是一個TreeNode,說明tab[i]位置上的元素是存放在連結串列裡面的,
//就把要put的元素加入到連結串列尾部,或者更新連結串列中某個位置上的元素的value
for (int binCount = 0; ; ++binCount) {
if ((e = p.next) == null) {
//把要put的元素加入到連結串列尾部
p.next = newNode(hash, key, value, null);
//tab[i]位置上的連結串列中的元素個數超過TREEIFY_THRESHOLD
//就通過treeifyBin方法把tab[i]位置上的連結串列變成一顆紅黑樹,或者增加tab的容量
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
treeifyBin(tab, hash);
break;
}
//或者更新連結串列中某個位置上的元素的value
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
//這裡是真正更新value的地方。
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
//新值替換舊值
e.value = value;
afterNodeAccess(e);
//返回舊的值
return oldValue;
}
}
//如果是新加入了一個元素,而不是更新了某個舊值,就把修改次數加1
++modCount;
//table的size加1如果超出了容量,就把table的長度變為原來的兩倍
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
整理一下putVal方法的邏輯。
- 首先判斷table是不是為空,或者table的長度是不是為0。如果滿足其中一個條件就呼叫resize()方法來初始化table。
- 計算出雜湊桶陣列索引位置(i = (n - 1) & hash])。如果i位置上沒有元素即p為null,就直接把待放入元素放入 i 位置上。
- 如果 i 位置上的元素p不為null,就判斷hash是否等於p的雜湊值,key值和p的key值是否相等,如果相等,那說明這個放入操作只要用value值替換p元素的value值即可,返回被替換的value值。
- 如果條件3不滿足,就判斷p元素是否是一個TreeNode,如果是的話,說明當前 i 位置上是一個紅黑樹,那就從樹中查詢,如果在樹中找到有一個元素 q , 如果q的key的hash值等於hash,同時 q 的key值等於key,那就用value更新 q 的value。否則就把待放入元素放入樹中。
- 如果條件 4 不滿足,說明說明當前 i 位置上是一個連結串列,就遍歷這個連結串列,如果在連結串列中發現有一個元素 q 的key的雜湊值等於hash,同時 q 的鍵值等於key,就更新 q 的value。否則就把待放入的元素插入到連結串列尾部。插入完成後,檢測當前連結串列的長度是否超過了TREEIFY_THRESHOLD,如果超過了,就把連結串列轉化成一個紅黑樹。
上面提到的resize()方法做了兩件事
- 若果table為null,或者table的lenth為0,就初始化table。初始化容量大小為16,threshold為12.。
- 如果table不為null,就把table的長度增加兩倍,原來table中的元素要麼待在原來的位置上,要麼會移動到原來的位置index加上2的幾次冪的位置上。
final Node<K,V>[] resize() {
Node<K,V>[] oldTab = table;
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;
}
// 沒超過最大值,就擴充為原來的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);
}
// 計算新的resize上限
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) {
// 把每個bucket都移動到新的buckets中
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 { // 保持連結串列的順序不變
Node<K,V> loHead = null, loTail = null;
Node<K,V> hiHead = null, hiTail = null;
Node<K,V> next;
do {
next = e.next;
//這時候oldCap是原來table的length,不是(length-1)了
if ((e.hash & oldCap) == 0) {
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;
}
上面提到的treeifyBin方法
如果table的size太小就呼叫resize方法增加table的容量,否則就把連結串列變成一顆紅黑樹。至於怎麼變的先不管。
final void treeifyBin(Node<K,V>[] tab, int hash) {
int n, index; Node<K,V> e;
if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
resize();
else if ((e = tab[index = (n - 1) & hash]) != null) {
TreeNode<K,V> hd = null, tl = null;
do {
TreeNode<K,V> p = replacementTreeNode(e, null);
if (tl == null)
hd = p;
else {
p.prev = tl;
tl.next = p;
}
tl = p;
} while ((e = e.next) != null);
if ((tab[index] = hd) != null)
hd.treeify(tab);
}
}
HashMap的putAll方法,把一個集合裡面的所有鍵值對,都放入當前的HashMap中,內部通過putMapEntries實現。
public void putAll(Map<? extends K, ? extends V> m) {
putMapEntries(m, true);
}
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
int s = m.size();
if (s > 0) {
if (table == null) { // pre-size
float ft = ((float)s / loadFactor) + 1.0F;
int t = ((ft < (float)MAXIMUM_CAPACITY) ?
(int)ft : MAXIMUM_CAPACITY);
if (t > threshold)
threshold = tableSizeFor(t);
}
else if (s > threshold)
resize();
for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
K key = e.getKey();
V value = e.getValue();
putVal(hash(key), key, value, false, evict);
}
}
}
首先判斷,如果當前hashMap的table為null,就先初始化threshold。如果table不為null,如果要加入的map的size大於當前hashMap的table的最大容量threshold,就呼叫resize()方法增加table的長度。最後迴圈遍歷通過putVal方法把map中的每個鍵值對都放入當前hashMap的table中。
HashMap get方法,返回key對應的value,如果不存在對應的value,返回null;內部通過getNode實現。
public V get(Object key) {
Node<K,V> e;
//返回節點的value值或者null;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
/**
*
* @param hash 鍵的雜湊值
* @param key 鍵
* @return 返回找到的節點或者null。
*/
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;
}
首先根據hash值找出對應儲存位置上的節點first ,如果first就是要找的節點就返回first。否則如果對應儲存節點上是紅黑樹,就從紅黑樹裡面找,是連結串列,就從連結串列中查詢,找到就返回相應的Node,找不到返回null;
HashMapde 的containsKey方法,內部通過getNode方法實現,如果table中存在key-value對,返回true,否則返回false。
public boolean containsKey(Object key) {
return getNode(hash(key), key) != null;
}
HashMap的containsValue方法,內部遍歷整個table,查詢是否有元素的value值和要查詢的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) {
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;
}
HashMap的remove方法,內部通過removeNode實現,如果成功刪除了鍵值對,返回被刪除的value,否則返回null;
public V remove(Object key) {
Node<K,V> e;
return (e = removeNode(hash(key), key, null, false, true)) == null ?
null : e.value;
}
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對應的位置上的元素p就是要刪除的節點
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
node = p;
else if ((e = p.next) != null) {
//如果hash值對應的位置上儲存的是一個紅黑樹,就從樹裡查詢
if (p instanceof TreeNode)
node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
else {
//如果hash值對應的位置上儲存的是連結串列,就遍歷連結串列查詢。
do {
if (e.hash == hash &&
((k = e.key) == key ||
(key != null && key.equals(k)))) {
node = e;
break;
}
p = e;
} while ((e = e.next) != null);
}
}
//如果node存在就刪除
if (node != null && (!matchValue || (v = node.value) == value ||
(value != null && value.equals(v)))) {
if (node instanceof TreeNode)
//node是一個紅黑樹中的節點,刪除樹中的節點
((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
else if (node == p)
//如果node就是p節點,意思就是tab[index]位置上就是要刪除的node,那麼就把node的nexet節點賦值給tab[index]。
tab[index] = node.next;
else
//要刪除的節點node是連結串列中的某個節點,就讓node的上一個節點p指向node的next,即可完成刪除
p.next = node.next;
//修改次數加1
++modCount;
//table中的鍵值對的數量減1
--size;
afterNodeRemoval(node);
//返回刪除的node
return node;
}
}
return null;
}
HashMap的兩個replace方法,就是根據key值找到相應的節點,更新節點的value,更新成功返回true。如果找不到key對應的節點,返回false。
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;
}
@Override
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;
}
HashMap的clear方法,把table的每一項都置為null。增加修改次數,size置為0。
public void clear() {
Node<K,V>[] tab;
//修改次數加1
modCount++;
if ((tab = table) != null && size > 0) {
size = 0;
for (int i = 0; i < tab.length; ++i)
tab[i] = null;
}
}
小結:
(1) 擴容是一個特別耗效能的操作,所以當程式設計師在使用HashMap的時候,估算map的大小,初始化的時候給一個大致的數值,避免map進行頻繁的擴容。
(2) 負載因子是可以修改的,也可以大於1,但是建議不要輕易修改,除非情況非常特殊。
(3) HashMap是執行緒不安全的,不要在併發的環境中同時操作HashMap,建議使用ConcurrentHashMap。
(4) JDK1.8引入紅黑樹大程度優化了HashMap的效能。