Java源码阅读---HashMap
2023-03-15 本文已影响0人
我也不想这样DT
HashMap源码阅读
[TOC]
本篇文章是根据 JDK8来讲的，下面我们就直接进入正题。
DEFAULT_INITIAL_CAPACITY 默认初始容量
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
默认初始容量16
MAXIMUM_CAPACITY 最大容量
static final int MAXIMUM_CAPACITY = 1 << 30;
2的30次方
DEFAULT_LOAD_FACTOR 负载因子
static final float DEFAULT_LOAD_FACTOR = 0.75f;
TREEIFY_THRESHOLD 树型阈值
static final int TREEIFY_THRESHOLD = 8;
UNTREEIFY_THRESHOLD 红黑树转链表阈值
static final int UNTREEIFY_THRESHOLD = 6;
MIN_TREEIFY_CAPACITY 链表转红黑树容量最小值
static final int MIN_TREEIFY_CAPACITY = 64;
table 存储的数组
transient Node<K,V>[] table;
threshold 扩容阈值
int threshold;
扩容阈值，当 HashMap 的个数达到该值，触发扩容
HashMap静态内部类 Node
我们简单介绍一下这个类中的一些属性及方法。
重写了hashcode和equals方法
static class Node<K,V> implements Map.Entry<K,V> {
final int hash; //hsah值
final K key; //key
V value; //value
Node<K,V> next; //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;
}
}
下面我们来看一下HashMap中的一些构造方法
（1）无参构造 HashMap()
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}
(2) 指定初始容量构造方法 HashMap(int initialCapacity)
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
（3）指定初始容量和负载因子构造方法 HashMap(int initialCapacity, float loadFactor)
public HashMap(int initialCapacity, float loadFactor) {
if (initialCapacity < 0) //判断初始容量是否小于0,小于0则抛出异常
throw new IllegalArgumentException("Illegal initial capacity: " +
initialCapacity);
if (initialCapacity > MAXIMUM_CAPACITY)//判断初始容量是否大于最大容量，如果大于则初始容量设置为最大容量
initialCapacity = MAXIMUM_CAPACITY;
if (loadFactor <= 0 || Float.isNaN(loadFactor))//判断负载因子是否小于等于0或者参数格式不是float类型，则抛出异常
throw new IllegalArgumentException("Illegal load factor: " +
loadFactor);
this.loadFactor = loadFactor;
this.threshold = tableSizeFor(initialCapacity);//这个方法的作用是找到一个离cap最近的2的n次方数
}
tableSizeFor(int cap)
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;
}
首先讲一下tableSizeFor方法里的两个运算符的使用： |=，>>>
-
运算符|=
使用 n|=n等同于n=n|n，|是位运算符（或）
-
运算符>>>
符号>>>是无符号右移运算符，就是把一个二进制数，右移指定位数，正数高位补0，负数高位补1
举例：
int num=5; //转化成二进制就是 00000000 00000101
//无符号右移一位
num=num>>>=1; //num的二进制就是 00000000 00000010
（4）参数是map集合或其子类构造方法
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
putMapEntries(m, false);
}
以上就是HashMap的所有构造方法，接下来我们先看一下HashMap的put方法。
HashMap的put(K key, V value) 方法
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
对需要put的key值去hash
static final int hash(Object key) {
int h;
//先判断key是否为null，为null则返回0；如果不为null，先获取key的hashCode值，然后用hash值异或hash值无符号右移16位后的值
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
首先对^符号进行讲解
^异或符号，二进制运算时相同为0，不同为1；
put操做的主要方法：putVal(int hash, K key, V value, boolean onlyIfAbsent,boolean evict)
final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict) {
Node<K,V>[] tab; Node<K,V> p; int n, i; //定义一个Node的空数组，一个Node空对象，两个int变量
if ((tab = table) == null || (n = tab.length) == 0) //判断数组是否为空，数组长度是否为0
n = (tab = resize()).length; //数组初始化
if ((p = tab[i = (n - 1) & hash]) == null)//判断数据要存储的节点位置是否为null
tab[i] = newNode(hash, key, value, null);//节点数据为null直接将数据存入该位置即可
else {
Node<K,V> e; K k;
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))//头节点不为null，判断hash值是否相等且key值的equals比较也相等
e = p; //节点值赋值给e
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) {//判断链表下个节点是否为null,如果为null，则把当前需要put的数据存入下个节点即可
//尾插法，每插入一个节点，bincount自增1
p.next = newNode(hash, key, value, null);
if (binCount >= TREEIFY_THRESHOLD - 1) // 判断链表长度是否大于等于8 树型阈值
treeifyBin(tab, hash);//链表转红黑树
break;//结束遍历
}
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))//判断hash值是否相等且key值的equals比较也相等
break;//结束遍历
p = e;
}
}
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e); //afterNodeAccess：hashMap只是提供一个方法，给子类：LinkedHashMap实现，自己什么也不做
return oldValue;
}
}
//更新操作次数，方便遍历的时候检测结构性变化
++modCount;
//插入完成后，size自增+1，并与扩容阈值比较，如果是true，触发resize（）进行扩容
if (++size > threshold)
resize();
afterNodeInsertion(evict);//afterNodeInsertion: hashMap只是提供一个方法，给子类：LinkedHashMap实现，自己什么也不做
return null;
}
HashMap扩容方法 resize()
扩容时机：
1、size == threshold = size * loadFactor(默认0.75）
2、treeifyBin方法触发的时候，会判断size是否大于64，如果小于，则调用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; //扩容阈值=Integer的最大值
return oldTab;
}
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
oldCap >= DEFAULT_INITIAL_CAPACITY) //新的数组大小=旧的数组大小的2倍 同时旧的数组大小大于最小数组容量
//新的扩容阈值 = 旧的扩容阈值 * 2
newThr = oldThr << 1; // double threshold
}
//说明调用了hashmap的有参构造函数，因为无参构造函数并没有对threshold进行初始化
else if (oldThr > 0) // initial capacity was placed in threshold
newCap = oldThr;
else { // zero initial threshold signifies using defaults
newCap = DEFAULT_INITIAL_CAPACITY; //16
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);//16*0.75
}
if (newThr == 0) {
float ft = (float)newCap * loadFactor;
newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
(int)ft : Integer.MAX_VALUE);
}
/*以上代码总结：
1.如果已经对底层数组初始化就进行扩容
2.如果数组长度已经是最大整数值了，最大值赋给threshold，不会在进行扩容
3.如果没有达到，数组长度扩展两倍，threshold扩招为原来的两倍
*/
threshold = newThr;
@SuppressWarnings({"rawtypes","unchecked"})
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;//扩容的新数组给底层数组
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)
//e.next == null 的时候表明数组只有一个元素，最简单
//计算在新数组的下标，插入
newTab[e.hash & (newCap - 1)] = e;
else if (e instanceof TreeNode)
//作为红黑树的节点，调用split方法进行处理
((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;
//节点的key的hash值与原数组的大小 & （与运算），得到的结果为 0 表示在新的数组中下标不变。组成新的链表
if ((e.hash & oldCap) == 0) {
if (loTail == null)
loHead = e;
else
loTail.next = e;
loTail = e;
}
//结果非0的时候，存储在新数组中一个新的位置，形成一个链表
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;
}
关于链表转红黑树的方法这里就不详细去看了，以上就是HashMap的put方法的源码解读了，下面我们来看一下get方法。
HashMap的get(Object key)方法
public V get(Object key) {
Node<K,V> e;
//获取key的hash值，作为参数
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
get方法的核心代码
final Node<K,V> getNode(int hash, Object key) {
Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
//判断数组不为空，获取需要get的数组下标的头节点数据
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)//判断是否为红黑树节点
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;
}
HashMap的remove(Object key)方法
public V remove(Object key) {
Node<K,V> e;
return (e = removeNode(hash(key), key, null, false, true)) == null ?
null : e.value;
}
remove方法的核心代码
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对应的节点是否存在
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;
//链表头不是我们要删除的key，遍历链表
else if ((e = p.next) != null) {
//链表是单向链表还是红黑树
if (p instanceof TreeNode)//判断是否为红黑树节点
node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
else {
//遍历链表，找到我们要删除的key
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：表示要删除的节点
//p: 表示tab[key.hash & size - 1] 的得到的值，不一定是要删除的值，hash冲突问题
//matchValue：默认为false，if true only remove if value is equal
if (node != null && (!matchValue || (v = node.value) == value ||
(value != null && value.equals(v)))) {
if (node instanceof TreeNode)//如果node是红黑树
((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
else if (node == p)
tab[index] = node.next;
else
//如果node为链表
p.next = node.next;
//操作次数自增1，便于在遍历的时候，检查结构性变化
++modCount;
//数组大小自减1
--size;
//afterNodeRemoval：留给LinkedHashNode实现的方法
afterNodeRemoval(node);
return node;
}
}
return null;
}
