HashSet部分细讲

示例代码

初始化

1
2
3

public void test() {
    Set<String> set = new HashSet<>();
}

HashSet<>(); 的底层实际上是一个hashMap。

在这儿可以看出，HashSet中有一个属性就是HashMap

// 这个就是存储Set中数据的map，放在map的key位置
private transient HashMap<E,Object> map;

/*
 Constructs a new, empty set; the backing <tt>HashMap</tt> instance has default initial capacity (16) and load factor (0.75).
 */
public HashSet() {
    map = new HashMap<>();
}

添加元素

hashSet.add(E e)方法

从下面的代码中可以看出，添加元素调用的是map（也就是HashMap）的put方法，但是这里在KEY所在的位置上写上了一个PRESENT，在源码中可以看到这是一个Object且整个类只有一个。作用就是占位，让Map中的KEY来为Set服务。put方法会返回一个值，这个值是一个null或者不是null，具体见下文map.put(K key, V value)

private static final Object PRESENT = new Object();

public boolean add(E e) {
    return map.put(e, PRESENT)==null;
}

hashMap.put(K key, V value);

可以看到put方法中又调用了putVal() 方法，而putVal()方法中又调用了hash方法

1
2
3

public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}

putVal(int hash, K key, V value, boolean onlyIfAbsent, evict)方法

来看这个putVal() 方法，首先其中有一些参数
&emsp;hash – hash for key
&emsp;key – the key
&emsp;value – the value to put
&emsp;onlyIfAbsent – if true, don’t change existing value
&emsp;evict – if false, the table is in creation mode.
其次是这个方法也太长了吧。再长也得看呀
当map中的table数量为空的时候，就将其进行初始化，调用resize()方法, resize() 方法对当前table进行初始化或者是两倍扩容（power of two）
- 那么map中的table是个什么东西呢，点进去看一下
  transient Node<K,V>[] table;
  是一个结点数组，这个结点数组存放put进去的数据
  我们再来看一下这个结点Node，见Node
扩容或初始化完成之后，这个时候就要向map中放数据了，根据hash值和数组的大小来判断数组中的元素是否为null
- ```
如果是null的话，也就是数组中没有元素，直接将现在传入的值组装成一个结点Node，就放入到数组中就可以了
```
- 如果不是null，说明这个位置上有元素存在
  - 在hash值相同的情况下，如果两个对象一样，或者equals比较相同的话（注意这儿调用了equals() 方法，也说明了Set中为什么要重写equals方法了），就记住这个结点e
  - 判断这个结点是否是一个TreeNode的一个实例，见下文
        这就是要判断一下已经存在的结点是否是一个树结点，因为HashMap中的元素到一定程度就会树化，而不是简单的数组+链表。
        如果是一个TreeNode也就是已经改用树这种数据结构来存储了。那么就将这个元素用putTreeVal() 方法来存入，同时这个方法将所需要的信息带过去，包括这个hashMap, hashMap中的table，hash值，key和value，具体操作见下文，加入这个treeNode之后，再次记住这个结点e
  - 这种情况考虑HashMap底层目前是一个数组加上链表的一个数据结构。

    首先对这个链表进行遍历，并记住遍历的次数，当到末尾的时候，将结点挂载到这个链表的末尾，如果这个链表的长度超过了8（TREEIFY_THRESHOLD树化临界点），则对这个链表进行树化，调用treeifyBin(); 这个方法只需要传入tab和hash。
    结束之后，查看e，如果e不是null，说明e这个已经是存在于Map中了，且能够修改或原来的值为null的时候，就修改为新值并将新值返回，调用的AfterNode*() 方法是为LinkedHashMap而准备的。后面有机会再说。

添加完成之后，modCount修改次数++。如果此时的size大于临界值了，再次对table数组进行重构。
    临界值：在hashMap中的临界值是0.75（DEFAULT_LOAD_FACTOR = 0.75f）也就是当容量达到容量的75%之后，就会考虑重构table

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;
}

resize()方法

根据注释可以知道这个方法的作用就是初始化或进行扩容使用

先设置原来的长度：判断一下这个table是否为空，如果是空的话，就把旧长度设置为0，否则就设置为原来数组的长度。
若原来的长度大于0：也就是有长度
- 如果大于最大容量2的30次方（MAXIMUM_CAPACITY : 1 << 30(为了power of two)）：就设置成为Integer的最大值，也就是2的31次方减1，这个时候就违背了power of two，为什么不写 1 << 31的原因也就在这儿了，int值最大到2的31次方减1了。
  搞完之后，就将这个值设置为临界值，这时数组容量已经是非常大了，重构不了了，结束方法，返回原来的table就行了
- 先把新容量变为原来的两倍（向左移动一位），看一下有没有超出最大容量（1 << 30），如果超出就不操作，如果没有超出再看一下原来的容量是否大于等于默认初始化大小（1 << 4, power of two），如果是，就把临界值也调整为原来的两倍。
如果原来的长度小于等于0且原来的临界大小大于0，新容量就为原来的临界值大小。
原来长度小于等于0且临界容量也小于等于0，
- 这时就让新容量等于默认大小，并且临界大小为临界因子 * 默认容量
  DEFAULT_LOAD_FACTOR 默认影响因子0.75
  DEFAULT_INITIAL_CAPACITY 默认容量为 1 << 4
经过上面的操作，如果临界值还是为0，这时候就根据新的容量和影响因子得到一个临界值。

如果新容量比最大预设容量（1 << 30）小并且这个得到的临界值也比最大容量(1 << 30)小
则新的临界值就是得到的这个临界值，否则就是int的最大值2^31 - 1
根据刚刚得到的新容量，创建出一个新的结点数组。
- ```
如果原来的数组是null的话就返回，如果不是null的时候，就重构之后进行返回。此时可以得到一个结论，第一次的数组容量是 1 << 4 也就是16个大小。
```
- 如果原来的数组不是null，就要把原来数组中的数据存入到新的数组中，方法如下：
  &emsp;遍历原来的数组：对每个元素进行操作：
  - 如果这个元素是一个单元素，也就是后面没有链接其余的结点。
    根据hash值和新的数组的容量进行计算到得一个在新数组中的位置。并放入。
    - 如果这个元素是一个树结点，就进行树的分化（相当于对树进行重构）这个树是红黑树（RED-BLACK TREE）。
    - 接下来对这个元素进行操作，因为这个HashMap中的table是power of two的，所以原来链上的要么是与之相同，要么就是移到后面，这样的话，就会让这个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;
}

hash(Object o)方法

这个方法首先判断了一下这个key是否等于null，如果是null直接返回一个0，这也就说明了为什么null总是放在Set的第一个位置，且是hashMap的第一个
通过这个方法的文档注释可以看出来，将hash值与其向右无符号右移16位进行异或是为了尽量减少index冲突。
1
2
3
4
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

Node 数据结构

这个是HashMap中定义的一个Node数据结构。其中有hash，key，value，还有next
这是一个链表的其中一个结点，next是下一个节点，单链表，参见数据结构。

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;
    }
}