一、序言
本文探讨 HashMap put() 方法的源码。
二、put() 方法核心逻辑流程概览
当使用 put() 方法插入数据时：
- 首先，计算该数据应该放入的索引位置
- 如果计算出的索引位置没有发生 hash 冲突，那么数据可以直接插入
- 若发生了 hash 冲突，那么就执行红黑树或链表的 put 逻辑
- 红黑树 put 逻辑比较特殊，将会在后面的文章中详解（敬请期待）
- 执行链表逻辑时，首先会判断链表：是否已存在要插入数据的 key
- 若已存在 key，直接更新 value（这也是 HashMap 数据不重复的原因）
- 若不存在 key，新建一个包含该数据的节点插入链表尾部（尾插法）
- 链表插入成功。之后，判断链表是否满足转换成红黑树的条件
- 若条件满足，则将链表转换成红黑树
- 若条件不满足，不做任何处理
- put 逻辑在结束之后，会检查 HashMap 是否需要扩容
- 若需要，则执行扩容逻辑（保证了下次有多余空间进行 put 操作）
- 若不需要，则不做任何处理
- 至此，put 的流程结束
三、未发生 hash 冲突逻辑流程
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
在 HashMap 中，下标索引是通过 hash 值得到的，而 hash 值是通过上面的 hash 方法获取。该 hash 方法获取 hash 值的逻辑是：key 的 hashCode 值抑或上 key 的 hashCode 无符号右移 16 位的值。
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 {
// 省去 hash 冲突的代码
}
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
上述代码是 HashMap 的 put() 方法的底层源码，仅省略了 hash 冲突的代码。
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
/*
1. Node<K,V>[] tab 表示 HashMap 的数据存储结构
2. Node<K,V> p 表示当前插入的节点，即要存储的键值对。
3. int n 表示数组的长度，即 table 的大小。
4. int i 表示计算出的存储位置的索引，通过 (n - 1) & hash 计算得到。
*/
Node<K,V>[] tab; Node<K,V> p; int n, i;
// 判断 HashMap 表是否初始化
if ((tab = table) == null || (n = tab.length) == 0)
// 没有初始化，执行 resize() 扩容
n = (tab = resize()).length;
// 判断是否发生 hash 冲突
if ((p = tab[i = (n - 1) & hash]) == null)
// 并未发生 hash 冲突，直接插入
tab[i] = newNode(hash, key, value, null);
// 表示发生了 hash 冲突
else {
// 省去 hash 冲突的代码
}
// modeCount + 1 (modCount 是一个成员变量)
++modCount;
// 判断是否需要执行扩容
if (++size > threshold)
// 需要扩容，执行 resize() 方法扩容
resize();
// 在 HashMap 中这是一个空方法（空方法没有内容，可当作没有这行代码）
// 若想了解 afterNodeInsertion() 方法的作用可借助搜索引擎
afterNodeInsertion(evict);
// 返回 null
return null;
}
上述源码的逻辑流程如下：
四、发生 hash 冲突逻辑流程
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);
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
treeifyBin(tab, hash);
break;
}
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;
}
上述代码，是发生 hash 冲突之后的处理逻辑，也就是在之前 else 中省略的代码。上面的代码用来讨论不够清晰，我们将使用下面的逻辑流程图来讨论。
- 发生 hash 冲突之后，首先会判断 key 是否存在（即还未进入链表或红黑树之前，检查数组位置是否已存在此 key）
- 若存在，更新 value，结束 hash 冲突处理流程
- 若不存在，判断是否为 TreeNode（即表示是否为红黑树）
- 若是红黑树，则执行红黑树的 put 逻辑（此处暂时省略，敬请期待后续）
- 若不是红黑树，则是链表，循环遍历链表
- 遍历过程中，判断当前遍历的节点是不是最后一个节点
- 若不是，则检查当前遍历节点的 key 是不是与需要 put 的 key 相同
- 若 key 相同，更新 value，跳出循环，结束 hash 冲突处理流程
- 若 key 不同，开启下一次循环
- 若已到达最后一个节点，直接在最后一个节点后插入（尾插法），接下来判断链表长度是否大于阈值 8
- 若小于阈值，直接结束 hash 冲突处理流程
- 若大于阈值，链表转化成红黑树，结束 hash 冲突处理流程
- 至此，hash 冲突处理流程结束
五、put() 方法整体逻辑流程
