HashMap 源码分析
HashMap
本文基于 JDK1.8 源码分析。
HashMap 是基于哈希表(散列表),实现 Map 接口的双列集合,数据结构是 数组 + 链表 + 红黑树,key 是唯一的,允许存储 null 键 null 值。
源码分析
HashMap 的底层数据结构为 table 数组,table 数组中的每个元素是一个 Node 元素,这个 Node 元素可能指向下一个 Node 元素从而形成链表,当链表长度过长会转换为红黑树,table 数组的每个位置称为桶。
public class HashMap<K,V> extends AbstractMap<K,V>
implements Map<K,V>, Cloneable, Serializable {
// 默认数组初始化容量,为 2 的 N 次幂
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
// 数组最大容量
static final int MAXIMUM_CAPACITY = 1 << 30;
// 默认数组加载因子
static final float DEFAULT_LOAD_FACTOR = 0.75f;
// 链表树化阈值,当链表长度超过8,并且数组容量大于64时就会发生树化
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 Set<Map.Entry<K,V>> entrySet;
transient int size;// 数组中的元素个数
transient int modCount;// 结构上被修改的次数
int threshold;// 扩容阈值,当存储的元素个数超过此值时就会触发扩容
final float loadFactor;// 加载因子
...
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);
}
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
putMapEntries(m, false);
}
/**
* 找到大于或等于 cap 的最小2的 N 次幂
*/
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;
}
...
}
put 方法
添加数据,当数组尚未初始化,会先对数组进行初始化;
数组已经初始化,通过 hash 算法找到对应 key 下标所在的位置,如果所在的位置数据为空,直接将数据放到指定位置;如果不为空,会产生了 hash 碰撞,处理 hash 碰撞:
- 如果刚好要插入的 key 等于当前位置的 key 的话,进行替换;
- 如果桶中的数据类型为 TreeNode 的话,使用红黑树进行进行插入;
- 如果是链表,链表中存在该 key 的话进行替换,不存在则把该节点插入到链表尾部。同时判断链表长度是否超过树化阈值。
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) {
Node<K,V>[] tab; Node<K,V> p; int n, i;// n:数组长度,i:数组索引
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;// 数组未初始化时,进行初始化数组
if ((p = tab[i = (n - 1) & hash]) == null)
// 通过 hash 找到对应的数组下标,如果当前下标中的内容为null,直接将数据放进去
tab[i] = newNode(hash, key, value, null);
else {
// 如果通过 hash 找到对应下标的位置有数据,会发生 hash 碰撞
Node<K,V> e; K k;// 临时节点e,存放找到和出入key相同的节点
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
// 如果要插入 key 和当前数组对应的下标的 key 一致,就把当前节点赋值给临时节点e
e = p;
else if (p instanceof TreeNode)
// 如果是红黑树,根据红黑树插入
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
else {
// 最后桶中的数据为链表,遍历链表
for (int binCount = 0; ; ++binCount) {
// 链表中没有要插入的节点,将要插入数据插入到链表尾部
if ((e = p.next) == null) {
p.next = newNode(hash, key, value, null);
if (binCount >= TREEIFY_THRESHOLD - 1) // 链表达到树化阈值,转红黑树
treeifyBin(tab, hash);
break;
}
// 链表中找到和要插入的节点 key 一致,将该节点赋值给临时节点e
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
// 如果临时节点e不为 null,说明要插入的数据已经存在当前 HashMap 中,更新该节点的值
if (e != null) {
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e);
return oldValue;
}
}
++modCount;
if (++size > threshold)// 如果 HashMap 中的存储的元素个数大于阈值,会触发扩容
resize();
afterNodeInsertion(evict);
return null;
}
数组扩容
当第一次 put 数据和 存储元素个数大于阈值的时候会触发 resize() 进行扩容。
首先判断当前数组是否进行过初始化,如果没有进行过初始化,则进行数组初始化,如果已经初始化,则对数组进行扩容,容量为之前的两倍。
final Node<K,V>[] resize() {
Node<K,V>[] oldTab = table;
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) // 旧的阈值大于0,使用新的容量临时保存旧的阈值
newCap = oldThr;
else { // 数组和阈值都没有初始化
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"})
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;
// 如果就的数组中已经存在数据,由于容量发生变化,hash值也变化,需要重新计算元素下标
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)// 红黑树结构
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
else { // 链表结构
// loHead:低位头节点,loTail:低位尾结点
// hiHead:高位头节点,hiTail:高位尾结点
// 低位链表:存放在扩容之后的数组下标的位置,与当前数组下标位置一致的元素
// 高位链表:存放在扩容之后的数组下标的位置为当前数组下标位置+ 扩容之前数组长度的元素
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);
if (loTail != null) {
loTail.next = null;
newTab[j] = loHead;
}
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
return newTab;
}
get方法
public V get(Object key) {
Node<K,V> e;
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;
if ((tab = table) != null && (n = tab.length) > 0 &&
(first = tab[(n - 1) & hash]) != null) {
// 根据 key 的 hash 找到数组下标对应位置的数据,如果对应key和查询的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);
}
}
return null;
}
key 的 hash 计算
扰动函数,获取到 key 的 hashcode 无符号右移 16 位并和原 hashCode 进行与运算,让高位和低位都参与运算,以便 hash 值分布更均匀。
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
取模运算
(n-1) & hash,在计算机中,与运算的效率高于取余运算。只有在容量为 2 的 N 次幂的时候,(n-1) & hash 等效于 hash % n,这也是 HashMap 在构造函数无论初始化容量无论传入任何值,都会转成 2 的 N 次幂的原因。
remove 方法
public V remove(Object key) {
Node<K,V> e;
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;
//根据key和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;
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
node = p;
else if ((e = p.next) != null) {
if (p instanceof TreeNode)
node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
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);
}
}
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;
--size;
afterNodeRemoval(node);
return node;
}
}
return null;
}