可能是最适合新手看的HashMap源码分析

本文最后更新于:January 31, 2022 am

前言

HashMap使用键值对的存储结构。其底层使用数组实现,应用链地址散列法,并配合红黑树,实现了高效的查找逻辑。本文的HashMap源码基于jdk1.8。

源码解析

变量

下文经常提到的就是其实就是table数组中的任意一个位置

这里变量的含义不理解没关系,看完后面的方法调用就知道了

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
//table的初始容量16
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
//最大容量
static final int MAXIMUM_CAPACITY = 1 << 30;
//默认装载因子0.75 当构造器没提供装载因子时 令loadFactor=0.75f
static final float DEFAULT_LOAD_FACTOR = 0.75f;
//table的一个桶中>8个结点时 把桶中的链表转化成红黑树
static final int TREEIFY_THRESHOLD = 8;
//桶中结点<=6个时 把红黑树恢复成链表
static final int UNTREEIFY_THRESHOLD = 6;
//table长度超过64时 才进行树化 否则即使单个桶大于等于8个结点也只是调用resize()进行扩容
static final int MIN_TREEIFY_CAPACITY = 64;
//底层数组
transient Node<K,V>[] table;
//entrySet缓存
transient Set<Map.Entry<K,V>> entrySet;
//键值对的数量
transient int size;
//总调整次数
transient int modCount;
//扩容的门槛 超过这个值需要扩容 其值capacity * load_factor
int threshold;
//装载因子
final float loadFactor;

构造方法

构造方法总共有4个

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
   //1、默认构造方法 
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}
//2、自定义初始容量的构造方法 使用默认装载因子 调用了构造方法3
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
//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;
//扩容门槛设置 这个值后期被当作了table容量
this.threshold = tableSizeFor(initialCapacity);
}
//4、以一个map的键值对为基础构建hashmap
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
putMapEntries(m, false);
}

tableSizeFor(int cap) 方法

在构造方法3中,threshold是通过tableSizeFor计算的,看一下这个方法

1
2
3
4
5
6
7
8
9
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;
}

该方法的作用是找到一个最小k使得2^k>=cap,这一操作使得不论构造函数中传入的initialCapacity是多少,最终都会被tableSizeFor处理成2^k形式 ,这一操作后续会解释作用。

简单解释一下为什么tableSizeFor可以实现这种效果。假设cap=6,则n=6-1=5。n的二进制即为101,无符号右移之后变为010,则101 | 010 = 111。新的n为111,那么后续再移位之后,因为进行的是操作,所以每次得到的结果都是111。最终return了n+1,即1000对应十进制的8,也就是2^3

可以看出,每次的移位取或操作都让n的二进制高位开始的连续1的数量翻倍,因为在构造函数3中限制了initialCapacity的最大值为MAXIMUM_CAPACITY=1 << 30,所以最极端的情况下,n最终的二进制会对应30个1,最后再加1,正好是2^30

那么第一步取n的时候,为什么要令n=cap-1呢?假如一开始cap就是2^k,那么如果一开始不进行减1的操作,最终的n会等于2^(k+1),这显然不是我们想要的结果。所以先让cap减1,这时n对应的二进制就是k个1,移位取或操作对其没有影响。最后return时,n+1又变回了2^k

put(K key, V value)方法

存入键值对的方法,实际是通过putVal方法实现

1
2
3
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}

hash(Object key)方法

计算key的hash值,因为key.hashCode是一个int值,(h = key.hashCode()) ^ (h >>> 16)相当于把高16位和低16位进行异或,使分布更松散。具体原因可以参看知乎的这个高赞答案

1
2
3
4
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

putVal方法

介绍putVal前,我们先看一张图,直观的感受一下hashmap是如何存储数据的。可以看出当table中的一个桶的结点数目超过临界值时,会把原先的链表转化成红黑树。这里的转化还有个前提条件是table的长度要大于等于64,图中为了方便没有体现这点。

image-20210220220849961

