2021-09-01

hashSet源码分析

1：简介

众所周知set是java的集合类之一，他的特性就是不能存在重复元素，如果向一个set中add一个已经存在的元素，会返回false，但是为什么会返回false，set是如何实现不能添加重复元素的，这篇文章就是我通过自己的理解来进行的描述。

在源码中我们可以看出，创建hashSet的时候其实是调用了hashMap的无参构造

2:示例

我们在这里随便创建一个hashSet
public static void main(String[] args) {
    Set<String> objects = new HashSet<>();
    objects.add("test");
}
向hashSet添加了一个元素，我们先看下当向一个空的集合中添加元素会走什么流程
public boolean add(E e) {
    return map.put(e, PRESENT)==null;
}
点进去add()方法我们发现在此处调用了一个map的put方法，
public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}
点进去put方法，发现方放是继续往下调用的，继续点击

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和p
if ((tab = table) == null || (n = tab.length) == 0)
    n = (tab = resize()).length;
因为是第一次添加元素所以上面构建的tab节点是null，所以会走if中的内容，并给tab复制一个长度为16的数组空间
if ((p = tab[i = (n - 1) & hash]) == null)
    tab[i] = newNode(hash, key, value, null);
这次判断的目的是根据所传的key的hash值堆tab数组空间做一个映射，将(n - 1) & hash作位数组的下标，因为这是第一个元素加入，tab中还没有数据，所以判断成立，
tab[i] = newNode(hash, key, value, null);这一步的目的是新键一个Node对象存储到tab中，此时table与tab只想同一个数组，而且table为全局变量，所以当添加第二个元素的时候，if ((tab = table) == null || (n = tab.length) == 0)这个判断就不通过
第一次添加元素完成
第二次添加元素(添加一个相同的元素):
if ((tab = table) == null || (n = tab.length) == 0)
    n = (tab = resize()).length;
因为当第一个元素添加成功之后，将tab和table指向了同一个数组所以二者不为空，判断不成立,
 if ((p = tab[i = (n - 1) & hash]) == null)
     tab[i] = newNode(hash, key, value, null);
因为元素相同，所以(n - 1) & hash的值是相同的，所以判断不成立进去else
if (p.hash == hash &&
    ((k = p.key) == key || (key != null && key.equals(k))))
    e = p;
因为添加的元素是相同的，所以，判断条件全部满足，将p(tab[i])赋值给e
if (e != null) { // existing mapping for key
    V oldValue = e.value;
    if (!onlyIfAbsent || oldValue == null)
        e.value = value;
    afterNodeAccess(e);
    return oldValue;
}
因为上一步判断已经将e的值赋值为tab[i]所以满足条件，所以将原值返回。
return map.put(e, PRESENT)==null;
在调用map的put方法返回的结果不为空所以这一不接过返回的为false，元素添加失败。
向set中添加第三个不同的元素
第一步同上不满足条件，第二步,因为(n - 1) & hash，因为值不一样所以取到的值为null条件满足，其余步骤同添加第一个元素。,