1、前言
上一篇文章了解了hashmap的整体结构,其实现了map接口,具有键值对存储和遍历功能。且该功能由六个主要的内部类模块实现,以及Node等关键内部类的组成。下面来看一下HashMap具体使用的源码情况。
2、源码分析——put方法查看
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
//hash值计算,即key的hashcode与其无符号右移16位后的异或值,原理我讲不明白,所以这里不详细描述,仅先展示记录一下。
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 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;
//1、获取底层数组对象,如果数组为空或者长度为0,则初始化该数组,并赋值数组长度给n
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
//2、获取当前键值对要存储的链表或红黑树引用。如果引用为空,说明数组中当前位置还没放入过数据,所以以当前键值对新建节点数据并存储到数组中。
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
//3、如果当前键对应的链表或红黑树引用不为空,进入如下判断
else {
Node<K,V> e; K k;
//3.1、如果待放入元素hash与链表首节点相同且key相同,则将链表节点赋值给e,用于后续判断当前的操作是插入还是更新。
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
e = p;
//3.2、能到这一步,说明待放入元素不是已有元素,此时判断其是链表节点还是红黑树节点
else if (p instanceof TreeNode)
//3.2.1 进入红黑树节点插入流程
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
else {
//3.2.2、进入链表节点插入流程,循环遍历链表每一个节点,直到尾部插入或者遇到hash与key都相同的节点
for (int binCount = 0; ; ++binCount) {
//3.2.2.1、下个节点赋值给e,并判断是否为尾结点
if ((e = p.next) == null) {
//3.2.2.1.1、创建新节点放入链表尾部
p.next = newNode(hash, key, value, null);
//3.2.2.1.2、判断当前链表长度是否大于红黑树阈值,大于则进入红黑树转换流程
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
treeifyBin(tab, hash);
break;
}
//3.2.2.2、如果当前节点hash和key与待插入键值对相同,则跳出循环
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
//3.2.2.3、将e赋值给下个节点引用p,从而可以达到从头到尾遍历当前链表的效果
p = e;
}
}
//3.3、如果e不为空,说明当前hashmap中已经存在了该键值对
if (e != null) {
//3.3.1、获取已经存在节点的value值
V oldValue = e.value;
//3.3.2、如果设置了任何时候都更新value或者旧value为空,则更新已有节点的value值为当前值
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e); //(回调函数,默认为空,用户可自定义实现)
//3.3.3、插入一个已存在的元素,返回旧的value值
return oldValue;
}
}
//4、对hashmap中元素做出了增加操作,所以修改计数加1,便于fast-filed的判定
++modCount;
//5、如果键值对容量大于阈值,则扩容
if (++size > threshold)
resize();
afterNodeInsertion(evict); // 节点插入的后续处理(回调函数,默认为空,用户可自定义实现)
//6、新元素插入成功,直接返回null
return null;
}
final Node<K,V>[] resize() {
//1、获取旧数组、旧容量、旧阈值
Node<K,V>[] oldTab = table;
int oldCap = (oldTab == null) ? 0 : oldTab.length;
int oldThr = threshold;
int newCap, newThr = 0;
//2、如果旧容量大于0进入如下判断
if (oldCap > 0) {
//2.1、如果旧容量大于等于最大容量,阈值设置为整形最大值,这个时候直接返回旧数组
if (oldCap >= MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return oldTab;
}
//2.2、如果旧容量不大于最大容量,则新容量、阈值为旧容量、阈值的两倍
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
oldCap >= DEFAULT_INITIAL_CAPACITY)
newThr = oldThr << 1; // double threshold
}
//3、能到这一步,说明容量为0,此时阈值不为0,说明是出于hashmap刚以容量参数构建完毕,此时容量为0,但是阈值是最近的2的次幂数(创建HashMap时由构造器调用tableSizeFor方法生成),所以新容量可以直接用旧的阈值
else if (oldThr > 0) // initial capacity was placed in threshold
newCap = oldThr;
//4、到这一步说明容量和阈值都还没设置,此时直接设置默认容量16和阈值12
else { // zero initial threshold signifies using defaults
newCap = DEFAULT_INITIAL_CAPACITY;
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
//5、(通过一开始的逻辑判断,能到这一步说明有可能容量太大)判断容量和阈值是否超最大值,不超则阈值等于容量乘以阈值因子,超了则为整形最大值
if (newThr == 0) {
float ft = (float)newCap * loadFactor;
newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
(int)ft : Integer.MAX_VALUE);
}
threshold = newThr;
//6、创建新的数组
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;
if (oldTab != null) {
//7、遍历旧数组,将链表或者红黑树转到新表中
for (int j = 0; j < oldCap; ++j) {
Node<K,V> e;
//7.1、获取链表或者红黑树头节点,如果不为空则进入后续判断
if ((e = oldTab[j]) != null) {
//7.2、从旧数组中拿到引用后,将数组该位置设置为空,便于垃圾回收
oldTab[j] = null;
//7.3、如果当前链表只有一个元素,则直接取模(hash & 长度减一 结果与取模相同)后放入新数组中
if (e.next == null)
newTab[e.hash & (newCap - 1)] = e;
//7.4、如果当前节点是树类型,则进入树中元素向新数组转移流程,如果转移拆分后树中元素少于阈值,树结构会再转换成链表结构
else if (e instanceof TreeNode)
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
//7.5、能到这一步,说明当前节点为链表引用,且链表上不止一个节点
else {
//7.5.1、扩容后,旧元素在新数组中有两个可能的位置,一个是原有位置不变,一个是旧数组容量+旧数组偏移量。所以这里设置了两大类引用,一个是低位的头尾引用,一个是高位的头尾引用。
Node<K,V> loHead = null, loTail = null;
Node<K,V> hiHead = null, hiTail = null;
Node<K,V> next;
//7.5.2、遍历处理当前链表,直至处理完
do {
//7.5.2.1、将next赋值为下一个节点引用,便于下一个节点处理
next = e.next;
//7.5.2.2、计算节点元素在新数组中位置,如果与操作为0,放入新数组低位链表引用中(这里与正常放入时使用的hash&(n-1)不同,要留意下,本处取模是为了判断该节点是放高位引用还是低位引用中)
if ((e.hash & oldCap) == 0) {
if (loTail == null)
loHead = e;
else
loTail.next = e;
loTail = e;
}
//7.5.2.3、如果与操作不为0,放入新数组中高位链表引用中
else {
if (hiTail == null)
hiHead = e;
else
hiTail.next = e;
hiTail = e;
}
} while ((e = next) != null);
//7.5.3、将低位链表引用放到新数组中该链表原有偏移量的位置
if (loTail != null) {
loTail.next = null;
newTab[j] = loHead;
}
//7.5.3、将高位链表引用放到新数组中该链表原有偏移量+oldCap的位置
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
return newTab;
}
final void treeifyBin(Node<K,V>[] tab, int hash) {
int n, index; Node<K,V> e;
//1、如果数组为空,或者数组长度小于64,还是进入扩容阶段
if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
resize();
//2、能到这一步,说明已经满足链表转红黑树的条件。下面进入转换流程
else if ((e = tab[index = (n - 1) & hash]) != null) {
TreeNode<K,V> hd = null, tl = null;
//3、遍历处理节点中每个节点,将链表节点转换成树节点
do {
//3.1、链表节点转换成树节点
TreeNode<K,V> p = replacementTreeNode(e, null);
//3.2、根节点为空则直接赋值,不为空则将当前节点放到树引用中
if (tl == null)
hd = p;
else {
p.prev = tl;
tl.next = p;
}
tl = p;
} while ((e = e.next) != null);
//4、将树引用放到数组中,如果不为空,进入红黑树转换流程(转换细节了解较少,所以就不多做介绍)
if ((tab[index] = hd) != null)
hd.treeify(tab);
}
}
至此,put的源码已经查看完毕,总之流程还是比较简单的,大致如下(具体的流程尽量阅读源码查看):
首先查看数组是否初始化,没初始化先初始化,随后计算节点hash,如果数组中对应位置为空,则直接插入链接节点。如果不为空且节点为树节点类型,则进入树节点插入流程。否则进入链表节点插入流程,这里有留意链表节点插入后如果达到红黑树转换阈值,要将链表转换成红黑树。
这个过程中有一些细节比较难理解,比如重新计算元素位置用hash & cap,以及红黑树转换等。下面是我对一下关键点的记录,希望可以帮助更好的理解源码:
1)数据存储定位哪个链表或红黑树时通过 (n - 1) & hash 方式确定,即长度减一和key对应的hash值与操作,之所以用这个是hashmap每次是以2的倍数扩容,所以与操作相当于取模操作。因为与操作是位移运算,效率高,所以通过这种方式计算。不过它的前提是hashmap以2的倍数扩容。
2)插入一个hashmap中已经存在了键值对时,会返回旧的键值对value值,插入一个未存在的键值对时返回Null
3)扩容时,数组元素要么还在原位置,要么是放在旧容量+原先的偏移量的位置
4)如果指定了hashmap容量,初始创建时会根据传入的容量参数,计算最近的2的次幂数,然后把这个数当作初始阈值。另外hashmap创建时不会初始化数组,只有在第一次放入数据时才调用resize方法初始化数组,此时的容量就是刚才计算的初始阈值。
5)正常计算元素位置时用的是 hash & (cap - 1) ,扩容时计算元素在新数组中位置时用的是 hash & cap,后者可以实现旧元素要么放在新数组中原位置或oldCap + 原位置偏移量的划分。
3、源码分析——get方法查看
public V get(Object key) {
Node<K,V> e;
//1、根据hash获取节点,获取到则返回对应的value值,获取不到则返回空
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;
//1、如果数组不为空,且找到的链表或红黑树首届点不为空则进入如下流程
if ((tab = table) != null && (n = tab.length) > 0 &&
(first = tab[(n - 1) & hash]) != null) {
//2、如果首节点hash与目标hash相同且key相同,则直接返回首节点
if (first.hash == hash && // always check first node
((k = first.key) == key || (key != null && key.equals(k))))
return first;
//3、能到这一步,说明链表或红黑树首节点不是目标节点,此时如果后续节点不为空则进入下面的判断流程,否则返回空
if ((e = first.next) != null) {
//3.1、如果首节点类型为树类型,则进入树中查找流程(不深入分析,有兴趣的可以再看)
if (first instanceof TreeNode)
return ((TreeNode<K,V>)first).getTreeNode(hash, key);
//3.2、遍历链表中节点,直到找到hash和key都与查询目标匹配的节点
do {
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
return e;
} while ((e = e.next) != null);
}
}
//4、能到这一步,说明没有找到匹配键值对,直接返回空
return null;
}
可以看到get方法很简单,首先是计算key对应的hash找到对应的链表或红黑树首节点,如果首节点是目标键值对就直接返回,否则根据节点类型进入红黑树或者链表的遍历查找流程。如果查到键值对节点就返回value值,查不到则返回空。
4、源码分析——remove方法查看
public V remove(Object key) {
Node<K,V> e;
//1、成功移除键值对对象则返回移除键值对的value,如果移除失败返回空
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;
//1、如果数组不为空,且要移除key对应的hash可以定位到数组中的非空首节点,则进入后续流程
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;
//2、如果首节点hash和key与要移除key相同,则将首节点赋值给node。
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
node = p;
//3、能到这一步说明首节点存在但不是目标节点,此时如果首节点还有后续节点,则进入后续流程
else if ((e = p.next) != null) {
//3.1、如果首节点是树类型节点,则进入树节点查找流程(没有具体分析,感兴趣的可以深入看一下)
if (p instanceof TreeNode)
node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
//3.2、如果首节点是链表节点,则遍历链表节点直到找到匹配节点或者遍历到尾部为止
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);
}
}
//4、如果找到待移除节点,先判断是否设置了值匹配过滤,如果符合移除标准,进入后续移除流程
if (node != null && (!matchValue || (v = node.value) == value ||
(value != null && value.equals(v)))) {
//4.1、如果找到的节点是树节点,则进入树节点移除流程
if (node instanceof TreeNode)
((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
//4.2、能到这一步说明找到的是链表节点,如果找到的节点是首节点,则直接替换数组中的首节点即可
else if (node == p)
tab[index] = node.next;
//4.3、如果不是链表中的首节点,此时p在3.2步骤中已经变成了目标节点的前一个节点,所以此处可以通过如下方式移除链表中目标节点
else
p.next = node.next;
//4.4、自增修改次数,便于后续fast-failed监测
++modCount;
//4.5、hashmap容量减一
--size;
//4.6、(移除操作后的回调函数,默认为空,用户可以自定义实现)
afterNodeRemoval(node);
return node;
}
}
return null;
}
可以看到,移除操作也比较简单,就是先找到节点,然后移除。
至此hashmap的常用源码已经讲解结束,可以看到最复杂的部分在插入流程,后续的查找和移除都比较简单。所以想较快了解hashmap原理,可以先看put的实现方式。另外源码中对于树相关源码讲解比较少,有兴趣的可以深入看一下。