JDK源码解析之HashMap
前言：
关于HashMap的源码解析网上已经有很多大神级别的文章，看的笔者心生敬佩，真心不敢写了。
但是每次聊到HashMap的时候，总会有知识点是模糊的，应该还是眼高手低的缘故，所以还是决心写一下（很多参考大神的文章）
注意：笔者的JDK是1.8.3版本的，所以包括之前写的JDK源码解析系列都是这个版本的
1.有关于哈希表
哈希表这种数据结构，本质上也是数组，但是它与传统数组不同的是，它的下标是通过对数据进行一个函数处理之后，然后得到一个下标值，再在相应的位置存放该数据即可。
所以针对数据的添加和查询操作都是基于函数处理之后获取下标，这样（在没有哈希冲突的情况下）它的操作时间复杂度都在O(1)
笔者之前写过一篇关于哈希表实现的文章，读者可参考下：https://blog.csdn.net/qq_26323323/article/details/79497114
网上发现一篇写的比较好的哈希表博客：https://www.cnblogs.com/s-b-b/p/6208565.html
2.HashMap的存储解决方案
我们都知道HashMap是基于数组+链表的方式实现的，当然这是在JDK6的时候的实现方式。
在JDK8中，HashMap做了一些变化，变成了数组+（链表|红黑树）的实现方式
我们来简单想一下为什么会有这种变化？
HashMap在解决哈希冲突的时候默认是采用链地址法，当出现哈希冲突时，以链表的方式来存储冲突的数据。
我们再来思考一下使用链表来存储数据有什么不好的地方？
如果使用链表来存储，链表的查询时间复杂度为O(N)，当链表过长时，就会发生查询效率过低的问题，那么如何解决呢？
如果使用红黑树来存储的话，那查询时间复杂度直接降为O(log(n))，这样就解决了刚才链表查询效率过低的问题，所以HashMap8发生了这个优化
借用网友的一个图片来总结一下（实在不会画图）来自https://www.cnblogs.com/yangming1996/p/7997468.html ：
3.HashMap的结构分析
public class HashMap extends AbstractMap
implements Map, Cloneable, Serializable {
/** 常量 */
// 初始化容量，默认为16
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时，链表存储就转换为红黑树
static final int TREEIFY_THRESHOLD = 8;
//
static final int MIN_TREEIFY_CAPACITY = 64;
/** 属性 */
// 存储数组，每个节点都是Node对象
transient Node[] table;
// 存储的节点数量
transient int size;
// 用于快速失败
transient int modCount;
// The next size value at which to resize (capacity * load factor).
// 扩展后的数组长度
int threshold;
// 负载因子，可主动指定，建议直接使用默认值0.75
final float loadFactor;
// 哈希表中存储的是Node对象
static class Node implements Map.Entry {
final int hash;
final K key;
V value;
Node next;
...
} 可以看出，HashMap使用Node[]数组来存储数据，每一个Node都指向下一个节点，从这里也可以看出是链表结构
4.HashMap的构造方法
// 1.空参构造
// 只是初始化了负载因子，并没有初始化数组大小
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}
// 2.指定初始化数组大小
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
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);// 这个方法比较有意思，下面单独分析
}
// 3.初始化有Map数据
public HashMap(Map m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
// 逐个存储到新的map中
putMapEntries(m, false);
}构造方法就是以上三个，主要就是初始化loadFactor和threshold两个参数
1）HashMap.tableSizeFor()
刚才有这个方法，我们来介绍下，看下其具体操作
/**
* Returns a power of two size for the given target capacity.
*/
// 从注释可以看出，返回时最接近（大于）用户给定的初始值大小的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;
}这里先不讨论为什么threshold需要2的平方数，我们就讨论下这个方法是如何根据用户输入的值cap返回一个刚好大于等于cap的2的平方数？
这里给定cap=6，则
int n = cap - 1;// n=5
n |= n >>> 1;// n=7
n |= n >>> 2;// n=7
n |= n >>> 4;// n=7
n |= n >>> 8;// n=7
n |= n >>> 16;// n=7
return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;//最终结果为n+1=8，刚好是比6大的2的平方数具体异或过程，读者可将其异或过程写下
5.添加操作
// 主要就是我们使用的put方法
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
// 求hash的过程
static final int hash(Object key) {
int h;
// 主要就是根据key的hashCode来决定的
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
// 主要方法在这里
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
Node[] tab; Node p; int n, i;
// 1.第一次添加数据的时候table数组还是空，所以需要调用resize()方法初始化table数组
// 在后面接着描述这个方法
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
// 2.如果定位到的具体index值为空，则直接创建Node对象并存放到该位置
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
else {
// 3.否则，说明该节点已经有值，那么就需要添加到链表或者树中
Node e; K k;
// 3.1 如果新入数据的key和原key的hashCode、equals均相等，则判定key相等
// 这个时候执行的替换操作，将新值替换老值
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
e = p;
// 3.2 如果节点是TreeNode类型，则按照红黑树的方式来添加数据
else if (p instanceof TreeNode)
e = ((TreeNode)p).putTreeVal(this, tab, hash, key, value);
else {
// 3.3 以链表的方式来添加数据，添加到链表尾
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;
}
}
// 4.说明是修改操作，老的e值传递出去
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e);
return oldValue;
}
}
++modCount;
// 5.如果size超过了我们设置的阈值，则需要进行扩容操作
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
} 1）HashMap.resize()扩容方法
final Node[] resize() {
// 1.获取老的table，cap ,threshold
// 如果数组为空，则创建一个为默认容量16的数组，threshold为12
Node[] 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) // 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;
@SuppressWarnings({"rawtypes","unchecked"})
Node[] newTab = (Node[])new Node[newCap];
table = newTab;
// 2.如果数组有值，则逐个存放
if (oldTab != null) {
for (int j = 0; j < oldCap; ++j) {
Node e;
if ((e = oldTab[j]) != null) {
oldTab[j] = null;
// 2.1 如果e.next为null，说明当前节点只有一个值，直接更新当前值到newTab即可
if (e.next == null)
newTab[e.hash & (newCap - 1)] = e;
// 2.2 如果e为TreeNode结构，则按照红黑树的方式来分裂
else if (e instanceof TreeNode)
((TreeNode)e).split(this, newTab, j, oldCap);
else { // preserve order
// 2.3 链表的方式来逐个添加数据到newTab
Node loHead = null, loTail = null;
Node hiHead = null, hiTail = null;
Node 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;
} 总结：扩容的主要依据就是存放的节点（Node）数是否超过阈值，超过阈值则扩容一倍（为当前阈值的两倍）
6.删除操作
public V remove(Object key) {
Node e;
// 主要就是removeNode方法
return (e = removeNode(hash(key), key, null, false, true)) == null ?
null : e.value;
}
// HashMap.removeNode()
final Node removeNode(int hash, Object key, Object value,
boolean matchValue, boolean movable) {
Node[] tab; Node p; int n, index;
// 1.按照添加的方式来获取根据key.hashCode获取对应的索引位置
if ((tab = table) != null && (n = tab.length) > 0 &&
(p = tab[index = (n - 1) & hash]) != null) {
Node node = null, e; K k; V v;
// 2.如果比较index位置的元素p的key元素的hashCode和equals方法均相等，则这个p元素就是我们需要的节点
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
node = p;
// 3.否则就需要遍历链表或者红黑树
else if ((e = p.next) != null) {
// 3.1按照红黑树的方式遍历
if (p instanceof TreeNode)
node = ((TreeNode)p).getTreeNode(hash, key);
else {
do {
// 3.2按照链表的方式遍历
if (e.hash == hash &&
((k = e.key) == key ||
(key != null && key.equals(k)))) {
node = e;
break;
}
p = e;
} while ((e = e.next) != null);
}
}
// 4.遍历到该节点后，则执行删除操作
if (node != null && (!matchValue || (v = node.value) == value ||
(value != null && value.equals(v)))) {
// 4.1 按照红黑树的方式删除
if (node instanceof TreeNode)
((TreeNode)node).removeTreeNode(this, tab, movable);
// 4.2 按照链表的方式删除
else if (node == p)
tab[index] = node.next;
else
p.next = node.next;
++modCount;
--size;
afterNodeRemoval(node);
return node;
}
}
return null;
} 总结：注意这里比较是否同一个节点的方式，主要就是比较Node的key元素，我们再来仔细分析一下这个比较语句
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))这里就牵涉到另一个问题：修改对象的equals方法是否需要同时修改对象的hashCode方法？
答案是肯定的，主要就体现在这里
这里先比较两个元素的hash值是否相同，如果hash值都不同，那么一定不是同一个对象，可以直接返回；如果hash值相同，那么再比较两个对象的equals方法，hash值和equals方法均相同时，才判定两个元素是同一个值。
如果我们修改了equals方法而没有修改hashCode方法，则就有可能发生两个不同的对象hash值相等而且equals方法相等，这样会被判定是同一个对象，直接执行了替换操作，实际应该执行添加操作
7.查询操作
public V get(Object key) {
Node e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
// HashMap.getNode()
final Node getNode(int hash, Object key) {
Node[] tab; Node first, e; int n; K k;
// 1.获取first的方式同刚才删除的方式相似，
// 也是通过key.hashCode获取其在数组中的index
if ((tab = table) != null && (n = tab.length) > 0 &&
(first = tab[(n - 1) & hash]) != null) {
// 2.如果key经过hashCode和equals的比较之后都相同，则确认这就是我们需要的Node
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)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;
} 总结：
读者需要注意的是：JDK1.6和JDK1.8中关于HashMap实现的不同，JDK1.8中在发生哈希碰撞时，如果链表的长度超过8，则直接变成红黑树存储。
还有就是在HashMap中比较key是否相等的方式，先比较两个key的hashCode，再使用equals进行比较，如果两个都相等，则判定是同一个key，所以在这里，我们如果修改了key对象的equals方法则必须要同步修改其hashCode方法
参考：https://www.cnblogs.com/yangming1996/p/7997468.html