方法流程
  1. 如果一开始table为空则调用扩容方法初始化table
  2. 如果待插入的桶为空则直接插入
  3. 如果这个桶已经有元素,并且第一个元素的hash值和待插入元素相同,转到后续处理,否则转到4
  4. 处理hash冲突,如果是树节点,则按照红黑树逻辑处理;如果是普通结点,则遍历链表寻找是否存在与待插入元素相同的key。如果找到了key,跳出遍历,转到5,否则转到6
  5. 根据onlyIfAbsent判断是否需要更新旧的value,return oldValue之后方法结束
  6. 在链表末尾插入新结点,并判断结点数量是否到达临界值,达到临界值则树化。转到7
  7. 结点总数加1,并判断是否需要扩容

下面看具体代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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;
//如果当前hash值对应的位置是空的 直接把这个键值对放进去
//(n - 1) & hash 相当于 hash % n, 具体原因后文介绍
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
//如果这个位置已经有元素了 使用链地址法散列
else {
Node<K,V> e; K k;
//如果table当前位置的第一个结点p的key与待插入的key相同
//保存p的值 后续直接更新value即可
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) {
//如果到了链表末尾还没找到key值相同的结点,则把新节点放在链表末尾
if ((e = p.next) == null) {
//存入末尾
p.next = newNode(hash, key, value, null);
//如果链表长度超过临界值 将链表树化
//bincount少算了第一个结点,所以需要减1
//需要注意 这时bincount并没有算newNode
//所以树化时 实际上已经有9个结点
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
treeifyBin(tab, hash);
break;
}
//在链表中找到了与待插入key相同的元素 结束循环 后续直接修改value
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
//e不等于null说明链表中有和待插入key一样的键值 所以直接用新的value更新旧值
if (e != null) { // existing mapping for key
V oldValue = e.value;
//onlyIfAbsent默认false表示当待插入key已经存在时 用新的value更新oldValue
//否则保持原先的key-value不变
if (!onlyIfAbsent || oldValue == null)
e.value = value;
//hashmap中这个方法为空 LinkedHashMap才会用到
afterNodeAccess(e);
//返回旧值
return oldValue;
}
}
//map中不存在与待插入元素相同的key时 把修改次数加1
++modCount;
//结点数加1 如果超过了threshold就扩容
if (++size > threshold)
resize();
//这个方法也是LinkedHashMap才会用到
afterNodeInsertion(evict);
return null;
}

现在解释一下上文注释中提到的问题

(n - 1) & hash的作用

首先hash是一个int范围的数,在java中即为-2147483648 至2147483647。如果直接把所有的hash都对应到table数组的索引,那table.length要超过40亿!这显然不科学。因此,我们可以把hash % n当作索引值,这样范围就小很多了。

而对于计算机来说,&运算要比%快。并且,只有table的长度是2的k次幂时(n - 1) & hash才等于hash % n。这又是为什么?首先,当n = 2^k时,n-1对应的2进制是k个1,所以(n - 1) & hash取到的是hash中的最后k位的值,因为hash的二进制中,倒数第k位之前的部分代表的值一定是n的倍数,所以必然为0,因此最后k位代表的值正是hash % n的结果。这也解释了为什么table的长度一定要是2的k次幂。

下面给出示意图,以n=8,hash=75为例

image-20210220172321726

resize() 扩容方法

用于初始化table或者将table容量翻倍

