[Java8源码] HashMap的putVal方法源码解析

/**
 *
 * 在HashMap内部被多次调用，主要完成新增元素或修改元素值的工作
 * 同时，在有需要的情况下，完成扩容、链表转红黑树的工作
 *
 * @param hash key的哈希值
 * @param key 
 * @param value 
 * @param onlyIfAbsent 如果为true，则对应的key已存在非null的值，则不修改。
 * @param evict 如果为false，表示table处于创建中（对HashMap本身无作用，暂可不了解）.
 * @return 如果对应的key存在旧值，则返回旧值；否则返回null
 */
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底层用于存储的数组）是否未初始化
    if ((tab = table) == null || (n = tab.length) == 0)
    	// 如果table未初始化，则先调用resize初始化
        n = (tab = resize()).length;
    // 根据key的hash值计算数组下标，并获取对应的元素
    if ((p = tab[i = (n - 1) & hash]) == null)
    	// 如果对应下标的数组元素不存在，则说明集合中不存在该key，需要新增数组元素（链表节点），调用newNode方法完成新增
        tab[i] = newNode(hash, key, value, null);
    else {
    	// 如果对应下标的数组元素存在，则还需要进一步的判断，才能知道集合中是否存在该key
		// 注意：e会保存根据key找到的元素
        Node<K,V> e; K k;
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            // 如果key相等（equal），则说明找到该key的元素，则需要修改操作，是否真的要修改，需要进一步的判断
            e = p;
        else if (p instanceof TreeNode)
        	// 如果key不相等，且当前数组元素是红黑树节点，则调用其putTreeVal完成新增节点或返回已有节点的功能
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {
        	// 如果key不相等，且当前数组元素是链表节点，则逐个节点判断是否key相等
            // >> 是，则表示找到，退出循环
            // >> 否则，一直找到最后还没找到，则新增链表节点
            // >> >> 新增之后，如果链表长度>=8，则将链表转成红黑树（调用treeifyBin完成）
            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;
            }
        }
        // 如果当前key存在旧值，且允许修改，则直接修改值回旧值
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            // 空方法：留给子类扩展
            afterNodeAccess(e);
            return oldValue;
        }
    }
    // 记录HashMap的修改次数
    // 为了保证迭代器的正常工作，在迭代过程中不能对HashMap进行修改操作
    // 迭代器迭代过程时如果该值有变化，抛出异常ConcurrentModificationException
    ++modCount;
    // size 表示集合的实际元素个数
    // 如果size超过了扩容阈值，则调用resize()，完成扩容
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}