1. 概述
HashMap 基于哈希表实现,通过 key 查找 对应的 value ,时间复杂度为 O(1),即常数阶;
HashMap 的底层数据结构为 数组 + 链表/红黑树;
数组的长度为 n,下图中的数组长度为4,n 为4, 键值对放入那个桶的计算方法为 (n - 1) & key.hash。
2. 静态常量
(1)数组的默认容量:16,必须是2的n次幂;容量指的是数组的长度
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
默认容量为什么是2的n次幂?
key在数组中的下标为: (n - 1) & hash,hash为key的hash值。如果这个n是2的N次幂,那么hash相当于和111***111做与运算,数据分散的就比较均匀。如果n不是2的N次幂,如果 n 为 1111,hash和1110做与运算,那么最后一位怎么与都是0,那相当hash 的最右位没用了。
(2)最大的容量为 2^30
static final int MAXIMUM_CAPACITY = 1 << 30;
(3) 负载因子, 默认负载因子为0.75
static final float DEFAULT_LOAD_FACTOR = 0.75f;
(3)一个桶中从链表转成红黑树的阈值为8
static final int TREEIFY_THRESHOLD = 8;
(4)一个桶中,由红黑树转成链表的阈值,resize的时候可能会用到这个值
static final int UNTREEIFY_THRESHOLD = 6;
(5) 树形化最小hash键值对总数,如果桶内元素已经达到转化红黑树阈值,但是键值对未达到MIN_TREEIFY_CAPACITY,则值进行扩容resize(),不进行树形化。
static final int MIN_TREEIFY_CAPACITY = 64;
3. 节点
节点用来 存储 键值对,指向下一个节点的指针,当前节点的 hash 值。
// 键值对
static class Node<K,V> implements Map.Entry<K,V> {
// Hash 值
final int hash;
// key 键值
final K key;
// vlaue 值
V value;
// 下一个节点
Node<K,V> next;
// 节点构造函数
Node(int hash, K key, V value, Node<K,V> next) {
this.hash = hash;
this.key = key;
this.value = value;
this.next = next;
}
// get 函数
public final K getKey() { return key; }
public final V getValue() { return value; }
public final String toString() { return key + "=" + value; }
// hashcode
public final int hashCode() {
return Objects.hashCode(key) ^ Objects.hashCode(value);
}
// 设置 新值,返回旧值
public final V setValue(V newValue) {
V oldValue = value;
value = newValue;
return oldValue;
}
// equals 比较是否相等
public final boolean equals(Object o) {
if (o == this)
return true;
if (o instanceof Map.Entry) {
Map.Entry<?,?> e = (Map.Entry<?,?>)o;
if (Objects.equals(key, e.getKey()) &&
Objects.equals(value, e.getValue()))
return true;
}
return false;
}
}
4. 成员变量和方法
3.1 求key 的 hash值
>>> 无符号右移,忽略符号位,空位都以0补齐。 hashcode 为 int, 32位。
static final int hash(Object key) {
int h;
// 如果 hash == null, hash 值为0
// 否则 哈希值 = key 的 hashcode &
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
可以看到它并没有直接使用Object中生成hashcode的方法,而是 (h = key.hashCode()) ^ (h >>> 16) ,这个方法叫扰动函数,和之前的要将capacity设计成2^n一样,也是为了减少碰撞用的。
根据前面可知,key在Node[]中的下标为 key.hashCode & (n-1),我们知道key.hashCode是一个很长的int类型的数字(范围大概40亿),而n-1显然没有这么长,如果直相与,那么只有key.hashCode的后面几位参与运算了,显然会使得碰撞很激烈!加了这个函数之后,让高位也想办法参与到运算中来,这样就有可能进一步降低碰撞的可能性了!
3.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的二进制为01xx…xx。
对cap右移1位:01xx…xx,位或:011xx…xx,使得与最高位的1紧邻的右边一位为1,
对cap右移2位:00011x..xx,位或:01111x..xx,使得从最高位的1开始的四位也为1,
以此类推,int为32位,所以在右移16位后异或最多得到32个连续的1,保证从最高位的1到末尾全部为1。
最后让结果+1,就得到了最近的大于cap的2的整数次幂。
3.3 数组
数组分配时,长度总是2的幂。(在某些操作中,我们还允许长度为零,以允许当前不需要的引导机制。)
transient Node<K,V>[] table;
数组为什么是transient?
为了解答这个问题,我们需要明确下面事实:
Object.hashCode方法对于一个类的两个实例返回的是不同的哈希值
可以试想下面的场景:
我们在机器A上算出对象A的哈希值与索引,然后把它插入到HashMap中,然后把该HashMap序列化后,在机器B上重新算对象的哈希值与索引,这与机器A上算出的是不一样的,所以我们在机器B上get对象A时,会得到错误的结果。
所以说,当序列化一个HashMap对象时,保存Entry的table是不需要序列化进来的,因为它在另一台机器上是错误的,所以属性这里为transient。
因为这个原因,HashMap重写了writeObject与readObject 方法。
3.4 保存缓存entrySet ()
注意AbstractMap字段用于keySet()和values()。保存K/V对的Set。
transient Set<Map.Entry<K,V>> entrySet;
3.5 键值对的数量
transient int size;
3.6 在结构上修改这个HashMap的次数
结构修改是指改变HashMap中映射的数量或以其他方式修改其内部结构(例如,rehash)。此字段用于使HashMap集合视图上的迭代器快速失效。(见ConcurrentModificationException)。
transient int modCount;
3.7 要调整大小的下一个大小值(容量*负载因子)
Threadhold表示当容量达到该值时,会进行resize 扩容。
int threshold;
3.8 哈希表的加载因子,即size > capacity * loadFactor,hashmap就要进行扩容。
final float loadFactor;
3.9 构造函数
构造参数,初始容量和加载因子。加载因子默认为 0.75;
public HashMap(int initialCapacity, float loadFactor) {
// 初始容量 需要大于等于 0
if (initialCapacity < 0)
throw new IllegalArgumentException("Illegal initial capacity: " +
initialCapacity);
// 初始容量 需要 <= 最大容量
if (initialCapacity > MAXIMUM_CAPACITY)
initialCapacity = MAXIMUM_CAPACITY;
// loadFactor 必须是浮点数,且大于 0
if (loadFactor <= 0 || Float.isNaN(loadFactor))
throw new IllegalArgumentException("Illegal load factor: " +
loadFactor);
this.loadFactor = loadFactor;
this.threshold = tableSizeFor(initialCapacity);
}
HashMap 初始化的初始化容量。
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
默认构造参数。
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}
使用 Map m 构建一个 hashMap。
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
putMapEntries(m, false);
}
将 m 的值赋给 table;
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
// m 的数量
int s = m.size();
if (s > 0) {
// table 为空,则未初始化
if (table == null) { // pre-size
// 容量
float ft = ((float)s / loadFactor) + 1.0F;
int t = ((ft < (float)MAXIMUM_CAPACITY) ?
(int)ft : MAXIMUM_CAPACITY);
// t 大于 阈值,则初始化阈值
if (t > threshold)
threshold = tableSizeFor(t);
}
// 已初始化,键值对的数量大于阈值,扩容
else if (s > threshold)
resize();
// 将 m 中的元素放到 table 中
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);
}
}
}
3.10 键值对数量 和 是否为空
public int size() {
return size;
}
public boolean isEmpty() {
return size == 0;
}
5. get 方法
get 方法 根据 key 查找节点 。
public V get(Object key) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
根据 key 的 hash 值 和 key 查找节点。
final Node<K,V> getNode(int hash, Object key) {
Node<K,V>[] tab;
Node<K,V> first, e;
int n; K k;
// table 不为空,长度大于0
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) {
// 红黑树调用 getTreeNode()
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;
}
3.12 查看是否包含一个 key
public boolean containsKey(Object key) {
return getNode(hash(key), key) != null;
}
3.13 是否包含一个值,
public boolean containsValue(Object value) {
Node<K,V>[] tab; V v;
if ((tab = table) != null && size > 0) {
for (int i = 0; i < tab.length; ++i) {
for (Node<K,V> e = tab[i]; e != null; e = e.next) {
if ((v = e.value) == value ||
(value != null && value.equals(v)))
return true;
}
}
}
return false;
}
6. put 方法
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) {
Node<K,V>[] tab;
Node<K,V> p;
int n, i;
// table 为 null 或 为 0
// resize 扩容
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
// 对 Hash 码 进行取模运算
// i = (n - 1) & hash ,取得值应该放入的桶
// 如果 桶 i 为 null 则新建桶
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
else {
// 桶已经被初始化
Node<K,V> e;
K k;
// 如果 当前节点的 hash 值等于 插入的 key地址相同,hash 值也相同
// 或者 当前节点的 key 与 插入的 key相同,
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
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) // -1 for 1st
treeifyBin(tab, hash);
break;
}
// 替换一个结点
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
// 如果存在重复的就直接替换
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e);
return oldValue;
}
}
// 记录修改次数
++modCount;
// 如果size 大于 threshold,扩容
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
树化 hash & n-1 的那个桶。
final void treeifyBin(Node<K,V>[] tab, int hash) {
int n, index; Node<K,V> e;
// table 为空 或 数组的长度 小于 MIN_TREEIFY_CAPACITY
if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
resize();
else if ((e = tab[index = (n - 1) & hash]) != null) {
TreeNode<K,V> hd = null, tl = null;
do {
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);
}
}
将指定映射的所有映射复制到此映射。这些映射将替换当前指定映射中任意键的映射。
public void putAll(Map<? extends K, ? extends V> m) {
putMapEntries(m, true);
}
7. resize 扩容操作
resize扩容操作主要用在两处:
向一个空的HashMap中执行put操作时,会调用resize()进行初始化,要么默认初始化,capacity为16,要么根据传入的值进行初始化。
put操作后,检查到size已经超过threshold,那么便会执行resize,进行扩容,如果此时capcity已经大于了最大值,那么便把threshold置为int最大值,否则,对capcity,threshold进行扩容操作。
发生了扩容操作,那么必须Map中的所有的数进行再散列,重新装入。
扩容一次,容量扩充两倍。
final Node<K,V>[] resize() {
// 旧表
Node<K,V>[] oldTab = table;
// 旧表的容量
int oldCap = (oldTab == null) ? 0 : oldTab.length;
// 旧表的阈值
int oldThr = threshold;
// 新表的容量,新表的阈值
int newCap, newThr = 0;
// 数组长度 大于 0,已经初始化
if (oldCap > 0) {
// 无法再扩充
if (oldCap >= MAXIMUM_CAPACITY) {
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) // 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;
// 一个新的 table
@SuppressWarnings({"rawtypes","unchecked"})
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;
// 处理旧的 table
if (oldTab != null) {
for (int j = 0; j < oldCap; ++j) {
Node<K,V> e;
// 获取旧表 桶j 的头结点
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 { // preserve order
// 尾插法
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;
}
8. 移除节点
移除一个节点:
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;
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;
}
清除所有键值对。
public void clear() {
Node<K,V>[] tab;
modCount++;
if ((tab = table) != null && size > 0) {
size = 0;
for (int i = 0; i < tab.length; ++i)
tab[i] = null;
}
}