Java1.8 HashMap源码解析
构造函数
首先介绍一下基本思想。
HashMap的基本属性为哈希数组Node<K,V>[] table
,键值对数目int size
,扩容阈值int threshold
,计算阈值的负载因子final float loadFactor
(似乎比较少使用到),并没有一个属性表示哈希数组的长度,可在代码中使用table.length
得到。
当我们new出一个HashMap时,并不会创建一个默认容量(16)的哈希数组,而是在第一次使用put函数时才会触发一次resize函数,创建出一个默认容量或者用户指定容量的哈希数组。
/**
* 仅仅设置属性值
*/
public HashMap(int initialCapacity, float loadFactor) {
if (initialCapacity < 0) // 容量不能为负
throw new IllegalArgumentException("Illegal initial capacity: " +
initialCapacity);
if (initialCapacity > MAXIMUM_CAPACITY) // 不能大于所允许的最大容量,2的30次方即1G
initialCapacity = MAXIMUM_CAPACITY;
if (loadFactor <= 0 || Float.isNaN(loadFactor)) // 负载因子不能小于0且必须是个合格的浮点数
throw new IllegalArgumentException("Illegal load factor: " +
loadFactor);
this.loadFactor = loadFactor;
// tableSizeFor计算大于initialCapacity的最小2的整数次幂,作为哈希数组的容量,
// 暂存于threshold属性中,后面介绍resize函数会讲到这样做的原因。
this.threshold = tableSizeFor(initialCapacity);
}
/**
* 仅仅调用上一个构造函数
*/
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
/**
* 仅仅设置负载因子,哈希数组的容量没有设置,在后面resize的时候如果发现哈希数组是空,就将容量定为16
*/
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}
/**
* 从已有的Map中浅拷贝
*/
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
putMapEntries(m, false);
}
tableSizeFor(initialCapacity)
函数计算比initialCapacity大的最小2的整数次幂,源码如下:
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;
}
首先我们不看cap-1这一步,假设对cap做后面五个操作。关注cap的二进制中处在最高位的1,右移一位就把这位1往右移动一位,再或上自己,就相当于把最高位的1复制给下一位,于是就能得到11,再往右移动两位,再或上自己,就能得到1111,由此类推,五次这样的操作之后就能把cap的二进制从最高位的1开始,后面全部变成1,注意到return语句中有一个n+1操作,加一之后就能得到2的整数次幂,并且是大于原cap的最小2的整数次幂,因为在结果中,只有比原cap的最高位1再高一位的bit是1,而其他bit都是0。
现在可以解释为什么一开始要减1了。如果输入参数cap本身就是2的整数次幂,那么五个操作之后cap就会*2了,比如从4变成8,从8变成16,然而我们期望输入4得到4而不是8,因此需要把4减1变成3,然后通过五个操作就能得到4。
再分析最后的return语句return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
。注意到在构造函数中已经把小于0的cap拒绝掉了:
if (initialCapacity < 0) // 容量不能为负
throw new IllegalArgumentException("Illegal initial capacity: " +
initialCapacity);
因此tableSizeFor函数的参数cap一定是大于等于0的整数,如果cap>0,那么对于32位有符号整数来说,cap-1之后得到的n,最高位符号位是0,假设第二高位是1,那么五个操作之后就会得到最大的有符号整数2^31-1
,已经大于等于MAXIMUM_CAPACITY了(2^30
),于是就只能得到MAXIMUM_CAPACITY。如果cap==0,那么n=cap-1就会得到负数,经过后面五个操作之后还是负数(因为最高符号位始终是1),所以判断(n<0),小于0就返回1。
为什么MAXIMUM_CAPACITY是2^30
?因为在32位有符号整数中,最大的2的整数次幂就是2^30
。
放置键值对
当我们使用put函数时,会调用putVal函数
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
先看hash函数。hash函数的功能是根据key计算出哈希值,可以看到如果key是null,那么就固定在下标0处,否则,先得到key的hashCode,赋给h,然后h再跟h>>>16进行异或操作。h>>>16相当于把h的高16位转移到低16位,高位全部变成0,h^(h>>>16)
就是让h的高16位跟低16位做异或,结果就是h的高16位不变,而低16位变成异或结果。为什么要这样做呢?先看putVal函数。
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
接下来主要看putVal函数
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
Node<K,V>[] tab; Node<K,V> p; int n, i;
// 如果哈希表为空,那么说明这是第一次使用这个HashMap或者该HashMap中的元素全部被取出来了
// 这时我们需要调用resize函数,而在resize函数里面可以看到,当哈希表是这两种情况之一的时候,会创建默认容量(16)的哈希表
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);
// 注意,此时变量p已经代表了该哈希下标对应的地方
else {
Node<K,V> e; K k;
// 注意,下面三个分支都会操作变量e,变量e是否为Null意味着是直接新增还是键相同替换值。
// 判断当前哈希下标的第一个节点的key跟新来的是不是相同的,是的话就将p赋值给变量e。
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
e = p;
else if (p instanceof TreeNode) // 如果当前哈希下标对应的是一个红黑树,那么调用putTreeVal函数
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
else { // 是链表的话,就要不断探索到链表的尾部,当到达最后一个节点时创建一个新节点,作为新的尾节点
for (int binCount = 0; ; ++binCount) {
if ((e = p.next) == null) { // 不断将循环变量p的下一个节点赋给e,==null表示已经到达最后一个节点
p.next = newNode(hash, key, value, null); // 最后一个节点p指向新建的节点
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st。因为第一个节点已经先判断过了,所以这里的统计变量binCount少了1,因此阈值要减1
treeifyBin(tab, hash); // 将链表变成红黑树
break;
}
// 如果遍历链表过程中发现键相同的节点,(注意此时e已经是p.next了),那么可以直接跳出
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
// e不为空的话表示存在键相同的节点,看上面的控制流,只有(e=p.next)==null为真时,e才为Null,而这种情况对应的就是新增节点,而不是覆盖节点
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value; // 更新值
afterNodeAccess(e);
return oldValue; // 返回旧值
}
}
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null; // 不存在覆盖情况的话就返回null
}
哈希的计算我们都知道,就是对容量取余。假设待计算的值为hash,容量为n,那么哈希下标i=hash%n。当n是2的整数次幂的时候,取余操作等价于i=(n-1)&hash,对应于putVal函数中的这一行if ((p = tab[i = (n - 1) & hash]) == null)
。这也是为什么强制HashMap的容量是2的整数次幂的其中一个原因。由(n-1)&hash我们可知,当n较小的时候,只有hash的低位会跟n-1相与,那么如果多个hash,他们的低位相同但是高位不同,那么他们就会全都映射到同一个下标导致冲突,所以前面讲的hash()函数才需要把高位下移,为的就是参与这里的与运算,减少冲突。
在putVal函数里我们发现,当++size>threshold时,也就是添加节点之后,节点总数超过了阈值,就会调用resize()函数扩容。接下来分析resize()函数。
扩容
前面我们知道,调用构造函数时不会创建数组,当第一次调用put函数时才会分配空间,因此resize函数中先判断这种情况。具体地,当第一次调用put函数时,table为Null,于是oldCap为0,if (oldCap > 0)
判断失败,进入后面的控制流。如果在构造HashMap时有指定容量,由构造函数可知该指定容量保存在threshold属性中,因此就可以通过else if (oldThr > 0)
来判断是否指定了容量,如果没有指定容量就会进入else分支,按照默认情况设置。得到旧容量,新容量,新阈值之后,就可以开始扩容了。详见注释。对于不包括红黑树的情况,扩容是非常简单的,就是把每一条链表都分成两段,前面一段仍然挂在原下标处,后面一段挂在(原下标+旧容量)处。
final Node<K,V>[] resize() {
Node<K,V>[] oldTab = table;
// 前面这一部分判断各种情况,比如是否初次调用put函数,用户是否指定了容量。
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;
}
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);
}
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"})
// 开始扩容
// 创建新的哈希数组,大小为newCap
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;
if (oldTab != null) { // ==null则表示是第一次调用put函数,那么就不用扩容,否则开始扩容
for (int j = 0; j < oldCap; ++j) { // 循环旧哈希数组中的每一项
Node<K,V> e;
if ((e = oldTab[j]) != null) { // 如果旧数组的当前项不为空,也就是有键值对存在
oldTab[j] = null; // 把旧数组当前项置为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。如果是链表,那么就切割链表
// lo开头的变量表示是要挂在旧下标处的,hi开头的变量表示是要挂在新下标处的
Node<K,V> loHead = null, loTail = null; // loHead和loTail合起来表示一个链表
Node<K,V> hiHead = null, hiTail = null; // hiHead和hiTail合起来表示一个链表
// 整个循环的逻辑就是,用lo*串起一个链表,用hi*串起一个链表
Node<K,V> next;
do {
next = e.next;
// 这里判断当前节点应该串在lo上还是hi上。
// 如果e.hash & oldCap为0的话,那么这个节点在新哈希数组中的下标跟在旧哈希数组中是一样的,所以属于lo
if ((e.hash & oldCap) == 0) {
if (loTail == null)
loHead = e;
else
loTail.next = e;
loTail = e;
}
// 如果e.hash & oldCap大于0的话,那么这个节点在新哈希数组中的下标跟在旧哈希数组中是不·一样的,所以属于hi
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; // 看,lo依然挂在j上
}
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead; // 看,hi应该挂在j+oldCap上
}
}
}
}
}
return newTab;
}
可能会有疑问,为什么判断(e.hash & oldCap) == 0
就能知道e的新位置呢?我们假设oldCap为8,newCap为16,我们知道下标计算是通过e.hash&(cap-1)
得到的,当容量从8变成16时,cap-1
这个二进制串就会增加一个高位1,这个高位1就是8的那个bit,也就是说e.hash&(cap-1)
的结果只会根据hash在8那个bit的地方是1还是0进行变化,0的话下标就不变,1的话下标就要加上8,因此当cap是8的时候,5和13都会得到下标5,但是扩容成16之后5还在下标5处,13跑到下标13处(13=5+8)。这是为什么哈希数组的容量要设计成2的整数次幂的另一个原因。