本文主要从HashSet的add方法开始,去了解HashSet存储数据的过程以及它的一些数据结构。
直接开始吧
以下是HashSet的add方法源码:
public boolean add(E e) {
return map.put(e, PRESENT)==null;
}
map的定义是private transient HashMap<E,Object> map;
而PRESENT的定义是private static final Object PRESENT = new Object();由于是static修饰,类加载后PRESENT就是一个单例的Object对象。
可以看到HashSet存储数据方法实际用到的是HashMap的put方法
接着走:
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
这里key就是我们要存的值了,value则是那个单例的Object对象。方法调用了HashMap的putVal方法,并对key做了hash(key)的处理,可以看看hash(key)方法的内部:
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
key如果是空的话,方法返回0,如果不是空的话返回key的哈希值前十六位和后十六位的异或(这实际上是一种尽量避免哈希值相同而做的处理)
接着回来看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);
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;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
可以拆分下来一点点看,
Node<K,V>[] tab; Node<K,V> p; int n, i;
tab是Node类的一个数组,p是Node的一个引用。n和i还没发挥作用。
Node类是HashMap的一个内部类,代码如下:
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;
}
}
可以看到Node实际存储的是上面hash(key)方法返回的值,key,value,和一个Node的引用类型next,还有一些常见的方法,这里不一一讲解。
接着看putVal的下一行
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
第一行很明显,把table赋值给tab并判断tab这个数组是不是为空,并把数组长度赋值给n。如果为空的话,调用resize()方法,并将方法返回值赋给tab,再将tab的长度赋给n。关于table定义如下
transient Node<K,V>[] table;
如果是第一次进入该函数table的值还是空的,没错,他在resize()方法进行初始化,resize()方法发挥的作用就是初始化容器大小和扩容:
/**
* Initializes or doubles table size. If null, allocates in
* accord with initial capacity target held in field threshold.
* Otherwise, because we are using power-of-two expansion, the
* elements from each bin must either stay at same index, or move
* with a power of two offset in the new table.
*
* @return the table
*/
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;
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<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)
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;
}
感觉挺长,一点点看,变量赋值
Node<K,V>[] oldTab = table;
int oldCap = (oldTab == null) ? 0 : oldTab.length;
int oldThr = threshold;
int newCap, newThr = 0;
将table赋值给了oldTab,然后判断它是不是空的,如果是空的,那么oldCap的值就是0,不是空的oldCap值就等于table的长度。把threshold赋值给oldThr,threshold实际上是一个阈值(int),它控制着容器存储到什么程度开始扩容,resize()的代码会有体现到。将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
}
这里可以看到判断了当前容器长度(table的长度)是否大于0,很明显这段是扩容时候用到的代码。判断当前容器长度有没有超过最大容器长度MAXIMUM_CAPACITY
static final int MAXIMUM_CAPACITY = 1 << 30;
挺大的,超过的话直接返回了oldTab,看来就是扩容不了。如果没有超过MAXIMUM_CAPACITY,可以看到oldCap左移了以为,实际上就是扩容了一倍。然后阈值也跟着扩大一倍。
接下来是
else if (oldThr > 0) // initial capacity was placed in threshold
newCap = oldThr;
这和HashMap的构造函数有关,不在我们讨论范围内
接着
else { // zero initial threshold signifies using defaults
newCap = DEFAULT_INITIAL_CAPACITY;
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
这个是oldCap小于等于零而且oldThr也不大于零的情况,说白了就是进入初始化的一段
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
这里就可以看出来HashMap中Node<K,V>[]的一个默认长度是16
static final float DEFAULT_LOAD_FACTOR = 0.75f;
可以看出来初始的阈值是0.75乘以16就是12。
接着往下:
if (newThr == 0) {
float ft = (float)newCap * loadFactor;
newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
(int)ft : Integer.MAX_VALUE);
}
这里也和HashMap的构造函数相关,不再讨论
go on(继续)
threshold = newThr;
@SuppressWarnings({"rawtypes","unchecked"})
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;
将新的阈值赋值给了threshold,利用新的容器大小new了新的Node数组,并将其赋值给table,实际上现在容器存储的数据还没有转移到新的容器中 ,下面的代码就是完成这部操作的。也许直接看它会很蒙B,所以我先解释一下 HashMap的数据结构数组散列:
画的好像不是很美观。。。横框代表了Node的数组,其实就是我们上面说的table,圆则是Node节点,Node中的属性next指向下一个节点。好了,开始看数据转移的代码吧,有点长所以写到注释里了
if (oldTab != null) {
//循环原来的容器
for (int j = 0; j < oldCap; ++j) {
//定义一个Node e
Node<K,V> e;
//将循环到的数据赋值给e并判断是不是空,如果是空,++j,下一个层循环
if ((e = oldTab[j]) != null) {
//将原数据位置赋值为null,释放空间
oldTab[j] = null;
//判断下一个节点是不是空,如果是空的话说明这个Node在数组中且没有下一个节点
if (e.next == null)
//直接将这个节点放到新容器下标为e的hash属性(两个e的hashCode异或)与上新长度-1,这么做不仅
//给元素新的下标,还可以防止数组下标越界
newTab[e.hash & (newCap - 1)] = e;
//这个是节点如果是树的情况,我们之后再讨论这种情况
else if (e instanceof TreeNode)
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
//数组中节点的next属性不为空
else { // preserve order
/*根据情况分为两组指针,一组为扩容后进行了
newTab[e.hash & (newCap - 1)] = e(给元素新的位置)操作后
元素仍为原来下标的头指针loHead和尾指针loTail,另一组为更新
元素位置后是原下标+原数组长度的位置的头指针hiHead和尾指针
hiTail*/
Node<K,V> loHead = null, loTail = null;
Node<K,V> hiHead = null, hiTail = null;
Node<K,V> next;
//下面我写的文字可能不太明了,将会在代码下作图演示这个过程
do {
//将next指向e.next
next = e.next;
//判断新的元素位置是原位置还是 原位置+原数组长度
//等于0是原位置,这个地方我下面会具体讨论
if ((e.hash & oldCap) == 0) {
//第一次赋值,loHead和loTail都将指向e指向的区域
if (loTail == null)
loHead = e;
//由于下面的while将e指向了next指向的区域,所以
//loTail.next即上一轮的e指向了上一轮e.next
else
loTail.next = e;
//确定loTial尾指针的地位
loTail = e;
}
//和上面的过程一样
else {
if (hiTail == null)
hiHead = e;
else
hiTail.next = e;
hiTail = e;
}
} while ((e = next) != null);
//如果尾指针loTail不为空,说明存在链表,将头结点放在原下标位置
if (loTail != null) {
loTail.next = null;
newTab[j] = loHead;
}
//如果尾指针hiTail不为空,说明存在链表,将头结点放在原下标+原数组长度位置
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
好,这里来作图解释为什么(e.hash & oldCap) == 0时,新的元素位置是原来元素所在的下标
我们上面说到过,数组长度是2的次幂,初始是16,就拿16举例,原来元素的位置是e.hash&(数组长度-1)的到的,这是putVal中的代码,我们还没讲到,将在下一篇中说到。加入数组长度是16,那么元素位置就是e.hash&01111得到的,我们看作是1xxxx&01111或0xxxx&01111
上面第五位的作用可能并不明显,可以看看扩容后新的位置的计算newTab[e.hash & (newCap - 1)] = e;新的newCap扩容了一倍,原来是16的话,现在就是32
可以因为扩容,新的元素位置可能是0xxxx也可能是1xxxx,扩容前位置只和xxxx有关。例如原来位置在1下标,这是00001或者10001和01111 &运算的结果,当扩容到32时,00001和10001与011111进行&运算结果就可能是1或者17(就是原下标加原数组长度),那么我们总结上面的情况,当下标没变就是0xxxx和原数组长度16 &运算,即0xxxx&10000结果是0,所以就出现了代码中的判断(e.hash & oldCap) == 0我们就可以确定它是扩容数组后,下标仍然没变得那个元素。
接下来是遍历节点的图解,这个两种情况是一样的。
初始情况:
next = e.next;
if (loTail == null)
loHead = e;
loTail = e;
(e = next) != null
第一次结束
第二次
next=e.next
进入else:
else
loTail.next = e;
//确定loTial尾指针的地位
loTail = e;
接下来就是重复的过程了。
源码分析1先写到这吧。