HashMap源码分析
源码分析可以说是真正的了解 HashMap 的必须技能,任凭你再怎么吹你说你多么熟悉 HashMap 如果你没看过源码,那你就是在耍流氓。所以,本文就带你来见识一下大师们的结晶,里面的很多思想真的让我们叹为观止。
核心且非常重要的方法当属put、resize、get、remove 方法,下面就正式开始。
PS:在开始之前,我有两句话想要提前说下:
① 本文真的很难理解,里面的很多东西可能你看了好几遍也不一定能看的明白,但是一遍不懂就再来一遍,不懂就再来一遍,知道你懂为止(HashMap我说我看了十几遍都毫不夸张)
② 很多源码级别的东西真的很难用语言来描述,但是我尽量使用大白话,以一种交流的形式来说明和介绍。所以当你遇到暂时看不明白的地方,那么先跳过去,继续往下看。
1.put 方法
public V put(K key, V value) {return putVal(hash(key), key, value, false, true);}
原来又是套娃,核心其实是 putValue方法。
里面还有一个 hash 方法,代码如下
static final int hash(Object key) {int h;return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);}
从上面的代码可以知道 HashMap 的 key 是可以为 null 的,且是在下标为 0 的位置。另外里面还调用了 hashCode方法,
public native int hashCode();
但是这是一个本地方法,所以各位就不要在操心了。知道是获取 hashCode 值的就可以了,但是为什么还有和 h 经过的无符号右移 16 位的的结果做异或运算呢?
异或:相同返回 0 ,不同返回 1
这里的目的是为了让 key 的 hash 值的高 16 位也参与运算。也就是让高 16 位和低 16 位都参与运算,降低hash冲突概率。换句话说:
HashCode 是 int值,32个 bit,如果直接用原始的 HashCode 计算的话:(n - 1) & hash,正常 HashCode 的 size 不会太大,高 16 位参与不到计算位置的运算里,所以计算hash 的时候进行了高 16 位和低 16 位的异或运算,根本目的是为了散列更均匀。
这里顺便提一个疑问:为什么 (n - 1) & hash,能够获取下标?
因为之前说了,数组的长度一定是 2 的次幂,假设长度是 16 即 10000,也就是说不管怎么说,最高位都是1其余的都是0,然后n-1 就是最高位是 0 其余都是 1即01111,那么这个时候是不是 n-1 的范围就是 0-15,因为数组的下标是从0开始的,所以不管hash是什么值,最后的结果一定是在数组的长度范围之内。
putVal 方法
/*** Implements Map.put and related methods.** @param hash key 的 hash 值* @param key key 值* @param value value 值* @param onlyIfAbsent true:如果某个 key 已经存在那么就不插了;false 存在则替换,没有则新增。这里为 false* @param evict 不用管了,我也不认识* @return previous value, or null if none*/final V putVal(int hash, K key, V value, boolean onlyIfAbsent,boolean evict) {// tab 表示当前 hash 散列表的引用Node<K, V>[] tab;// 表示具体的散列表中的元素Node<K, V> p;// n:表示散列表数组的长度// i:表示路由寻址的结果int n, i;// 将 table 赋值发给 tab ;如果 tab == null,说明 table 还没有被初始化。则此时是需要去创建 table 的// 为什么这个时候才去创建散列表?因为可能创建了 HashMap 时候可能并没有存放数据,如果在初始化 HashMap 的时候就创建散列表,势必会造成空间的浪费// 这里也就是延迟初始化的逻辑if ((tab = table) == null || (n = tab.length) == 0) {//resize()下面会单独详细讲解n = (tab = resize()).length;}// 如果 p == null,说明寻址到的桶的位置没有元素。那么就将 key-value 封装到 Node 中,并放到寻址到的下标为 i 的位置if ((p = tab[i = (n - 1) & hash]) == null) {tab[i] = newNode(hash, key, value, null);}// 到这里说明 该位置已经有数据了,且此时可能是链表结构,也可能是树结构else {// e 表示找到了一个与当前要插入的key value 一致的元素Node<K, V> e;// 临时的 keyK k;// p 的值就是上一步 if 中的结果即:此时的 (p = tab[i = (n - 1) & hash]) 不等于 null// p 是原来的已经在 i 位置的元素,且新插入的 key 是等于 p中的key//说明找到了和当前需要插入的元素相同的元素(其实就是需要替换而已)if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k))))//将 p 的值赋值给 ee = p;//说明已经树化,红黑树会有单独的文章介绍,本文不再赘述,不然文章要非常非常的长else if (p instanceof TreeNode) {e = ((TreeNode<K, V>) p).putTreeVal(this, tab, hash, key, value);} else {//到这里说明不是树结构,也不相等,那说明不是同一个元素,那就是链表了for (int binCount = 0; ; ++binCount) {//如果 p.next == null 说明 p 是最后一个元素,说明,该元素在链表中也没有重复的,那么就需要添加到链表的尾部if ((e = p.next) == null) {//直接将 key-value 封装到 Node 中并且添加到 p的后面p.next = newNode(hash, key, value, null);// 当元素已经是 7了,再来一个就是 8 个了,那么就需要进行树化if (binCount >= TREEIFY_THRESHOLD - 1) {treeifyBin(tab, hash);}break;}//在链表中找到了某个和当前元素一样的元素,即需要做替换操作了。if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k)))) {break;}//将e(即p.next)赋值为e,这就是为了继续遍历链表的下一个元素(没啥好说的)下面有张图帮助大家理解。p = e;}}//如果条件成立,说明找到了需要替换的数据,if (e != null) {//这里不就是使用新的值赋值为旧的值嘛V oldValue = e.value;if (!onlyIfAbsent || oldValue == null) {e.value = value;}//这个方法没用,里面啥也没有afterNodeAccess(e);//HashMap put 方法的返回值是原来位置的元素值return oldValue;}}// 上面说过,对于散列表的 结构修改次数,那么就修改 modCount 的次数++modCount;//size 即散列表中的元素的个数,添加后需要自增,如果自增后的值大于扩容的阈值,那么就触发扩容操作if (++size > threshold) {resize();}//啥也没干afterNodeInsertion(evict);//原来位置没有值,那么就返回 null 呗return null;}

最后为了让大家更好的理解 put 的过程,我费劲心思花了一张大致的流程图,希望能对大家有帮助。

2.resize 方法
为什么需要扩容?
假设现在散列表中的元素已经很多了,但是现在散列表的链化已经比较严重了,哪怕是树化了,之间复杂度也没有O(1)好,所以需要扩容来降低Hash冲突的概率,以此来提高性能
下面来看resize的代码,最核心的针对扩容后链表的处理会再单独拿出来分析
final Node<K, V>[] resize() {// oldTab 表示引用扩容前的 散列表Node<K, V>[] oldTab = table;// oldCap 扩容前的 table 数组的长度,后面就是一个简单的三目运算符:oldTab 为 null,长度则为 0 ,否则就取 table 实际的长度int oldCap = (oldTab == null) ? 0 : oldTab.length;//表示扩容之前的扩容阈值,也即触发本次 扩容的阈值int oldThr = threshold;// newCap:扩容之后的 table 的数组的长度// newThr:扩容之后下次触发扩容的阈值int newCap, newThr = 0;//条件成立:说明散列表已经初始化过了,就是一次正常的容量不够了的扩容(因为在 table 没有初始化也会进行 resize 的)if (oldCap > 0) {//基本的容量大小判断,基本是不可能达到这个数值的,但是为了保持程序的健壮性,还是需要做该检查的。if (oldCap >= MAXIMUM_CAPACITY) {threshold = Integer.MAX_VALUE;//直接返回原来的容量,已经已经达到最大值,无法再继续扩容了。return oldTab;}//走到这里,首先将 newCap 扩大为原来的 2 倍,且需要判断是否超过了最大值//并且要保证扩容之后的容量是大于扩容之前的阈值(16) oldCap >= DEFAULT_INITIAL_CAPACITY 这个条件会不成立吗?假设你创建HashMap 的时候传的初始容量为3 那么就不走这部进行扩容了//两个条件都满足以后,那么就将扩容的阈值翻倍else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY && oldCap >= DEFAULT_INITIAL_CAPACITY)//将原来的扩容阈值扩大一倍后赋值给新的扩容阈值newThr = oldThr << 1;}// 到这一步说明 oldCap == 0,说明此时散列表中没有任何的元素。但是为什么扩容阈值会可能有大于 0 的情况。//需要回头看下构造方法,除了无参构造,别的方法里面最终执行 tableSizeFor()方法。这就导致了 threshold 可能是 > 0 的else if (oldThr > 0) {newCap = oldThr;} else {// 到这一步说明 oldTab = 0,oldThr = 0;此时直接非 容量赋值初始值newCap = DEFAULT_INITIAL_CAPACITY;//通过 容量 * 负载因子 得到 扩容阈值newThr = (int) (DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);}//这个是什么情况? 第一种是上面的 else if (oldThr > 0) { newCap = oldThr; }的情况下,还有一种是上面的第一个 if 中的else if 条件没有满足。这个时候 newThr == 0 是成立的if (newThr == 0) {// 这里面就是在计算新的扩容阈值。float ft = (float) newCap * loadFactor;//这里真没什么好说的,就是简单的三目运算newThr = (newCap < MAXIMUM_CAPACITY && ft < (float) MAXIMUM_CAPACITY ? (int) ft : Integer.MAX_VALUE);}//将新的扩容阈值赋值给 thresholdthreshold = newThr;@SuppressWarnings({"rawtypes", "unchecked"})//创建一个容量更大的数组Node<K, V>[] newTab = (Node<K, V>[]) new Node[newCap];//将新数组赋值给 tabletable = newTab;//条件成立,说明 原来的散列表中有元素呗if (oldTab != null) {//扩容没有捷径,就是每个桶位置去处理for (int j = 0; j < oldCap; ++j) {//e:表示当前 node 节点Node<K, V> e;//将 j位置的元素赋值给 e,且如果 j 位置元素不为null。否则继续下一轮循环if ((e = oldTab[j]) != null) {//将 j 位置置为 null,方便 GColdTab[j] = null;//如果 e.next 为空,说明该位置没有发生过 hash 碰撞。if (e.next == null) {//计算新的桶的小标,并将e设置进去newTab[e.hash & (newCap - 1)] = e;} else if (e instanceof TreeNode) {//判断是否已经树化,本文不讨论,过~((TreeNode<K, V>) e).split(this, newTab, j, oldCap);} else {//★★★★★最重要的的地方★★★★★ 处理链表 再拿出来单独介绍......}}}}return newTab;}
上面的大的结构上已经做了详细的解释和说明,这里就不再赘述了,所以请各位务必详细阅读上面对的每一行文字(如果你读起来都觉得费劲,那你想想我写的时候是多么的…….)
final Node<K, V>[] resize() {......if (oldTab != null) {......else {//★★★★★最重要的的地方★★★★★ 处理链表// 低位链表:存放扩容之后的数组的下标位置,与当前数组的下标位置是一致的(下面会结合图来解释)Node<K, V> loHead = null, loTail = null;// 高位链表:存放扩容之后的数组的下标位置,当前数组的下标位置 + 扩容之前的数组的长度(下面会结合图来解释)//卡不明白不要急,下面会针对这里详细讲解Node<K, V> hiHead = null, hiTail = null;//下一个节点Node<K, V> next;do {//开始遍历元素next = e.next;//oldCap 一定是1000...这样形式的(2的次幂,最高位一定是 1 )//e.hash有两种情况,低位不用管,怎么都是0,高位可能是1也可能是0,如果是1那么结果就是1,那该条件就不成立了,如果是0那么结果必然是0if ((e.hash & oldCap) == 0) {//如果改位置为空,直接将e放进去if (loTail == null) {loHead = e;} else {//否则就添加到链表的后面loTail.next = e;}loTail = e;} else {//到这一步说明高位1为1,添加也是如果原来位置没有元素那么就直接添加,if (hiTail == null) {hiHead = e;} else {//原来位置有值就将新元素添加到链表的尾部hiTail.next = e;}hiTail = e;}} while ((e = next) != null);//下面的两个if不明白的请看下图中的注释//低位链表有数据if (loTail != null) {//将原来的低位链表的next置空,方便GC,loTail.next = null;//将低位链表直接添加到新的散列表的和原来的一样的下标位置newTab[j] = loHead;}//高位链表有数据if (hiTail != null) {//将原来的高位链表的next置空,方便GChiTail.next = null;//将高位链表的放在 新的散列表的 老表的长度+老表的位置 的下标位置newTab[j + oldCap] = hiHead;}}}}}return newTab;}
假设原来的结构和元素是这样子存在的

这个是扩容之前的样子,此时下标为 3的位置对应的链表就是低位链表。

这个时候的下标为 7 的位置就是到位链表,这个是扩容后的 table。
在下标为15的位置存在5个元素,而原来的数组的长度是 16 的二进制为10000;上面的注释中有一句话是这么说的:e.hash 有两种情况,低位不用管,怎么都是0,高位可能是 1 也可能是 0,如果是 1 那么结果就是 1,那该条件就不成立了,如果是 0 那么结果必然是 0。
在 jdk7 中 是需要重新计算hash位, 但是 jdk8 做了优化, 通过(e.hash & oldCap) == 0来判断是否需要移位; 如果为真则在原位不动, 否则则需要移动到当前hash槽位 + oldCap的位置;这边可能也是最难理解的。我来举个例子来帮助大家理解。
首先此时原来的某个桶位已经链化了,这样子就可以推断出该桶位的所有的 Node 的 key 的二进制的低位都是相同的(这句话我相信很多朋友一定还是没理解,接着听我说,确实没那么简单)。
假设我们桶的下标为15是链表,而计算元素的下标就是根据 key 经过扰动(扰动就是 h = key.hash ^ h >>> 16)hash 值与上桶的长度减一,即 h & (table.length -1 ),而现在桶的长度是 16 减一 就是15 ,转成二进制就是 1111(这就是低四位),高位全部补0即可,即 0 1111 ,因为最终得到的下标全是相同的,所以不管怎么算,在这种情况下Node中的key的hash计算出来的低位一定是相同的,不然结果肯定不可能为一样的,但是Node中的key的hash高位不一定是相同的,那为什么与上01111还能得到相同结果?因为此时Node的高位不同(可能是0 也可能是1),但是table-1的二进制数的高位是0,所以此时是不受Node高位的hash值影响的,所以在扩容以后,原来的如果高位是0的,那么在迁移到新的表中结果依旧是在同样的位置,如果是高位是 1 ,那么迁移后的元素在桶中的位置就是 原来的桶长度 + 原来的元素的位置。
原来的如果高位是0的,那么在迁移到新的表中结果依旧是在同样的位置,如果是高位是 1 ,那么迁移后的元素在桶中的位置就是 原来的桶长度 + 原来的元素的位置
可能很多朋友还是不明白,这里我再拿出来继续讲解下,假设原来散列表的长度是16,length - 1转成二进制是 0 1111,现在假设有一个 A 和 B 两个 Node 的 key 的 hash 值分别为:0 1111,1 1111 A 和 0 1110 取余 结果是:0 1111 & 0 1111 = 0 1111,下标是15, 同样 B 1 1111 & 0 1111 = 0 1111,这个时候是在原来的桶中的,现在散列表扩容后长度变成了 32 ,32 - 1 = 31 = 1 1111,此时再来计算 A 和 B 的在新的散列表中的位置,A :0 1111 & 1 1111 = 0 1111 = 15,也就是说 A 在迁移到新的桶中的下标位置还是 15 ,再来看下 B :1 1111 & 1 1111 = 1 1111 = 31,即 B 在新的散列表中的位置为 原来的散列表的长度(16)+ 原来的下标的位置(15) = 新的下标的位置(31),这就是迁移后元素存放的特点。
PS:上面的扩容的最后非常的绕。但是这里真正掌握的人却少的可怜,不要整天就会两个为什么是2的次幂和什么put方法就以为自己真的会HashMap了,上面的扩容后元素的存规律还请各位务必好好理解。(要做到别人会的我会,别人不会的我还会)
3.get 方法
public V get(Object key) {Node<K, V> e;return (e = getNode(hash(key), key)) == null ? null : e.value;}
get 方法看起来很简单,就是通过同样的 hash 得到 key 的hash 值。重点看下 getNode方法
final Node<K, V> getNode(int hash, Object key) {//当前HashMap的散列表的引用Node<K, V>[] tab;//first:桶头元素//e:用于存放临时元素Node<K, V> first, e;//n:table 数组的长度int n;//元素中的 kK k;// 将 table 赋值为 tab,不等于null 说明有数据,(n = tab.length) > 0 同理说明 table 中有数据//同时将 改位置的元素 赋值为 firstif ((tab = table) != null && (n = tab.length) > 0 && (first = tab[(n - 1) & hash]) != null) {//定位到了桶的到的位置的元素就是想要获取的 key 对应的,直接返回该元素if (first.hash == hash && ((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);}}//遍历不到返回nullreturn null;}
总体看下来 get 方法还是确实比较简单的。
4.remove 方法
public V remove(Object key) {Node<K, V> e;return (e = removeNode(hash(key), key, null, false, true)) == null ?null : e.value;}
重点还是来看下 removeNode 方法
/*** Implements Map.remove and related methods.** @param hash hash 值* @param key key 值* @param value value 值* @param matchValue 是否需要值匹配 false 表示不需要* @param movable 不用管* @return the node, or null if none*/final Node<K, V> removeNode(int hash, Object key, Object value, boolean matchValue, boolean movable) {//当前HashMap 中的散列表的引用Node<K, V>[] tab;//p:表示当前的Node元素Node<K, V> p;// n:table 的长度// index:桶的下标位置int n, index;//(tab = table) != null && (n = tab.length) > 0 条件成立,说明table不为空(table 为空就没必要执行了)// p = tab[index = (n - 1) & hash]) != null 将定位到的捅位的元素赋值给 p ,并判断定位到的元素不为空if ((tab = table) != null && (n = tab.length) > 0 && (p = tab[index = (n - 1) & hash]) != null) {//进到 if 里面来了,说明已经定位到元素了//node:保存查找到的结果//e:表示当前元素的下一个元素Node<K, V> node = null, e;K k;V v;// 该条件如果成立,说明当前的元素就是要找的结果(这是最简单的情况,这个是很好理解的)if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k)))) {node = p;}//到这一步,如果 (e = p.next) != null 说明该捅位找到的元素可能是链表或者是树,需要继续判断else if ((e = p.next) != null) {//树,不考虑if (p instanceof TreeNode) {node = ((TreeNode<K, V>) p).getTreeNode(hash, key);}//处理链表的情况else {do {//如果条件成立,说明已经匹配到了元素,直接将查找到的元素赋值给 node,并跳出循环(总体还是很好理解的)if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k)))) {node = e;break;}//将正在遍历的当前的临时元素 e 赋值给 pp = e;} while ((e = e.next) != null);}}// node != null 说明匹配到了元素//matchValue为false ,所以!matchValue = true,后面的条件直接不用看了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 的值++modCount;//table 中的元素个数减 1--size;//啥也没做,不用管afterNodeRemoval(node);//返回被移除的节点元素return node;}}//没有匹配到返回null 即可return null;}
我想对你说的话都在注释里面了,亲一定要好好看哦。
另外 remove 还有一个方法是key 和 value 都需要匹配上才移除
public boolean remove(Object key, Object value) {return removeNode(hash(key), key, value, true, true) != null;}
这个关键点就是这句话
// (!matchValue || (v = node.value) == value || (value != null && value.equals(v)))//matchValue = true,所以 !matchValue = false,所以此时必须保证后面的值是true 才执行真正的 remove 操作if (node != null && (!matchValue || (v = node.value) == value || (value != null && value.equals(v)))) {}
6、本文小结
本文是对 HashMap 的集合核心的和重要的方法进行了详细的讲解,说实话,没那么好理解,这个也不是看一遍两遍能理解的,我再学习的时候隔一段时间就回头看,隔一段时间就回头重看,因为各位朋友能脚踏实地,争取将其拿下。
