构造方法
/**
* 可以看出构造方法并没有对容量做初始化操作,而是设置了以下值
* initialCapacity 初始化容量大小
* loadFactor 加载因子
*/
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR;
}
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
putMapEntries(m, false);
}
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;
this.threshold = tableSizeFor(initialCapacity);
}
初始化容量大小算法 tableSizeFor
/**
* 参数cap 代表构造方法时传入的大小
*/
static final int tableSizeFor(int cap) {
/**比如传进来的是16,那么如果不减1,则返回32
* 防止传入的参数已经是2的N次幂
*/
int n = cap - 1;
/* 比如现在cap就是20,此方法最后应该返回32,一起验证
* 计算规则如下
* 0000 0000 0000 0000 0000 0000 0001 0100 n = 20
* 0000 0000 0000 0000 0000 0000 0000 1010 n>>>1
* 0000 0000 0000 0000 0000 0000 0001 1110 n|= n>>>1
* 0000 0000 0000 0000 0000 0000 0000 0111 n>>>2
* 0000 0000 0000 0000 0000 0000 0001 1111 n|= n>>>2
* 0000 0000 0000 0000 0000 0000 0000 0001 n>>>4
* 0000 0000 0000 0000 0000 0000 0001 1111 n|= n>>>4
* 0000 0000 0000 0000 0000 0000 0000 0000 n>>>8
* 0000 0000 0000 0000 0000 0000 0001 1111 n|= n>>>8
* 0000 0000 0000 0000 0000 0000 0000 0000 n>>>16
* 0000 0000 0000 0000 0000 0000 0001 1111 n|= n>>>16
* n < 0 0
* n >= 0 n>= 最大容量上限 最大容量上线 1 << 30
* n < 最大容量上限 n+1 = 16+8+4+2+1+1 = 32
* 最后的值会赋值给阈值threshold,而后面在put的时候
* 由于初始化的原因,threshold会赋值给initialCapacity数组容量
* 结论: 如果输入非2的N次方幂的数时,最后初始化容量不是你输入的那个值
* 会往后面找最接近的2的N次方幂的值
*/
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;
}
put
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
/* 1、tab来作为数组表的副本
* 2、Node节点p作为key计算出的index所对应的数组元素
* 3、n 表示为 数组长度
* 4、i 作为 (n-1)& hash 的接收值,代表下标值
*/
Node<K,V>[] tab; Node<K,V> p; int n, i;
/* 如果table没有被初始化*/
if ((tab = table) == null || (n = tab.length) == 0)
/* 1、开始扩容,扩容方法后面再讲,扩容会使容量扩大两倍
* 2、n 为扩容后数组的长度
*/
n = (tab = resize()).length;
/* (长度-1,因为下标从0开始,槽位为0到length-1)& hash 计算出
的值为空,意味着此位置没有被任何元素占用 */
if ((p = tab[i = (n - 1) & hash]) == null)
/* 新增节点,并且赋值给数组的此下标位置 */
tab[i] = newNode(hash, key, value, null);
/* 如果此位置的元素有值 */
else {
/* 1、节点e来记录是否有重复元素添加
* 2、k记录此下标数组元素存储的key值 */
Node<K,V> e; K k;
/* 1、如果新增节点的hash值和此下标节点存储的hash值一样
* 证明它们会存储到同一个槽位
* 2、如果key值一样,证明是相同元素 */
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
/* 变量 e 记录此重复key节点,后面会用到 */
e = p;
/* 如果此节点是树节点 */
else if (p instanceof TreeNode)
/* 添加到树中,此方法后面讲 */
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
/* 如果此节点不是树节点,并且数组的此位置已经有元素存在 */
else {
/*计数器,从0开始记录,可以认为从头节点开始 */
for (int binCount = 0; ; ++binCount) {
/* 如果此节点的后面没有值(开始形成链表)*/
if ((e = p.next) == null) {
/* 生成新节点,赋值给数组元素(头节点)的next */
p.next = newNode(hash, key, value, null);
/* 如果binCount的值大于等于
* (TREEIFY_THRESHOLD=8)- 1 = 7
* 又因为binCount从0开始计数,达到7时此链表的
* 数量已经达到8,但是又因为上面又执行了newNode
* 操作,此时链表的节点数量已经达到了9
* (包含头节点),当节点数量大于8时,会进行
* 树化调整(treeifyBin)*/
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
/* 树化操作后面讲,此函数会将链表调整为
* 红黑树,并且还有会一些其他条件才会触发
* 转换为红黑树操作 */
treeifyBin(tab, hash);
break;
}
/* 如果遇到相同hash 以及 key 值的节点
* 直接跳出循环,变量e 会记录此节点
*/
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
/* 不相同,继续向后遍历,指针后移 */
p = e;
}
}
/* 处理变量 e 记录的节点 */
if (e != null) { // existing mapping for key
/* 记录旧值 */
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
/* 替换新值 */
e.value = value;
afterNodeAccess(e);
/* 返回旧值 */
return oldValue;
}
}
++modCount;
/* 数量大于阈值(容量 默认 16 * 加载因子 默认0.75 = 12)时
* 开始扩容
*/
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
扩容
/**
* 扩容
*
*/
final Node<K,V>[] resize() {
/* 拷贝一份原数组,用 oldTab 记录 */
Node<K,V>[] oldTab = table;
/* 获取原数组长度,第一次初始化扩容时为0 */
int oldCap = (oldTab == null) ? 0 : oldTab.length;
/* 记录原阈值 */
int oldThr = threshold;
/* 初始化 新容量、新阈值 = 0 */
int newCap, newThr = 0;
/* 数组已经初始化,容量大于0*/
if (oldCap > 0) {
/* 如果扩容前的容量大小已经超过了最大容量大小*/
if (oldCap >= MAXIMUM_CAPACITY) {
/* 因为扩容的条件是size > threshold
* 把阈值设置为最大值,则再也无法满足扩容条件
*/
threshold = Integer.MAX_VALUE;
return oldTab;
}
/* 将数组容量扩大2倍后,如果仍然小于最大容量时 */
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
oldCap >= DEFAULT_INITIAL_CAPACITY)
newThr = oldThr << 1; // double threshold
}
/* 调用了有参构造方法,会对加载因子以及阈值进行赋值
* 但是容量没有赋值
*/
else if (oldThr > 0)
/* 赋值新数组容量 */
newCap = oldThr;
/* 调用无参的构造方法时,因为没有对threshold赋值所以为0
* 只赋值了loadFactor = 0.75 (默认)
* 采用默认的扩容参数
* DEFAULT_INITIAL_CAPACITY = 16
* newThr = 16 * 0.75 = 12
*/
else {
newCap = DEFAULT_INITIAL_CAPACITY;
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
/* 针对 else if (oldThr > 0) 这种情况
* 设置新的阈值 */
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"})
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;
if (oldTab != null) {
/* 遍历原数组所有元素 */
for (int j = 0; j < oldCap; ++j) {
/* 定于变量节点e,来接收原数组的每个元素的值*/
Node<K,V> e;
/* 如果原数组这个位置上的元素不为null */
if ((e = oldTab[j]) != null) {
/*处理前的准备工作,讲原数组此位置值置空 */
oldTab[j] = null;
/* 如果此元素的next为null,证明此位置还未形成链表
* 只有一个元素
*/
if (e.next == null)
/* 和之前计算下标的方法一样
* 节点的hash值 & (新数组长度-1)并赋值
*/
newTab[e.hash & (newCap - 1)] = e;
/* 如果节点为树节点,则切割整棵树到新位置
* split 后面讲
*/
else if (e instanceof TreeNode)
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
else {
/* loHead 标记低位的头节点(新下标在原数组下标范围内)
* loTail 标记低位的尾结点
* hiHead 标记高位的头节点(新下标在新扩出来的下标内)
* hiTail 标记高位的尾结点
* 比如原数组长度是16,下标为0-15
* 扩容后的长度是32,下标为0-31
* 如果新计算出的下标仍然是0-15范围内
* 则用loHead和loTail标记
* 如果新计算出的下标是16-31范围内
* 则用hiHead和hiTail标记
*/
Node<K,V> loHead = null, loTail = null;
Node<K,V> hiHead = null, hiTail = null;
/* 记录下一个节点 */
Node<K,V> next;
/* 开始循环,直到下一个节点为null */
do {
/* 获取头节点元素的next元素
*/
next = e.next;
/*计算头节点的hash值 & 原数组的长度
* 比如:原数组长度 = 16,hash值随意填
* 0000 0000 0000 0000 1110 0110 1011 1010 e.hash
* 0000 0000 0000 0000 0000 0000 0000 1111 oldCap-1 = 15
* &
* 0000 0000 0000 0000 0000 0000 0000 1010 = 10
* 按照目前情况来看,真正影响最后的值的是原数组二进制的后四位
* 也就是0-15
* 接下来我们继续来看,新数组长度为32,&操作的过程
* 0000 0000 0000 0000 1110 0110 1011 1010 e.hash
* 0000 0000 0000 0000 0000 0000 0001 1111 newCap-1 = 31
* &
* 0000 0000 0000 0000 0000 0000 0001 1010 = 10+16
* 可以看出新数组的二进制就是原数组的二进制增加了个高位
* 而影响最后值的也就是这个高位所对应的hash值那一位是否也为1
* 如果高位对应的hash值那一位为1,则下标一定会进入高位
* 反之,则仍然在原数组的老位置上不变
* 如果只判断高位,让0-15向前进一位,如下
* 0000 0000 0000 0000 1110 0110 1011 1010 e.hash
* 0000 0000 0000 0000 0000 0000 0001 0000 oldCap = 16
* &
* 最后的结果只需要判断是否为0即可
* 如果为0,证明高位对应的hash值那一个高位不为1,导致&结果为0
* 反之,则说明落到高位上,即原数组下标多加了个oldCap
* 就是新下标位置
*/
/* 下标不变 */
if ((e.hash & oldCap) == 0) {
/* 初始化 */
if (loTail == null)
loHead = e;
else
/* 拼接链表 */
loTail.next = e;
loTail = e;
}
/* 下标发生变化 */
else {
/* 初始化 */
if (hiTail == null)
hiHead = e;
else
/* 拼接链表 */
hiTail.next = e;
hiTail = e;
}
} while ((e = next) != null);
/* loTail 不为null,证明仍然是原数组下标
* 将loHead移动到新数组的原下标上
*/
if (loTail != null) {
loTail.next = null;
newTab[j] = loHead;
}
/* hiTail 不为null,下标发生改变
* 将hiHead移动到新数组的原下标+oldCap位置
*/
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
return newTab;
}
树的切割
/** 切割树
* map
* tab 新数组
* index 头节点下标
* bit 原数组长度
* this 头节点
*/
final void split(HashMap<K,V> map, Node<K,V>[] tab, int index, int bit) {
TreeNode<K,V> b = this;
/* 同resize方法相关注释
* loHead 低位头,loTail 低位尾
* hiHead 高位头,hiTail 高位尾
TreeNode<K,V> loHead = null, loTail = null;
TreeNode<K,V> hiHead = null, hiTail = null;
int lc = 0, hc = 0;
/* 从头节点开始向链表遍历 */
for (TreeNode<K,V> e = b, next; e != null; e = next) {
next = (TreeNode<K,V>)e.next;
e.next = null;
/* 同resize扩容方法中的逻辑 */
if ((e.hash & bit) == 0) {
/* 初始化 */
if ((e.prev = loTail) == null)
loHead = e;
else
/* 拼接链表 */
loTail.next = e;
/* 移动尾结点 */
loTail = e;
/* 累计低位链表数量 */
++lc;
}
/* 同resize扩容方法中的逻辑 */
else {
/* 初始化 */
if ((e.prev = hiTail) == null)
hiHead = e;
else
/* 拼接链表 */
hiTail.next = e;
/* 移动尾结点 */
hiTail = e;
/* 累计高位链表数量 */
++hc;
}
}
/* 同resize逻辑,计算新下标落在低位 */
if (loHead != null) {
/* 如果链表数量 <= UNTREEIFY_THRESHOLD = 6 */
if (lc <= UNTREEIFY_THRESHOLD)
/* 恢复成链表,放到新数组下标不变位置*/
tab[index] = loHead.untreeify(map);
else {
/* 原数组头节点直接移动到新数组原下标位置 */
tab[index] = loHead;
if (hiHead != null) // (else is already treeified)
/* 树化 */
loHead.treeify(tab);
}
}
/* 同resize逻辑,计算新下标落在高位 */
if (hiHead != null) {
/* 如果链表数量 <= UNTREEIFY_THRESHOLD = 6 */
if (hc <= UNTREEIFY_THRESHOLD)
/*恢复成链表,放到新数组(下标+原数组长度)位置*/
tab[index + bit] = hiHead.untreeify(map);
else {
/* 头节点移动到新数组(下标+原数组长度)位置
* 树化
*/
tab[index + bit] = hiHead;
if (loHead != null)
hiHead.treeify(tab);
}
}
}
树化
/*
* 下面的逻辑简单介绍一下
* 根据二叉搜索树的特性,比根节点小的放左侧,比根节点大的放右侧
* 找到空的位置,存放新增节点
* 主要看红黑树平衡调整
*/
final void treeify(Node<K,V>[] tab) {
TreeNode<K,V> root = null;
for (TreeNode<K,V> x = this, next; x != null; x = next) {
next = (TreeNode<K,V>)x.next;
x.left = x.right = null;
if (root == null) {
x.parent = null;
x.red = false;
root = x;
}
else {
K k = x.key;
int h = x.hash;
Class<?> kc = null;
for (TreeNode<K,V> p = root;;) {
int dir, ph;
K pk = p.key;
if ((ph = p.hash) > h)
dir = -1;
else if (ph < h)
dir = 1;
else if ((kc == null &&
(kc = comparableClassFor(k)) == null) ||
(dir = compareComparables(kc, k, pk)) == 0)
dir = tieBreakOrder(k, pk);
TreeNode<K,V> xp = p;
if ((p = (dir <= 0) ? p.left : p.right) == null) {
x.parent = xp;
if (dir <= 0)
xp.left = x;
else
xp.right = x;
/* 平衡整颗红黑树 ,返回根节点*/
root = balanceInsertion(root, x);
break;
}
}
}
}
/* 根节点移动到前面 */
moveRootToFront(tab, root);
}
链化
/* new 普通节点,将每个节点的next设置好,返回头节点即可 */
final Node<K,V> untreeify(HashMap<K,V> map) {
Node<K,V> hd = null, tl = null;
for (Node<K,V> q = this; q != null; q = q.next) {
Node<K,V> p = map.replacementNode(q, null);
if (tl == null)
hd = p;
else
tl.next = p;
tl = p;
}
return hd;
}
红黑树平衡调整
static <K,V> TreeNode<K,V> balanceInsertion(TreeNode<K,V> root,
TreeNode<K,V> x) {
/* 新增节点默认为红色节点 */
x.red = true;
/*
* 下面是一个递归的过程
* 首先先说一下参数代表什么
* x 代表新插入的节点
* xp代表新增节点的父节点
* xpp代表新增节点的祖父节点
* xppl代表新增节点的祖父节点的左节点
* xppr代表新增节点的祖父节点的右节点
* 其次在调整之前会有一些判断
* 1、如果新增节点的父节点为null,说明它就是根节点
* 根节点的颜色必须是黑色,满足性质
* 2、如果父节点的颜色是黑色 或者祖父节点为null,无需调整
* 调整的步骤分为四个大类:
* 1、父节点是祖父节点的左孩子
* (1) 祖父节点的右孩子不为空,并且为红色
* (2) 祖父节点的右孩子为空 或者 节点不为红色
* (2.1)新增节点在父节点的右侧
* (2.2)新增节点在父节点的左侧
* 2、父节点是祖父节点的右孩子
* (1)祖父节点的左孩子不为空,并且为红色
* (2)祖父节点的左孩子为空 或者 节点不为红色
* (2.1)新增节点在父节点的左侧
* (2.2)新增节点在父节点的右侧
*/
for (TreeNode<K,V> xp, xpp, xppl, xppr;;) {
/* 第一个节点是根节点,是黑色,不需要调整,直接返回 */
if ((xp = x.parent) == null) {
x.red = false;
return x;
}
/* 1.父节点是黑色,新增节点是红色,不会打破黑平衡
* 2.祖父节点是空节点
* 无需调整
*/
else if (!xp.red || (xpp = xp.parent) == null)
return root;
/* 父节点是祖父节点的左孩子 */
if (xp == (xppl = xpp.left)) {
/* 下面调整的过程参考于上图的过程 参考图一
* 祖父节点的右孩子也存在,并且为红色
* 根据2-3树的思想 xpp,xppl,xppr 形成了4节点
* 居于中间位置的节点必须向上进入融合而改变为红色
* 下面两个子节点由于脱离了和根节点的融合,形成黑色
*/
if ((xppr = xpp.right) != null && xppr.red) {
xppr.red = false;
xp.red = false;
xpp.red = true;
/* 移动指针,指向祖父节点,为下一次向上递归 */
x = xpp;
}
/* 下面调整的过程参考于上图的过程 参考图二 */
else {
/* 如果新增节点在父节点左侧
* 换句话说 红色节点全部左倾
* 需要将父节点左旋
* x指向了父节点,原因是当父节点左旋成功后
* 原来的x就会变成父节点
* 原来的父节点就会变成原来x的位置
* 左旋的方式后面讲解
* 由于新的xp变成了它所管辖的树的根节点
* 会变成黑色
*/
if (x == xp.right) {
root = rotateLeft(root, x = xp);
xpp = (xp = x.parent) == null ? null : xp.parent;
}
/* 进行右旋
* 父节点形成新的根节点,变成黑色
* 祖父节点由于右旋到了子节点,变成红色
*/
if (xp != null) {
xp.red = false;
if (xpp != null) {
xpp.red = true;
root = rotateRight(root, xpp);
}
}
}
}
else {
/* 参考图四
* 祖父节点的右孩子不为空,并且是红色
* 将祖父节点的右孩子设置为黑色
* 父节点设置为黑色
* 祖父节点设置为红色
* 祖父节点要继续和上面进行融合
* 所以被改变为红色节点
* x指向祖父节点,不断递归向上
*/
if (xppl != null && xppl.red) {
xppl.red = false;
xp.red = false;
xpp.red = true;
x = xpp;
}
/* 参考图三
* 如果祖父节点的右孩子不存在,或者是黑色
*/
else {
/* 如果父节点在祖父节点的左侧
* x指向父节点
* 将父节点左旋,x成为了新的父节点,变成黑色
*/
if (x == xp.left) {
root = rotateRight(root, x = xp);
xpp = (xp = x.parent) == null ? null : xp.parent;
}
/* 如果父节点在祖父节点的右侧
* 将祖父节点左旋,xp成为了新的父节点,变成黑色
* 祖父节点变成红色,代表融合节点
*/
if (xp != null) {
xp.red = false;
if (xpp != null) {
xpp.red = true;
root = rotateLeft(root, xpp);
}
}
}
}
}
}
左旋
/**
* 左旋
* p 可以理解成旋转点
* 参考上图
*/
static <K,V> TreeNode<K,V> rotateLeft(TreeNode<K,V> root,
TreeNode<K,V> p) {
TreeNode<K,V> r, pp, rl;
/* 获取P节点的右孩子r,r 将会成为根节点 */
if (p != null && (r = p.right) != null) {
/* r节点的左孩子 将会成为p节点的右孩子
* 因为r在P右面,r的所有子节点都会比P大
* r的左孩子也会比P大,放到P的右边
*/
if ((rl = p.right = r.left) != null)
rl.parent = p;
/* 根节点r 变黑 */
if ((pp = r.parent = p.parent) == null)
(root = r).red = false;
/* 如果上面仍然有父节点存在 则不变黑
* 下面都是指针设值
*/
else if (pp.left == p)
pp.left = r;
else
pp.right = r;
r.left = p;
p.parent = r;
}
return root;
}
右旋
/**右旋
* 参考上图演示
* p 可以理解成旋转点
*/
static <K,V> TreeNode<K,V> rotateRight(TreeNode<K,V> root,
TreeNode<K,V> p) {
TreeNode<K,V> l, pp, lr;
/* 获取P节点的左孩子r,l 将会成为根节点 */
if (p != null && (l = p.left) != null) {
/* l节点的右孩子 将会成为p节点的左孩子
* 因为l在P左面,l的所有子节点都会比P小
* l的左孩子也会比P小,放到P的左边
*/
if ((lr = p.left = l.right) != null)
lr.parent = p;
/* 根节点l 变黑 */
if ((pp = l.parent = p.parent) == null)
(root = l).red = false;
/* 如果上面仍然有父节点存在 则不变黑
* 下面都是指针设值
*/
else if (pp.right == p)
pp.right = l;
else
pp.left = l;
l.right = p;
p.parent = l;
}
return root;
}
get
public V get(Object key) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
/*
* 获取key 的hash值算出下标值,如果数组元素的此下标就是要找到值,直接返回
* 如果不是,则按照链表向下进行查找,如果是树化节点,则按照树的查找方法
* 否则就按照链表的next指针一直向下查找,直到找到为止 */
final Node<K,V> getNode(int hash, Object key) {
Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
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;
}