1. HashMap继承关系简介
1.1 HashMap继承关系图
1.2 HashMap的父类及接口简介
(1)Map:值可重复,键不能重复,允许键为null
(2)AbstractMap:Map的骨架实现,用来减少子类实现Map接口要做的工作
(3)Cloneable:一种标记接口,若不实现该接口,用Object.clone会报错
(4)Serializable:一种标记接口,只要需要将对象转换为字节形式,如进行网络传输或持久化时,就需要实现该接口
2. HashMap源码分析
开始源码分析前,先进行一些说明:
(1)源码注释中,会将数组元素称作桶
(2)本篇文章对JDK1.8HashMap的源码进行介绍,它底层的数据结构由数组+单向链表+红黑树组成
(3)HashMap的TreeNode既是红黑树的节点,也是双向链表的节点(其实就是二者相关的字段在TreeNode中都有)
(4)源码中数组大小为2的幂,因为源码中会用table[(table.length-1)&hash]确定桶的位置。下面举例说明:
- 若table.length为8,8-1为7,7转换为二进制是111,那么111&hash的结果可能是0~7;
- 若table.length为5,5-1为4,4转换为二进制是100,那么100&hash的结果可能是0和4,这种情况下1~3是取不到的,只要不是2的幂,总会存在数组中某些位置取不到。
HashMap中的内容较多,下面仅对HashMap增删改查相关的内部类、字段、方法进行介绍:
2.1 内部类
(1)HashMap.Node
// (单向)链表的节点用Node表示
static class Node<K,V> implements Map.Entry<K,V> {
final int hash;
final K key;
V value;
Node<K,V> next;
// 其他(略)
}
(2)HashMap.TreeNode
// 红黑树中的节点用TreeNode表示
static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {
TreeNode<K,V> parent;
TreeNode<K,V> left;
TreeNode<K,V> right;
TreeNode<K,V> prev;
boolean red;
// 红黑树相关的方法,这里不详细介绍(略)
}
2.2 核心字段
// 默认初始容量
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
// 最大容量
static final int MAXIMUM_CAPACITY = 1 << 30;
// 默认装载因子
static final float DEFAULT_LOAD_FACTOR = 0.75f;
// 链表转红黑树的一个界限值(后面会进行介绍)
static final int TREEIFY_THRESHOLD = 8;
// 红黑树转链表的一个界限值(后面会进行介绍)
static final int UNTREEIFY_THRESHOLD = 6;
// 链表转红黑树的另一个界限值(后面会进行介绍)
static final int MIN_TREEIFY_CAPACITY = 64;
// 底层的数组
transient Node<K,V>[] table;
// 元素个数
transient int size;
// 阈值,当size大于该值时会进行扩容
int threshold;
// 装载因子,用来计算threshold
final float loadFactor;
2.3 一些辅助方法
(1)tableSizeFor
// 计算大于且最接近cap的2的幂,用来初始化threshold
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;
}
(2)hash
// 计算哈希值
static final int hash(Object key) {
int h;
// 后面会通过tab[(tab.length - 1) & h]确定元素所在桶的位置
// 当tab.length很小时,通过 & 运算符会过滤掉h的高位,所以
// 这里用 h^(h>>>16)使得h的高16位也参与运算,增强散列性
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
(3)treeifyBin
final void treeifyBin(Node<K,V>[] tab, int hash) {
int n, index; Node<K,V> e;
// 该条件是链表转红黑树的第二个条件(也是最后一个)
// 即使链表长度达到9,但数组长度小于MIN_TREEIFY_CAPACITY(64)时,
// 仍然是对数组进行扩容,不将链表转为红黑树
if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
resize();
else if ((e = tab[index = (n - 1) & hash]) != null) { // 链表长度达到9且数组长度不小于64,将链表转为红黑树
TreeNode<K,V> hd = null, tl = null;
// 遍历(单向)链表
do {
// 将Node转为TreeNode(注意TreeNode是红黑树和双向链表共用的节点(其实就是两者相关的字段都存在))
TreeNode<K,V> p = replacementTreeNode(e, null);
// 逐个节点构造成双向链表
if (tl == null)
hd = p;
else {
p.prev = tl;
tl.next = p;
}
tl = p;
} while ((e = e.next) != null);
if ((tab[index] = hd) != null)
// 将双向链表构造为红黑树
hd.treeify(tab);
}
}
// 将Node转换为TreeNode
TreeNode<K,V> replacementTreeNode(Node<K,V> p, Node<K,V> next) {
return new TreeNode<>(p.hash, p.key, p.value, next);
}
(4)TreeNode.untreeify
// 将红黑树转化为链表
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) {
// 将TreeNode转为Node
Node<K,V> p = map.replacementNode(q, null);
// 构造链表
if (tl == null)
hd = p;
else
tl.next = p;
tl = p;
}
return hd; // 返回链表头节点
}
// 将TreeNode转为Node
Node<K,V> replacementNode(Node<K,V> p, Node<K,V> next) {
return new Node<>(p.hash, p.key, p.value, next);
}
2.4 构造器
(1)无参构造器
public HashMap() {
// 初始化this.loadFactor为0.75
this.loadFactor = DEFAULT_LOAD_FACTOR;
}
(2)HashMap(int)
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
(3)HashMap(int,float)
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);
// 初始化loadFactor和threshold
this.loadFactor = loadFactor;
// tableSizeFor中会计算大于且最接近initialCapacity的2的幂并赋值给this.threshold
this.threshold = tableSizeFor(initialCapacity);
}
(4)HashMap(Map)
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
// 将m中的所有元素添加到该HashMap中
putMapEntries(m, false);
}
// evict与LinkedHashMap有关
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
int s = m.size();
if (s > 0) {
// 首次添加时,table == null成立
if (table == null) {
// 计算新阈值
float ft = ((float)s / loadFactor) + 1.0F;
int t = ((ft < (float)MAXIMUM_CAPACITY) ?
(int)ft : MAXIMUM_CAPACITY);
// 新阈值大于当前threshold,则用tableSizeFor将t转化为大于且最接近t的2的幂并赋值给threshold
if (t > threshold)
threshold = tableSizeFor(t);
}
// m的元素个数超过阈值则进行扩容
else if (s > threshold)
resize();
// 逐个元素进行复制
for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
K key = e.getKey();
V value = e.getValue();
putVal(hash(key), key, value, false, evict);
}
}
}
2.5 增
(1)put
// 添加条目
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
(2)putVal
// onlyIfAbsent为false,表示条目已存在则用新值覆盖旧值;onlyIfAbsent为true,表示条目存在不进行覆盖
// evict与LinkedHashMap有关
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. table为空,说明是首次进行添加,需对table、threshold等进行初始化
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
// 2.
// 2.1 桶为空
if ((p = tab[i = (n - 1) & hash]) == null)
// 直接创建新节点,并作为桶的第一个元素
tab[i] = newNode(hash, key, value, null);
else { // 2.2 桶不为空
Node<K,V> e; K k;
if (p.hash == hash && // 2.2.1 key对应节点与当前桶内第一个节点一致
((k = p.key) == key || (key != null && key.equals(k))))
e = p; // 初始化e,下面会进行处理
else if (p instanceof TreeNode) // 2.2.2 p是TreeNode的实例
// 若key在红黑树中存在,直接返回已存在的节点,不做处理(下面会用新值替换旧值)
// 若key在红黑树中不存在,putTreeVal中会创建新节点、添加到红黑树中,并返回null
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
else { // 2.2.3 桶是单向链表
// 遍历链表
for (int binCount = 0; ; ++binCount) {
// 2.2.3.1 该条件成立时,p.next就是新节点的位置
if ((e = p.next) == null) {
// 创建新节点并连接到p.next处
p.next = newNode(hash, key, value, null);
// 该条件是链表转红黑树的第一个条件
// 当binCount为7时条件成立,注意binCount从0开始,
// 再加上2.2.1处的第一个节点,可知链表长度达到9时,该条件成立
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
treeifyBin(tab, hash);
break;
}
// 2.2.3.2 该条件用来判断key对应的节点是否已经存在,
// 2.2.1处判断的是第一个节点,这里判断的是第一个之后的节点
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break; // 找到则跳出,下面会对e进行处理
p = e; // 上面两个条件都不成立,取后一个节点继续处理
}
}
// 2.2.4 经过上面的步骤,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;
// 3. 元素个数超过阈值则进行扩容
if (++size > threshold)
resize();
// 空实现
afterNodeInsertion(evict);
return null;
}
2.6 扩容
(1)resize
这里举几个例子,将resize的所有分支都走一遍:
-
例1
-
例2
-
例3
final Node<K,V>[] resize() {
Node<K,V>[] oldTab = table;
int oldCap = (oldTab == null) ? 0 : oldTab.length;
int oldThr = threshold;
int newCap, newThr = 0;
// 1. 初始化或更新threshold、newThr、newCap
// 1.1
if (oldCap > 0) {
// 1.1.1 该条件成立,threshold被赋值为int类型的最大值,表示不再进行扩容
if (oldCap >= MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return oldTab;
}
// 1.1.2
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
oldCap >= DEFAULT_INITIAL_CAPACITY)
newThr = oldThr << 1;
}
else if (oldThr > 0) // 1.2
newCap = oldThr;
else { // 1.3
newCap = DEFAULT_INITIAL_CAPACITY;
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
// 2.
if (newThr == 0) {
float ft = (float)newCap * loadFactor;
newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
(int)ft : Integer.MAX_VALUE);
}
threshold = newThr; // 用newThr更新阈值
@SuppressWarnings({"rawtypes","unchecked"})
// 新建newCap大小的数组
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;
// 3. oldTab不为null,需要将数据全部从旧数组复制到新数组
if (oldTab != null) {
// 遍历旧数组
for (int j = 0; j < oldCap; ++j) {
Node<K,V> e;
if ((e = oldTab[j]) != null) { // 桶不为空
oldTab[j] = null;
if (e.next == null) // 桶内只有一个元素
newTab[e.hash & (newCap - 1)] = e;
else if (e instanceof TreeNode) // 桶内是红黑树
// 将以e为根节点的红黑树分裂成两部分,这两部分可能会退化为链表
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
else { // 桶内仍是链表,将链表分裂为两部分
Node<K,V> loHead = null, loTail = null;
Node<K,V> hiHead = null, hiTail = null;
Node<K,V> next;
do {
next = e.next;
// 构造低位链表
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);
// 将构造完成的以loHead和hiHead为头节点的两条链表分别连接到低桶位和高桶位
// loTail.next和hiTail.next总是一个为null、一个不为null
if (loTail != null) {
loTail.next = null;
newTab[j] = loHead;
}
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
return newTab;
}
(2)TreeNode.split
// 分裂红黑树
// split只会在resize中被调用
final void split(HashMap<K,V> map, Node<K,V>[] tab, int index, int bit) {
TreeNode<K,V> b = this;
// Relink into lo and hi lists, preserving order
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;
// bit是resize中的oldCap
// 将红黑树构造成两条双向链表(将会分别连接到高位桶和低位桶),在后面会
// 根据lc、hc的大小将两条链表退化为链表或重新构造成新的红黑树
if ((e.hash & bit) == 0) {
if ((e.prev = loTail) == null)
loHead = e;
else
loTail.next = e;
loTail = e;
++lc; // 记录节点个数
}
else {
if ((e.prev = hiTail) == null)
hiHead = e;
else
hiTail.next = e;
hiTail = e;
++hc; // 记录节点个数
}
}
// 将以loHead为首节点的链表连接到高位桶
if (loHead != null) {
// lc不超过UNTREEIFY_THRESHOLD(6)
if (lc <= UNTREEIFY_THRESHOLD)
// untreeify中会将TreeNode转化为Node(这里可以说是将双向链表转化为单向链表)
tab[index] = loHead.untreeify(map);
else { // 否则将双向链表转化为红黑树(双向链表和红黑树共用同一个数据结构)
tab[index] = loHead;
if (hiHead != null) // (else is already treeified)
loHead.treeify(tab);
}
}
// 将以hiHead为首节点的链表连接到低位桶
if (hiHead != null) {
if (hc <= UNTREEIFY_THRESHOLD)
tab[index + bit] = hiHead.untreeify(map);
else {
tab[index + bit] = hiHead;
if (loHead != null)
hiHead.treeify(tab);
}
}
}
2.7 删
(1)remove(Object)
// 删除条目
public V remove(Object key) {
Node<K,V> e;
return (e = removeNode(hash(key), key, null, false, true)) == null ?
null : e.value;
}
(2)removeNode
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;
// table不为空且桶不为空
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;
// 键为key的节点就是头节点
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
node = p; // node指向p,下面会进行处理
else if ((e = p.next) != null) { // p有后继节点
if (p instanceof TreeNode) // p是TreeNode的实例
// 使node指向从红黑树中获取的键为key的节点
node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
else {
// 遍历链表
do {
// 寻找与键为key的节点
if (e.hash == hash &&
((k = e.key) == key ||
(key != null && key.equals(k)))) {
node = e;
break;
}
p = e; // 更新p,下面会用到
} while ((e = e.next) != null);
}
}
if (node != null && (!matchValue || (v = node.value) == value ||
(value != null && value.equals(v)))) {
if (node instanceof TreeNode) // node是红黑树的一个节点
// 从红黑树中删除node
((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
else if (node == p) // 要删除的是头节点
tab[index] = node.next;
else // 要删除的不是头节点
p.next = node.next;
++modCount;
--size;
// 空实现
afterNodeRemoval(node);
return node;
}
}
return null;
}
2.8 改
(1)replace(K,V)
// 将key对应的节点值替换为value
@Override
public V replace(K key, V value) {
Node<K,V> e;
// 获取key对应的节点
if ((e = getNode(hash(key), key)) != null) {
// 进行替换
V oldValue = e.value;
e.value = value;
// 空实现
afterNodeAccess(e);
return oldValue;
}
return null;
}
(2)replace(K,V,V)
@Override
public boolean replace(K key, V oldValue, V newValue) {
Node<K,V> e; V v;
// 获取key对应的节点,当e.value与oldValue相等时才newValue替换原值
if ((e = getNode(hash(key), key)) != null &&
((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) {
e.value = newValue;
afterNodeAccess(e);
return true;
}
return false;
}
2.9 查
(1)get
// 获取条目的值
public V get(Object key) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
(2)getNode
// 获取key对应的节点
final Node<K,V> getNode(int hash, Object key) {
Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
// 1. table不为空且桶不为空
if ((tab = table) != null && (n = tab.length) > 0 &&
(first = tab[(n - 1) & hash]) != null) {
// 1.1 key对应的节点与桶内第一个节点一致,直接返回第一个节点first
if (first.hash == hash && // always check first node
((k = first.key) == key || (key != null && key.equals(k))))
return first;
// 1.2 第一个节点有后继节点
if ((e = first.next) != null) {
// first是TreeNode的实例
// 桶转化为红黑树后,桶内节点都是TreeNode类型
if (first instanceof TreeNode)
// 从红黑树中获取key对应的节点
return ((TreeNode<K,V>)first).getTreeNode(hash, key);
// 桶仍然是单向链表
// 遍历链表,寻找key对应的节点
do {
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
return e;
} while ((e = e.next) != null);
}
}
// 未找到,返回null
return null;
}