Java HashSet 底层机制、源码剖析、逐行分析
HashSet 基础说明
- HashSet 实现了 Set 接口
- HashSet 实际上是 HashMap
- 可以存放 null 值，但是只能有一个 null
- HashSet 不保证元素是有序的，取决于 hash 后，再确定索引的结果
- 不能有重复元素/对象
HashSet 底层机制说明
HashSet 的底层实际就是 HashMap，HashMap 实际就是数组 + 链表 + 红黑树的结构。数组的每个索引位置默认存放的是单向链表，如果链表的长度到达了一个临界值就会转为红黑树。
add 第一个结点添加机制
import java.util.HashSet;
public class HashSetSource {
@SuppressWarnings({"all"})
public static void main(String[] args) {
HashSet hashSet = new HashSet();
hashSet.add("java");
hashSet.add("php");
hashSet.add("java");
System.out.println("hashSet = " + hashSet);
}
}
第一步：创建 HashSet 对象
可以看到 HashSet 实际上就是 HashMap
public HashSet() {
map = new HashMap<>();
}
第二步：执行 add("java")
public boolean add(E e) {
return map.put(e, PRESENT)==null;
}
map 是上一步创建的 HashMap 对象，它的定义为：
private transient HashMap<E,Object> map;
PRESENT 主要起到占位作用，是一个空对象，用来代替 HashMap 中的 value
private static final Object PRESENT = new Object();
第三步：执行 map.put(e, PRESENT)
来到了 HashMap 的源码，真正添加结点的操作是在 putVal 中执行的。
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
但在此之前需要先 执行 hash(key)
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
这个 hash 是一个 hash 算法，并不一定是 key 的 hash 值。
如果 key 的 hash 值 < 216 - 1，那么得到就是 key 的 hash 值，否则就不是。
为了后面方便讲解，就将它称为 hash 值。计算 hash 值可供后面计算结点应该存在数组的哪个索引位置。
第四步：执行 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 其实就是数组，定义：
// transient Node<K,V>[] table;
// 判断数组是否为空，如果为空调用 resize() 方法进行第一次扩容
// 并将扩容后的数组大小返回给 n
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
// 此处省略一大堆代码
}
初始化 HashSet（或者是 HashMap）后，数组是空值（null），需要进行数组的扩容
第五步：调用 resize() 进行扩容
final Node<K,V>[] resize() {
// 定义辅助变量
Node<K,V>[] oldTab = table;
// 旧数组长度 0
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
// 新的数组长度默认为 16
newCap = DEFAULT_INITIAL_CAPACITY;
// 新的临界值默认为 12
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;
// 旧数组为空，不满足条件
if (oldTab != null) {
// 省略一大堆代码
}
// 返回新的数组
return newTab;
}
第六步：继续执行 putVal 方法
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)
n = (tab = resize()).length;
// 从这里开始
// 计算应该存放的数组索引
// 判断该索引位置是否为空，
if ((p = tab[i = (n - 1) & hash]) == null)
// 如果为空，直接将结点加到该索引位置
tab[i] = newNode(hash, key, value, null);
// 如果不为空，则该位置有可能是链表或红黑树，目前不会执行这一步
else {
// 此处省略一大堆代码
}
++modCount; // 修改次数 +1
// 判断添加后的节点数是否大于临界值
if (++size > threshold)
// 如果大于，再次扩容
resize();
// 一个空方法，供继承 HashMap 的类去实现
afterNodeInsertion(evict);
return null;
}
第 9 行：(n - 1) & hash 是计算索引的算法，计算后可以得到一个 0 ~ n -1 范围的值
这里的 n 也就是数组的长度是始终是 2 的 m 次幂，扩容后是 2m + 1 ，例如初始大小 16 = 24 ，第二次扩容 32 = 25 等。
当前的数组大小为 16，那么 n -1 用二进制表示就是 0000 1111（高位省略），二进制与运算（&）可以用来隐藏和显示某些位。这里的 0000 1111 & hash 就是指显示 hash 值的后 4 位，最终就会得到 0 ~ 15 之间的数，作为数组的索引。
add 重复结点机制
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)
n = (tab = resize()).length;
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
// 上面讲过注释省略，从这里开始分析
// 如果当前索引位置不为空（是链表或红黑树）
else {
// 定义辅助变量
Node<K,V> e; K k;
// 判断当前索引位置的结点的 hash 值是否和新结点的 hash 值相同
// 并且 key 对象相同或者 key 值相等（equlas）
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
// 将当前索引位置的结点赋值给 e
e = p;
// 判断当前索引位置是否是红黑树
else if (p instanceof TreeNode)
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
// 当前索引位置是链表
else {
// 代码省略
}
// 用 e 是否为空来判断是否存在重复结点
if (e != null) { // existing mapping for key
V oldValue = e.value;
// 判断是否更新 value
// 这里 value 始终是一个 object 对象，用来占位，所以不需要更新
if (!onlyIfAbsent || oldValue == null)
e.value = value;
// 一个空方法，供 HashMap 的子类实现
afterNodeAccess(e);
// 返回旧的 value
return oldValue;
}
}
// 下面讲过注释省略
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
add 链表结点机制
通过自定义类，重写 hashCode 返回一个定值，就可以使添加的结点的 hash 值相同，从而都添加到一个链表上
import java.util.HashSet;
public class HashSetIncrement {
@SuppressWarnings({"all"})
public static void main(String[] args) {
HashSet hashSet = new HashSet();
for (int i = 1; i < 5; i++) {
hashSet.add(new A(i));
}
System.out.println("hashSet = " + hashSet);
}
}
class A {
private int n;
public A(int n) {
this.n = n;
}
@Override
public int hashCode() {
return 100;
}
}
打上断点，当 i == 2 时强制进入
来到 putVal 方法
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)
n = (tab = resize()).length;
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
else {
Node<K,V> e; K k;
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);
// 判断链表的结点数是否到达转为红黑树的临界值（8）
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
// bin 可以理解为链表的结点
// 当 binCount 为 7 时，此时的位置是第 8 个结点
// 但由于刚刚又加入了一个结点，所以实际链表上已经有 9 个结点了
// 所以准确的说应该是超过临界值后会转为红黑树，不是到达
// 只不过 binCount 是从 0 开始数的，导致结点数少了一个
// 转为红黑树
treeifyBin(tab, hash);
break;
}
// 判断当前结点的 hash 是否和新结点的 hash 相同
// 并且 key 对象相同或者 key 值相同
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;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
第 26 行：进入 treeifyBin(tab, hash) 后还要进行一下判断，才可能转成红黑树
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) {
// 转红黑树的代码省略
}
}
也就是说，就算链表上的结点到达了 8 个，但此时数组长度小于 64，是不会将其转为红黑树的，而是进行一次扩容。
table 数组扩容机制
final Node<K,V>[] resize() {
// 定义辅助变量
Node<K,V>[] oldTab = table;
// 旧数组长度 0
int oldCap = (oldTab == null) ? 0 : oldTab.length;
// 旧临界值
int oldThr = threshold;
// 新的数组长度和临界值
int newCap, newThr = 0;
// 第 n 此扩容，n > 1
if (oldCap > 0) {
// 判断旧数组长度是否大于最大值
if (oldCap >= MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return oldTab;
}
// 新数组长度扩大两倍
// 并判断新数组长度是否 < 最大值，同时旧数组长度是否 >= 初始长度（16）
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
oldCap >= DEFAULT_INITIAL_CAPACITY)
// 新数组长度临界值扩大两倍
newThr = oldThr << 1; // double threshold
}
// 判断旧数组长度临界值是否 > 0
else if (oldThr > 0) // initial capacity was placed in threshold
// 新数组长度为旧数组长度临界值
// oldCap 为 0，因为如果 > 0 就走第一个条件了
newCap = oldThr;
// 第一次扩容
else { // zero initial threshold signifies using defaults
// 新的数组长度默认为 16
newCap = DEFAULT_INITIAL_CAPACITY;
// 新的临界值默认为 12
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
// 判断是否新临界值为 0
if (newThr == 0) {
// 将新数组大小的 0.75 倍赋值给 ft
// 初始化 HashMap 时就指定了 loadFactor 为默认临界因子（0.75f）
float ft = (float)newCap * loadFactor;
// 如果新的数组大小 < 最大长度，并且 ft < 最大长度，新的数组长度临界值就为 ft
// 否则为整数的最大值
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;
// 判断旧数组是否为空
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)
// 没有下一个结点就直接将该结点移动到新数组上
// 注意：索引是由数组长度和 hash 值共同决定的
// 此时计算索引用的是新数组的长度，结果可能会与旧数组的索引不同
newTab[e.hash & (newCap - 1)] = e;
// 判断该索引位置是不是一个红黑树
else if (e instanceof TreeNode)
// 移动树上的结点
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
// 该索引位置是一个链表
else { // preserve order
// 定义 lowHead，lowTail，表示低位链表的头结点和尾节点
Node<K,V> loHead = null, loTail = null;
// 定义 hightHead，hightTail，表示高位链表的头结点和尾节点
// 低位链表和高位链表里的位，表示的是数组索引位
// 由于数组长度的增加，新数组的索引位置可能不变，也可能变大
// 如果不变，就用低位链表；如果变大，就用高位链表
Node<K,V> hiHead = null, hiTail = null;
Node<K,V> next; // 定义下一个结点
do {
// 获取下一个结点
next = e.next;
// 计算新新数组的索引位是否不变
if ((e.hash & oldCap) == 0) {
// 判断当前结点是否是头结点
// 因为最开始定义 loTail 为 null
// 而如果添加了一个结点后，loTail 就会指新的结点，不为 null
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;
}
细节解释
移动链表时并不是把整个链表直接移动到新数组上，而是一个一个结点的移动。因为随着数组扩容后数组长度的变大，每个结点计算出的索引会和之前的不一样。
例如 数组长度由 16 位扩容到 32 位，这时显示的 hash 值就从之前的 4 位变大到 5位：
0000 1111 & hash VS 0001 1111 & hash，从之前的显示 4 位，到新的显示 5 位。假如 hash 值在第 5 位为 1，那么这两个结果就会不同，新的结果比旧的大 0001 0000 = 16 刚好就是旧数组长度。假如 hash 值在第 5 位为 0，那么这两个结果就相同。
由于每个结点的 hash 是未知的，我们不知道 hash 的第 5 位是 0 还是 1，所以扩容后每个结点的新索引都有可能发生变化，我们需要一个结点一个结点的判断。
在第 87 行：(e.hash & oldCap) == 0，换成二进制就是 hash & 0001 0000，就可以判断 hash 第 5 位的值。如果是 0，那索引就没有变化，添加到低位链表；如果是 1，那索引就变大（相差一个 oldCap），添加到高位链表。
在第 122 行：newTab[j + oldCap] = hiHead; 将高位链表添加到新的数组索引上
单步调试
在进行单步调试前，先调一下设置，否则无法看到 HashMap 里的空值
扩大添加的数量，在 add 处打一个断点
然后去 putVal 转红黑树的位置打个断点
取消第一个断点，直接跳到下一个断点
这样就来到了转红黑树的地方
可以看到，由于 hash 值固定，结点都放到了数组索引为 4 的链表上。进入该方法：
这里数组长度 < 64，所以不会进行转红黑树，而是进行数组扩容。
由于 100 < 216 - 1，所以经过 hash 算法后得到的值就是 hash 值本身：100，没有改变（前面第三步解释过），二进制形式为：0110 0100 第 5 位为 0，故在转移结点时，所有的结点都在低位链表上，新数组的索引没有改变。
这里的 size 还是 8，因为这是刚刚出扩容方法（resize）时的情况，在 putVal 最后才会将 size + 1
第三次扩容
再添加一个结点还会进行扩容，因为此时的数组长度为 32 < 64，这次扩容就要看 hash 的第 6 位了。此时的情况是：0010 0000 & hash ，前面说过 hash 是 100 也就是 0010 0000 & 0110 0100 得到第 6 位为 1，所以转移结点时，所有结点都在高位链表上。新的数组索引应该是 4 + 32 = 36。
直接跳到下一个结点，然后点击掉过，让它扩容
数组情况如下所示
