源码解读 - HashSet源码解读 - 《Java 笔记》

概述
HashSet源码解读
总结

概述

HashSet实现了Set接口
HashSet实际上是HashMap
可以存放null值，但是只能是一个null
HashSet存放元素的顺序和取出顺序不一致
不能有重复元素/对象

HashSet源码解读

代码示例

public class HashSetSource {
    public static void main(String[] args) {
        HashSet hashSet = new HashSet();
        hashSet.add("java");//第一次add分析
        hashSet.add("php");
        hashSet.add("java");
        System.out.println(hashSet);
    }
}

1、执行 HashSet()

//从这里可以看出HashSet底层其实就是一个HashMap
public HashSet() {
        map = new HashMap<>();
    }

    //这是整个HashMap最妙的代码了
    //他会找到比初始值大的离初始值最近的2的次方的数，给桶数组初始化
    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;
    }

2、指定装载因子的值

    //指定装载因子为0.75，后面桶数组到达75%就会进行扩容
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

3、执行`public boolean add(E e);` 方法

e 就是字符串常量 java，PRESENT起到的是一个占位的作用

    /*
     add带着要添加的值e和PRESENT调用put方法
     PRESENT起到的是一个占位的作用
     private static final Object PRESENT = new Object();
    */
    public boolean add(E e) {
        //可以看出put如果返回null即添加成功，否则添加失败
        return map.put(e, PRESENT)==null;
    }

4、执行`public V put(K key, V value);` 方法

方法会执行hash(key)，得到key对应的的hash值

    public V put(K key, V value) {
        //先调用hash()方法去计算K的哈希值对应桶数组的索引值
        return putVal(hash(key), key, value, false, true);
    }

5、执行`static final int hash(Object key);`方法

这其中key = "java" value = PRESENT，其实key是永远变化的，但是value是不变的，一直是PRESENT

    static final int hash(Object key) {
        int h;
        //如果key值为null则返回0，不为null调用hashCode()方法计算key的哈希值，然后无符号向右移16位，得到对应桶数组的索引值（防止hash冲突 尽量让不同的key的得到不同的hash值）
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

6、执行`inal V putVal(int hash, K key, V value, boolean onlyIfAbsent,boolean evict)`方法（重点）

putVal方法有四个参数int hash, K key, V value, boolean onlyIfAbsent, boolean evict hash：是要添加元素的hash值也就是参数key的hash（并不玩完全等同于hashcode方法的结果值）经过hash（）方法得到该值 key：要添加的元素 value：静态常量 evict：afterNodeInsertion()方法的参数 afterNodeInsertion(evict);对于hashmap是个空方法什么都没干是留给子类实现的方法

    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 就是HashMap的一个数组，类型是Node[]
          if语句表示如果当前table是null，或者大小 = 0
          就是第一次扩容，得到16个空间
          因为是第一次添加，所以此时的table一定为空，所以会进入到 resize()方法中，给桶数组指定初始容量。
          resize()方法见下一个代码块
    */
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
    /*
         1、根据key得到hash 去计算该key应该存放到table表的那个索引位置，并把这个位置的对象，赋值给p
         2、判断p 是否为空
         2.1  如果p为null，表示还没有存放元素，就创建一个Node(key= "java", value = PRESENT)
         2.2  如果p不为空，就放在该位置  tab[i] = newNode(hash, key, value, null)
    */
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {
            Node<K,V> e; K k;//一个开发技巧提示:在需要局部变量（辅助变量）时候，在创建
     /*
          如果当前索引位置对应的链表的第一个元素和准备添加的key的hash值一样
          并且满足  下面两个条件之一
          1、准备加入的 key 和 p 指向的 Node 结点的 key 是同一个对象
          2、p 指向的 Node 结点的 key 的equals() 和准备加入的key比较厚相同
          就不能加入
     */
         if (p.hash == hash &&  
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
      /*
          在判断p  是不是一颗红黑树
          如果是一颗红黑树，就调用putTreeVal来进行添加
      */
         else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
       /*
            如果table对应索引位置，以及是一个链表，就使用for循环比较
            1、依次和该链表的每一个元素比较后，都不相同，则加入到该链表的最后
            注意：在把元素条件到链表后，立即判断，该链表是否已经到达8个结点，就调用treeifyBin()对当前这个链表进行树化（转成红黑树）
            注意: 在转成红黑树，要进行判断：如果该table数组大小< 64 ，则先对table进行扩容，如果>64才会转成红黑树
            （转成红黑树：需要2个条件：table到达8个结点且table数组大于64）
            2、依次和该链表的每一个元素比较过程中，如果有相同情况，就直接break
       */
           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;
    }

7、执行`final Node<K,V>[] 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;
                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;
        //如果旧容量和阈值都为零，也就是第一次添加数据的时候，指定新容量为16，新阈值为容量的75%
        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;
        //到此所有的参数都准备好了，开始new桶数组
        @SuppressWarnings({"rawtypes","unchecked"})
        //定义一个容量为newCap的新的桶数组
        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;
    }

总结

HashSet底层是一 HashMap
添加一个元素时，先得到hash值 -> 会转成 -> 索引值
找到存储数据表table，看这个索引位置是否已经存放的有元素
如果没有，直接加入
如果有，调用equals比较，如果相同，就放弃添加，如果不相同，则添加到最后
在Java8中，如果一条链表的元素个数超过TREEIFY_THRESHOLD（默认是8），并且table的大小 >= MIN_TREEIFY_CAPACITY（默认64），就会进行树化（红黑树）
HashSet底层是HashMap，第一次添加时，table数组扩容到16，临界值（threshold）是16 * 加载因子（loadFactor）是0.75 = 12
如果table数组使用到了临界值就是32 * 0.75 = 24，依次类推
在Java8中，如果一条链表的元素个数到达TREEIFY_THRESHOLD（默认是8），并且table的大小 >= MIN_TREEIFY_CAPACITY（默认64），就会进行树化（红黑树），否则仍然采用数组扩容机制。

HashSet源码解读

概述

HashSet源码解读

1、执行 HashSet()

2、指定装载因子的值

3、执行public boolean add(E e); 方法

4、执行public V put(K key, V value); 方法

5、执行static final int hash(Object key);方法

6、执行inal V putVal(int hash, K key, V value, boolean onlyIfAbsent,boolean evict)方法（重点）

7、执行final Node<K,V>[] resize();方法

总结

3、执行`public boolean add(E e);` 方法

4、执行`public V put(K key, V value);` 方法

5、执行`static final int hash(Object key);`方法

6、执行`inal V putVal(int hash, K key, V value, boolean onlyIfAbsent,boolean evict)`方法（重点）

7、执行`final Node<K,V>[] resize();`方法