上一篇：[集合类] 源码解析9(Map接口和AbstractMap抽象类)
1. 概述
我们首先看一下HashMap定义，它继承了AbstractMap抽象类，实现了Map、Cloneable、Serializable接口。
public class HashMap<K,V> extends AbstractMap<K,V>
implements Map<K,V>, Cloneable, Serializable {
AbstractMap和Map我们上一篇文章已经分析过了，传送门：[集合类] 源码解析9(Map接口和AbstractMap抽象类)
Serializable和Cloneable也分析过了，传送门：[集合类] 源码解析1(Iterable、RandomAccess、Serializable、Cloneable)
关于HashMap，官方文档是这样说的：
翻译如下：
基于哈希表的Map接口实现。此实现提供所有可选的Map操作，并允许空值和空键。(HashMap类大致相当于Hashtable，只是它是不同步的，并且允许为空。)该类不保证Map的顺序;特别是，它不能保证顺序在一段时间内保持不变。
这个实现为基本操作(get和put)提供了稳定的时间性能，假设散列函数将元素适当地分散到各个桶中。集合视图的迭代需要与HashMap实例的“容量”(桶的数量)及其大小(键值映射的数量)成比例的时间。因此，如果迭代性能很重要，那么不要将初始容量设置得太高(或负载因子太低)是非常重要的。
HashMap实例有两个影响其性能的参数:初始容量和负载因子。容量是哈希表中的桶数，初始容量只是创建哈希表时的容量。负载因子是一个度量哈希表在其容量自动增加之前允许的满度的度量。当哈希表中的entry数超过负载因子和当前容量的乘积时，将对哈希表进行rehash(即重新构建内部数据结构)，使哈希表的桶数大约扩大两倍。
一般来说，默认的负载因子(0.75)在时间和空间成本之间提供了很好的权衡。更高的值减少了空间开销，但增加了查找成本(反映在HashMap类的大多数操作中，包括get和put)。在设置map的初始容量时，应该考虑map中entry的期望数量及其负载因子，从而最小化rehash操作的频率。如果初始容量大于entry的最大数量除以负载因子，则不会发生rehash操作。
如果要将许多映射存储在HashMap实例中，那么使用足够大的容量创建映射将比根据需要执行自动rehash来扩展表更有效地存储映射。注意，使用具有相同hashCode()的多个键肯定会降低散列表的性能。为了改善影响，当键是可比较的，这个类可以使用键之间的比较顺序来帮助打破联系。
注意，这个实现不是同步的。如果多个线程同时访问一个hash map，并且至少有一个线程从结构上修改了该Map，则必须在外部对其进行同步。(结构修改是指增加或删除一个或多个映射的操作;仅仅更改与一个实例已经包含的键相关联的值并不是结构修改。)这通常是通过对一些自然封装了map对象进行同步来实现的。如果不存在这样的对象，则应该使用Collections.synchronizedMap方法“包装”Map。这最好在创建时完成，以防止意外的不同步访问Map:
Map m = Collections.synchronizedMap(new HashMap(…));
这个类的所有“集合视图方法”返回的迭代器是fail-fast的:如果在创建迭代器之后的任何时候，以任何方式(除了通过迭代器自己的删除方法)对映射进行结构修改，迭代器将抛出ConcurrentModificationException异常。因此，在面对并发修改时，迭代器会快速而干净地失败，而不是在将来某个不确定的时间冒任意的、不确定的行为的风险。
注意，不能保证迭代器的fail-fast行为，因为通常来说，在存在非同步并发修改的情况下，不可能做出任何严格的保证。fail-fast迭代器在最大努力的基础上抛出ConcurrentModificationException。因此，编写一个依赖于这个异常的正确性的程序是错误的:迭代器的快速故障行为应该只用于检测bug。
该类是Java集合框架的成员。
2. 属性
// 默认的初始容量-必须是2的幂。
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;
// 使用红黑树的桶计数阈值。当向至少有这么多节点的桶中添加元素时，该桶将被转换为红黑树。
// 该值必须大于2，并且应该至少为8，以便在收缩时转换回普通桶。
static final int TREEIFY_THRESHOLD = 8;
// 在resize操作时，红黑树退化为链表的桶计数临界值
static final int UNTREEIFY_THRESHOLD = 6;
// 是在转变成树之前，还会有一次判断，只有键值对数量大于64才会发生转换。
// 这是为了避免在哈希表建立初期，多个键值对恰好被放入了同一个链表中而导致不必要的转化。
static final int MIN_TREEIFY_CAPACITY = 64;
/* ---------------- Fields -------------- */
// 数组，也就是我们说的桶
transient Node<K,V>[] table;
// 缓存entrySet
transient Set<Map.Entry<K,V>> entrySet;
// 键值对数量
transient int size;
// 记录操作数，防止并发修改，支持fail-fast
transient int modCount;
// 要调整的下一个大小值(容量 * 负载因子)。
// 如果还没有分配表数组，则此字段保留初始数组容量，或为零，表示DEFAULT_INITIAL_CAPACITY
int threshold;
// 加载因子
final float loadFactor;
3. 存储结构
HashMap使用子类Node来存储数据，它实现了Map.Entry接口。
static class Node<K,V> implements Map.Entry<K,V> {
final int hash;
final K key;
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;
}
public final K getKey() { return key; }
public final V getValue() { return value; }
public final String toString() { return key + "=" + value; }
public final int hashCode() {
return Objects.hashCode(key) ^ Objects.hashCode(value);
}
public final V setValue(V newValue) {
V oldValue = value;
value = newValue;
return oldValue;
}
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. 三种视图
可以看到，三种视图都是对HashMap方法的封装。
public Set<K> keySet() {
Set<K> ks = keySet;
if (ks == null) {
ks = new KeySet();
keySet = ks;
}
return ks;
}
final class KeySet extends AbstractSet<K> {
public final int size() { return size; }
public final void clear() { HashMap.this.clear(); }
public final Iterator<K> iterator() { return new KeyIterator(); }
public final boolean contains(Object o) { return containsKey(o); }
public final boolean remove(Object key) {
return removeNode(hash(key), key, null, false, true) != null;
}
}
public Collection<V> values() {
Collection<V> vs = values;
if (vs == null) {
vs = new Values();
values = vs;
}
return vs;
}
final class Values extends AbstractCollection<V> {
public final int size() { return size; }
public final void clear() { HashMap.this.clear(); }
public final Iterator<V> iterator() { return new ValueIterator(); }
public final boolean contains(Object o) { return containsValue(o); }
}
public Set<Map.Entry<K,V>> entrySet() {
Set<Map.Entry<K,V>> es;
return (es = entrySet) == null ? (entrySet = new EntrySet()) : es;
}
final class EntrySet extends AbstractSet<Map.Entry<K,V>> {
public final int size() { return size; }
public final void clear() { HashMap.this.clear(); }
public final Iterator<Map.Entry<K,V>> iterator() {
return new EntryIterator();
}
public final boolean contains(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<?,?> e = (Map.Entry<?,?>) o;
Object key = e.getKey();
Node<K,V> candidate = getNode(hash(key), key);
return candidate != null && candidate.equals(e);
}
public final boolean remove(Object o) {
if (o instanceof Map.Entry) {
Map.Entry<?,?> e = (Map.Entry<?,?>) o;
Object key = e.getKey();
Object value = e.getValue();
return removeNode(hash(key), key, value, true, true) != null;
}
}
}
5. 基本方法
1）构造方法
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);
}
2）Map方法
可以看到，这些Map方法调用了HashMap的一些基础实现，getNode方法、putVal方法、removeNode方法、putMapEntries方法。
public int size() {
return size;
}
public boolean isEmpty() {
return size == 0;
}
// 调用getNode方法
public V get(Object key) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
public boolean containsKey(Object key) {
return getNode(hash(key), key) != null;
}
// 调用putVal方法
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
// 调用putMapEntries方法
public void putAll(Map<? extends K, ? extends V> m) {
putMapEntries(m, true);
}
// 调用removeNode方法
public V remove(Object key) {
Node<K,V> e;
return (e = removeNode(hash(key), key, null, false, true)) == null ?
null : e.value;
}
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;
}
}
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;
}
3）基本方法
上面我们看到，Map方法的实现中，调用了getNode方法、putVal方法、removeNode方法、putMapEntries方法，下面我们就看一下这些方法的实现。
（1） 增/改方法
// hash key的哈希值
// onlyIfAbsent 如果为true，不改变现有值
// evict 如果为false，处于创建模式
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
Node<K,V>[] tab; Node<K,V> p; int n, i;
if ((tab = table) == null || (n = tab.length) == 0)
// 如果还没有初始化table，调用resize方法，这个方法后面再说
n = (tab = resize()).length;
// 到这里，tab == table n == tab.length
if ((p = tab[i = (n - 1) & hash]) == null)
// 如果桶是空的，将当前键值对添加进去
tab[i] = newNode(hash, key, value, null);
// 到这里，p指向当前hash桶的第一个Node
else {
Node<K,V> e; K k;
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
// hash值相等，并且key相等，说明要执行更改操作，保存p节点
e = p;
else if (p instanceof TreeNode)
// 如果p是TreeNode，当前为红黑树结构，调用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.next = newNode(hash, key, value, null);
// 如果链表长度大于TREEIFY_THRESHOLD，调用treeifyBin方法转化为红黑树
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
treeifyBin(tab, hash);
break;
}
// 如果发现hash值相等，并且key相等，说明要执行更改操作
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
if (e != null) { // existing mapping for key
// 说明要执行修改操作，e为要修改的Node
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e);
// 返回旧值
return oldValue;
}
}
// 到这里，说明执行的是添加操作
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
int s = m.size();
if (s > 0) {
if (table == null) { // pre-size
// 如果table还没有初始化
float ft = ((float)s / loadFactor) + 1.0F;
int t = ((ft < (float)MAXIMUM_CAPACITY) ?
(int)ft : MAXIMUM_CAPACITY);
if (t > threshold)
threshold = tableSizeFor(t);
}
else if (s > threshold)
// 扩容table为2倍
resize();
// 遍历m，添加
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);
}
}
}
总结一下putVal方法：
- if 还没有初始化table
- 调用resize方法初始化table
- else if 当前桶是空的
- 将当前键值对添加进去
- else
- if 要执行修改操作
- 保存要修改的节点
- else if 当前桶中已经是红黑树
- 执行TreeNode的putTreeVal方法
- else
- for
- if 到链表末尾
- 将当前节点添加到链表末尾
- 如果链表长度超过TREEIFY_THRESHOLD，转化为红黑树
- 要执行修改操作
- 保存要修改的节点
- if 到链表末尾
- for
- 如果保存了要修改的节点
- 修改操作，返回旧值，end
- if 要执行修改操作
- 说明执行了添加操作，更新相关值
- 返回null，end
（2） 删除方法
// matchValue 如果为true，仅在value相等时删除
// movable 如果为false，则在删除时不移动其他节点
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;
// 到这里 p为桶里第一个节点，tab为table n为tab.length
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
// 第一个节点就是要删除的节点，保存p到node
node = p;
else if ((e = p.next) != null) {
if (p instanceof TreeNode)
// 桶中是红黑树，调用TreeNode的getTreeNode方法获取节点，保存到node
node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
else {
// 遍历链表，找到要删除的节点，保存到node
do {
if (e.hash == hash &&
((k = e.key) == key ||(key != null && key.equals(k)))) {
node = e;
break;
}
p = e;
} while ((e = e.next) != null);
}
}
// node为要删除的节点
// 或者不需要matchValue，或者value相等，才删除
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;
}
}
// 没有删除，返回null
return null;
}
（3） 查找方法
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)
// 桶中是红黑树，调用TreeNode的getTreeNode方法获取节点，保存到node
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);
}
}
// 没找到返回null
return null;
}
4） 工具方法
// 获取key的hash值
// 桶下标 (table.length - 1) & hash(key) 也就是取模运算
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
// 如果x的类是“class C implements Comparable<C>”这种形式，返回x的Class，否则返回null。
static Class<?> comparableClassFor(Object x) {
if (x instanceof Comparable) {
Class<?> c; Type[] ts, as; Type t; ParameterizedType p;
if ((c = x.getClass()) == String.class) // bypass checks
return c;
if ((ts = c.getGenericInterfaces()) != null) {
for (int i = 0; i < ts.length; ++i) {
if (((t = ts[i]) instanceof ParameterizedType) &&
((p = (ParameterizedType)t).getRawType() ==
Comparable.class) &&
(as = p.getActualTypeArguments()) != null &&
as.length == 1 && as[0] == c) // type arg is c
return c;
}
}
}
return null;
}
// 如果x匹配kc (k的筛选可比类)，则返回k.compareTo(x)，否则返回0。
static int compareComparables(Class<?> kc, Object k, Object x) {
return (x == null || x.getClass() != kc ? 0 :
((Comparable)k).compareTo(x));
}
// 返回大于等于且最接近c的2的幂次数，最大为MAXIMUM_CAPACITY。
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;
}
// 初始化table或扩容表的大小为双倍。如果table为空，则根据在阈值内的初始容量分配。
// 否则，因为我们使用的是2的幂展开，所以每个桶中的元素必须保持相同的索引，或者在新表中以2的幂偏移移动。
// 换句话说，就是元素在原位置，或者在（原位置+原表大小）位置
final Node<K,V>[] resize() {
Node<K,V>[] oldTab = table;
int oldCap = (oldTab == null) ? 0 : oldTab.length;
int oldThr = threshold;
int newCap, newThr = 0;
// 说明table中已经有数据了，进行扩容
if (oldCap > 0) {
// 超过最大容量，无法扩容
if (oldCap >= MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return oldTab;
}
// 容量翻2倍，小于最大容量 并且容量大于默认， 则将threshold翻2倍
// 这里是 1********& 下面会提到
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
oldCap >= DEFAULT_INITIAL_CAPACITY)
newThr = oldThr << 1; // double threshold
}
// 说明table中没有数据，而threshold已经初始化，则用threshold初始化容量
else if (oldThr > 0) // initial capacity was placed in threshold
newCap = oldThr;
// table没有数据，threshold也没有初始化，则初始化容量和threshold
else { // zero initial threshold signifies using defaults
newCap = DEFAULT_INITIAL_CAPACITY;
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
// 更新threshold的值
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;
// 如果是 1********&的情况，table中有数据，要将数据搬到新table中
if (oldTab != null) {
// 遍历所有桶
for (int j = 0; j < oldCap; ++j) {
Node<K,V> e;
if ((e = oldTab[j]) != null) {
// 遍历每个桶内的元素 e为桶里第一个节点
oldTab[j] = null;
if (e.next == null)
// 桶内只有一个元素，放到新table里面
newTab[e.hash & (newCap - 1)] = e;
else if (e instanceof TreeNode)
// 红黑树，调用TreeNode的split方法
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
else { // preserve order
// 链表的情况
// 使用loHead和loTail保存链表（原索引）
Node<K,V> loHead = null, loTail = null;
// 使用hiHead和hiTail保存链表（原索引+oldCap索引）
Node<K,V> hiHead = null, hiTail = null;
Node<K,V> next;
do {
// 遍历链表
next = e.next;
// 当前节点e应该放到原索引
if ((e.hash & oldCap) == 0) {
// 第一次将loHead指向第一个节点
if (loTail == null)
loHead = e;
else
// 后面用loTail添加节点到末尾
loTail.next = e;
loTail = e;
}
// 前节点e应该放到原索引+oldCap
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;
}
final void treeifyBin(Node<K,V>[] tab, int hash) {
int n, index; Node<K,V> e;
// 是在转变成树之前，还会有一次判断，只有键值对数量大于64才会发生转换。
// 这是为了避免在哈希表建立初期，多个键值对恰好被放入了同一个链表中而导致不必要的转化。
if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
resize();
else if ((e = tab[index = (n - 1) & hash]) != null) {
// e为桶中第一个节点
TreeNode<K,V> hd = null, tl = null;
do {
// 将Node转化为TreeNode
TreeNode<K,V> p = replacementTreeNode(e, null);
if (tl == null)
// 第一个节点
hd = p;
else {
p.prev = tl;
tl.next = p;
}
// tl为上一个节点
tl = p;
} while ((e = e.next) != null);
if ((tab[index] = hd) != null)
// 调用TreeNode的treeify方法，转化为红黑树
hd.treeify(tab);
}
}
扫一扫
3169
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