方法流程
  1. 旧容量大于0,判断容量翻倍后是否超过上限,如果不超过则翻倍。如果旧门槛翻倍后溢出,转到4
  2. 旧容量等于0,旧门槛大于0时,让新容量等于旧门槛。转到4
  3. 旧容量和旧门槛都是0,则用默认值进行初始化
  4. 用newCap * loadFactor计算出新门槛
  5. 按照新容量建立新数组
  6. 将旧数组的元素映射到新数组,并且将原来桶中的链表拆成两部分,低位的还在原来桶的位置j,高位的放到oldCap+j的位置,oldCap是旧容量
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
final Node<K,V>[] resize() {
Node<K,V>[] oldTab = table;
//旧容量
int oldCap = (oldTab == null) ? 0 : oldTab.length;
//旧门槛
int oldThr = threshold;
int newCap, newThr = 0;
//旧容量大于0 说明已经初始化过
if (oldCap > 0) {
//旧容量超过了最大容量 直接设置门槛值为最大int 以后就不会扩容了
if (oldCap >= MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return oldTab;
}
//旧容量的2倍仍在最大容量之内且旧容量大于等于16 则将容量和门槛值都翻倍
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
oldCap >= DEFAULT_INITIAL_CAPACITY)
newThr = oldThr << 1;
}
else if (oldThr > 0)
//如果调用了含参的构造方法 第一次putVal时会进入这里 这时oldCap=0
//此时让新容量等于旧门槛值 新门槛值在后面算
newCap = oldThr;
else {
//如果调用HashMap()构造方法会进入这个分支 oldCap和oldThr都是0
//用默认值进行初始化
newCap = DEFAULT_INITIAL_CAPACITY;
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
//newThr等于0可能是两种情况导致的
//其一 代码进入oldCap > 0 分支后 由于newThr = oldThr << 1;导致newThr溢出 变成0
//其二 代码进入oldThr > 0 分支 没有计算newThr
if (newThr == 0) {
//按公式计算newThr
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^k
//则二进制hash值从低到高的第k+1位为0的进入这个分支
//分支中就是链表连接操作
if ((e.hash & oldCap) == 0) {
if (loTail == null)
loHead = e;
else
loTail.next = e;
loTail = e;
}
//二进制hash值从低到高的第k+1位为1的进入这个分支
else {
if (hiTail == null)
hiHead = e;
else
hiTail.next = e;
hiTail = e;
}
} while ((e = next) != null);
//low链表在新数组中的位置其实和原数组一样
if (loTail != null) {
loTail.next = null;
newTab[j] = loHead;
}
//high链表在新数组中的位置比原数组大oldCap
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
return newTab;
}

get(Object key)方法

根据key获取value

方法流程
  1. 根据key的hash值查找table对应的位置,如果不为空则转到2,否则直接返回null
  2. 判断桶中第一个元素是不是想要的,如果是,直接返回,否则到3
  3. 如果桶中结点不止一个,则树节点使用二叉平衡树的逻辑查找,普通结点遍历链表查找
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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;
//table不为空 且hash对应的位置不为空 进入分支
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;
}

getTreeNode(int h, Object k)

getTreeNode是TreeNode类的方法,这里放上简化后的TreeNode类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {
TreeNode<K,V> parent; // red-black tree links
TreeNode<K,V> left;
TreeNode<K,V> right;
TreeNode<K,V> prev; // needed to unlink next upon deletion
boolean red;
final TreeNode<K,V> getTreeNode(int h, Object k) {
//调用getTreeNode方法的结点parent不空 则从这棵树的根节点开始查找
return ((parent != null) ? root() : this).find(h, k, 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比h大 去左子树查找
if ((ph = p.hash) > h)
p = pl;
//否则去右子树查找
else if (ph < h)
p = pr;
//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;
//根据用户传入的比较逻辑 进行比较
else if ((kc != null ||
(kc = comparableClassFor(k)) != null) &&
(dir = compareComparables(kc, k, pk)) != 0)
p = (dir < 0) ? pl : pr;
//上述条件都不满足 直接去右子树查找
else if ((q = pr.find(h, k, kc)) != null)
return q;
//去左子树查找
else
p = pl;
} while (p != null);
return null;
}
}

remove(Object key)方法

根据key删除元素

方法流程
  1. 根据key的hash值查找对应的桶
  2. 如果是空桶直接返回null
  3. 如果桶不为空,且第一个元素就是要删除的,用node保留这个结点。否则转到4
  4. 查看后续元素,如果是树结点,则调用树的逻辑,普通结点则遍历链表
  5. 如果找到了要删除的结点,则进行删除,否则返回null
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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;
//桶中第一个元素就是要删除的元素 则用node保留p
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);
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为false 则直接开始删除
//如果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);
//如果要删除的是桶的第一个元素 直接让桶头指向第二个元素
else if (node == p)
tab[index] = node.next;
//普通链表 删除结点
else
p.next = node.next;
++modCount;
//元素个数减1
--size;
//此处函数体为空 LinkedHashMap才会使用afterNodeRemoval
afterNodeRemoval(node);
return node;
}
}
return null;
}

总结

本文分析了从HashMap最常用的put、get、remove方法入手,分析了其关联方法的代码。

其中,红黑树的插入删除逻辑等文中没有具体分析。计划之后专门写一篇红黑树的文章,再将这部分补充上。

参考文章

https://juejin.cn/post/6844903817855631373#heading-17

https://segmentfault.com/a/1190000012926722


本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!