HashMap源码解读（-）--- put方法的实现过程

花了一天时间，读了一下HashMap的源码，真是思绪万千：怎么能花这么长时间？效率太低了吧？怎么有些地方还是看不懂，比如红黑树？写HashMap的这些人，到底是什么神仙？思维真的好严谨，设计真的好巧妙啊！

下载了jdk8的源码，先通读+debug过了一遍，啊不，好多遍，直到看的差不多了，这个差不多就是解决了之前的很多疑问，然后边读边顺，画出了流程图，最后又顺了一遍，在源代码上加了注释，现在把这些注释和流程图记录在博客中，以防在某个不经意的瞬间看看~~

一、put方法的流程

先上图，针对红黑树的部分，暂时没有😞  😞   😞

二、源码分析注释

2.1 put方法

/**
     * Implements Map.put and related methods
     *
     * @param hash hash for key
     * @param key the key
     * @param value the value to put
     * @param onlyIfAbsent if true, don't change existing value
     * @param evict if false, the table is in creation mode.
     * @return previous value, or null if none
     * 注意点：
     * 1、桶的容量为2^n是为了计算元素存储的索引时更快（取模运算 < 位运算）
     * 2、hash的计算要用hashCode与自身无符号右移16位进行异或运算，是为了使元素均匀地分布在不同的位置，减少hash碰撞
     * 3、链表转红黑树的条件：链表长度>=8 且 桶的容量>=64
     * 4、判断两个key是否相同的条件：key的hash值和key完全相同，他们是否完全相同取决于开发者是否重写了hashCode()和equals()方法
     * 5、触发数组扩容的条件有两个：
     *    ① 链表长度>=8，但是桶容量不足64
     *    ② 元素的个数超过了桶容量*加载因子个时需要扩容
     *
     */
    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为空，执行数组的初始化操作
         */
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        /*
          初始化后的数组为一个容量等于16，元素为null的空数组
         */
        if ((p = tab[i = (n - 1) & hash]) == null)
            /*在索引=(n-1)&hash的位置插入元素
              索引的计算为取模运算hash%length,但是Java开发人员发现当length为2^n时，hash%length == hash&(n-1)
              由于位运算的效率比取模运算高，所以要求数组的容量为2^n
            */
            tab[i] = newNode(hash, key, value, null);
        else {
            /*当要插入的位置元素不为空时，说明出现了hash碰撞，则进行冲突处理*/
            Node<K,V> e; K k;
            /*出现冲突的条件是：
            两个key的hash相同并且值相等或者值相等
            注意：在使用自定义对象为key时，需要重写hashCode()和equals()方法，否则==比较的是两个对象的内存地址*/
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                //当两个key完全相同时，说明元素已经存在，则返回已存在元素即可
                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
                            /*超过（含等于）则执行链表转红黑树的操作
                            注意：在下面的方法中不会直接将链表转成红黑树，还要判断桶的容量是否超过64，超过之后才树化，否则还要继续扩容*/
                            treeifyBin(tab, hash);
                        //插入成功，直接跳出循环
                        break;
                    }
                    //如果链表的下一个节点不为空，则比较是否与要插入的key相等
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        //相等说明要插入元素已经存在，直接跳出循环
                        break;
                    //否则遍历下一个元素
                    p = e;
                }
            }
            //如果要插入的key已经存在，是否需要覆盖旧值
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                //默认是覆盖旧值的
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                //LinkedHashMap中使用的方法，在HashMap中是一个空实现
                afterNodeAccess(e);
                return oldValue;
            }
        }
        //每一次修改modCount都要加1
        ++modCount;
        //最后还要判断一次是否需要扩容：添加的元素个数超过了桶的阈值
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

2.2 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.
     * 注意点：
     * 1、首次put，需要进行桶的初始化操作，并返回一个容量为16的空数组
     * 2、非首次时先执行扩容，再迁移数据
     * ①如果某个索引只有一个元素，则按照新容量计算索引位置，并将元素放到指定位置
     * ②如果是个红黑树，则执行红黑树的迁移
     * ③如果是个链表，则要判断是否需要重新计算索引
     *   不需要计算：直接放入新数组中的旧位置上
     *   需要计算：直接放入新数组中[旧位置+旧桶容量]的位置上，即向后移动旧桶容量大小个位置
     *
     * @return the table
     */
    final Node<K,V>[] resize() {
        //获取现存的桶
        Node<K,V>[] oldTab = table;
        //计算桶的容量：如果桶为空则容量为0，否则为数组长度
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        //将扩容阈值设置为当前桶的阈值，如果元素第一次添加，上面的oldCap和下面的oldThr都为0
        int oldThr = threshold;
        //初始化新桶的容量和扩容阈值都为0
        int newCap, newThr = 0;
        //第一种情况：如果当前桶的容量大于0，说明桶已经被初始化过
        if (oldCap > 0) {
            //检查当前桶的容量是否大于最大值2^30
            if (oldCap >= MAXIMUM_CAPACITY) {
                //如果桶的容量已经超过最大值，则将扩容阈值设置为整数最大值
                threshold = Integer.MAX_VALUE;
                //直接返回当前桶，说明已经无法扩容了
                return oldTab;
            }
            //否则如果扩容2倍后的容量小于最大值且当前容量大于默认值16，则将容量扩大至原来的2倍，即16*2=32
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                //将扩容的阈值也增大到原来的两倍，即16*0.75*2=24
                newThr = oldThr << 1; // double threshold
        }
        //第二种情况：当前桶容量为0，但是扩容的阈值大于0，则将容量初始化为阈值大小
        //这一点是为了处理当开发者初始化HashMap时，指定容量为0但是加载因子不为空的场景？
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        //第三种情况：当前桶的容量和扩容阈值都不大于0时，直接用默认的容量和加载因子进行初始化，初始化时指定扩容的阈值为容量*加载因子=12
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        //当新桶的扩容阈值为0时，计算扩容阈值
        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;
        //如果旧桶不为空，则执行数据的迁移操作，否则说明是首次初始化，直接返回一个元素个数为0，容量为16的数组，数组元素为空
        if (oldTab != null) {
            //遍历旧桶中的元素：从数组的第一个索引开始
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                //当元素不为空时，取出当前位置的元素，执行数据迁移，否则继续遍历
                if ((e = oldTab[j]) != null) {
                    //先将旧桶中的元素设置为null
                    oldTab[j] = null;
                    if (e.next == null)
                        //如果当前节点的next为空，说明只有这一个元素，直接取当前元素的hash值，计算在新数组中的索引位置
                        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;
    }

 不得不说，Doug Lea大神，还有HashMap的设计者是真的牛逼啊，看完HashMap的源码比看完百年孤独更让人觉得孤独啊~~才知道为什么面试官那么喜欢问HashMap了~~~