【源码】关于Hashmap 的 putVal方法的理解

关于Hashmap 的 putVal方法的理解

JAVA源码阅读，关于Hashmap 的 putVal方法的理解，逐句注释详解

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) { // 通过hash(key) 计算出的hash值, key, value, onlyIfAbsent=true:只有不存在该key时才会进行put操作
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        // table是HashMap的底层数据结构，即为链表数组
        if ((tab = table) == null || (n = tab.length) == 0) // 当table是null或大小为0时
            n = (tab = resize()).length; // 第一次put时（即table是null）设置默认大小为16，
            //设置阈值为12[即下面的threshold，到此值时需要准备扩容]，详情看下文
        // i = (n - 1) & hash 通过哈希值计算在table表的索引值
        if ((p = tab[i = (n - 1) & hash]) == null)// 当此位置对象为null
            tab[i] = newNode(hash, key, value, null);// 创建此结点，放入此位置
        else {// 当此位置已经存有数据p
            Node<K,V> e; K k;
            if (p.hash == hash && // 若当前数据和待存入数据的哈希值相同
                ((k = p.key) == key || (key != null && key.equals(k)))) // 且二者的key是同一个对象（==判断地址相同）
                // 或者 key内容相同（有些类实现的equal判断内容相同，有些判断地址相同，详细请看==与equals的区别，这里假设是判断值相同）
                e = p;// 此时e为p，不为null
            else if (p instanceof TreeNode) // 判断p是不是已经为一个红黑树，
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);// 调用红黑树的插值方法，返回null，具体待更新
            else {// 若p还是一个链表
                for (int binCount = 0; ; ++binCount) {// 比较链表里的所有数据
                    if ((e = p.next) == null) { // 到达链表尾端时，注意，这里e为null
                        p.next = newNode(hash, key, value, null); // 在尾端加入新数据
                        // 当前链表数据大小可以转换为红黑树（TREEIFY_THRESHOLD 为 8）,
                        // 进行resize扩容或进行树化（当前table的大小达到了MIN_TREEIFY_CAPACITY = 64）
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st 
                            treeifyBin(tab, hash);// 待更新
                        break;
                    }
                    if (e.hash == hash && // 与上文判断hash和key的方法一样
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;// 若有相同数据则不加入
                    p = e; // p = p.next
                }
            }
            if (e != null) { // e为null则一定存入了table中
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null) 
                    e.value = value;
                afterNodeAccess(e);
                return oldValue; // 此时返回值不为null时，代表存入失败
            }
        }
        ++modCount; // Fail-Fast机制，记录修改次数
        if (++size > threshold)// 判断当前有效元素大小有没有超过阈值，超过则再次调用resize准备扩容
            resize();
        afterNodeInsertion(evict); // HashMap中为空，为HashMap的子类LinkedHashMap类服务，保留插入顺序
        return null; // 返回null表示成功，例如HashSet在调用map的方法时，
        // 返回的是 map.put(e, PRESENT)==null   当其为空时返回true
    }

数组扩容机制resize()的理解

上文中的扩容resize()部分

final Node<K,V>[] resize() {
        Node<K,V>[] oldTab = table;
        int oldCap = (oldTab == null) ? 0 : oldTab.length; // 原table的容量，不是有效数据的数量
        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 &&// 容量*2
                     oldCap >= DEFAULT_INITIAL_CAPACITY) 
                newThr = oldThr << 1; // 阈值*2
        }
        else if (oldThr > 0) // 使用 new HashMap(int initialCapacity) 初始化后，第一次 put 的时，初始容量设为阈值
            newCap = oldThr;
        else {
            newCap = DEFAULT_INITIAL_CAPACITY; // 16
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY); // 初始阈值设置为 16 * 加载因子（0.75）
        }
        if (newThr == 0) { // 设置初始阈值为当前大小 * 0.75
            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; // 给table赋新的数组
        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 { // 是链表
                        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;
    }

关于if ((e.hash & oldCap) == 0)这个resize之后重新规划链表元素存放位置的划分方法，主要是因为每次扩容都是翻倍，与原来计算的 (n-1)&hash的索引结果相比，只是多了一个bit位，所以节点要么就在原来的位置，要么就被分配到"原位置+旧容量"这个位置，详情见此文
也就是，只需要判断新增的那一位索引bit位（e.hash & oldCap）是1还是0，如果是0就不变，是1就原索引+oldCap

注意：如果使用IDEA在追踪源码时，底层的数据结构显示不全，可以在setting中进行调整，取消勾选下面这个选项