2018-03-20

public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }
    //这里onlyIfAbsent表示只有在该key对应原来的value为null的时候才插入，也就是说如果value之前存在了，就不会被新put的元素覆盖。
    //evict参数用于LinkedHashMap中的尾部操作，这里没有实际意义。
　　final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict) {
        //定义变量tab是将要操作的Node数组引用，p表示tab上的某Node节点，n为tab的长度，i为tab的下标。
        Node[] tab; Node p; int n, i;
        //判断当table为null或者tab的长度为0时，即table尚未初始化，此时通过resize()方法得到初始化的table。             　　　　　　　　　　　
        if ((tab = table) == null || (n = tab.length) == 0)
            //这种情况是可能发生的，HashMap的注释中提到：The table, initialized on first use, and resized as necessary。
            n = (tab = resize()).length;
        //此处通过（n - 1） & hash 计算出的值作为tab的下标i，并另p表示tab[i]，也就是该链表第一个节点的位置。并判断p是否为null。
        if ((p = tab[i = (n - 1) & hash]) == null)
            //当p为null时，表明tab[i]上没有任何元素，那么接下来就new第一个Node节点，调用newNode方法返回新节点赋值给tab[i]。
            tab[i] = newNode(hash, key, value, null);
        else {//下面进入p不为null的情况，有三种情况：p为链表节点；p为红黑树节点；p是链表节点但长度为临界长度TREEIFY_THRESHOLD，再插入任何元素就要变成红黑树了。
            Node e; K k;//定义e引用即将插入的Node节点，并且下文可以看出 k = p.key。
            if (p.hash == hash &&//HashMap中判断key相同的条件是key的hash相同，并且符合equals方法。这里判断了p.key是否和插入的key相等，如果相等，则将p的引用赋给e。
            ((k = p.key) == key || (key != null && key.equals(k))))           //这一步的判断其实是属于一种特殊情况，即HashMap中已经存在了key，于是插入操作就不需要了，只要把原来的value覆盖就可以了。
            e = p;//这里为什么要把p赋值给e，而不是直接覆盖原值呢？答案很简单，现在我们只判断了第一个节点，后面还可能出现key相同，所以需要在最后一并处理。
            else if (p instanceof TreeNode)//现在开始了第一种情况，p是红黑树节点，那么肯定插入后仍然是红黑树节点，所以我们直接强制转型p后调用TreeNode.putTreeVal方法，返回的引用赋给e。
                e = ((TreeNode)p).putTreeVal(this, tab, hash, key, value);   //你可能好奇，这里怎么不遍历tree看看有没有key相同的节点呢？其实，putTreeVal内部进行了遍历，存在相同hash时返回被覆盖的TreeNode，否则返回null。
            else {//接下里就是p为链表节点的情形，也就是上述说的另外两类情况：插入后还是链表/插入后转红黑树。另外，上行转型代码也说明了TreeNode是Node的一个子类。
                for (int binCount = 0; ; ++binCount) {//我们需要一个计数器来计算当前链表的元素个数，并遍历链表，binCount就是这个计数器。
                    if ((e = p.next) == null) {//遍历过程中当发现p.next为null时，说明链表到头了，直接在p的后面插入新的链表节点，即把新节点的引用赋给p.next，插入操作就完成了。注意此时e赋给p。
                        p.next = newNode(hash, key, value, null);//最后一个参数为新节点的next，这里传入null，保证了新节点继续为该链表的末端。
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st 　　  //插入成功后，要判断是否需要转换为红黑树，因为插入后链表长度加1，而binCount并不包含新节点，所以判断时要将临界阈值减1。
                            treeifyBin(tab, hash);//当新长度满足转换条件时，调用treeifyBin方法，将该链表转换为红黑树。
                        break;//当然如果不满足转换条件，那么插入数据后结构也无需变动，所有插入操作也到此结束了，break退出即可。
                    }
                    if (e.hash == hash &&//在遍历链表的过程中，我之前提到了，有可能遍历到与插入的key相同的节点，此时只要将这个节点引用赋值给e，最后通过e去把新的value覆盖掉就可以了。
                    ((k = e.key) == key || (key != null && key.equals(k)))) //老样子判断当前遍历的节点的key是否相同。
                    break; //找到了相同key的节点，那么插入操作也不需要了，直接break退出循环进行最后的value覆盖操作。
                    p = e; //在第21行我提到过，e是当前遍历的节点p的下一个节点，p = e 就是依次遍历链表的核心语句。每次循环时p都是下一个node节点。
                }
            }
            if (e != null) { // existing mapping for key　　　　　　　　　　　　　　　　//左边注释为jdk自带注释，说的很明白了，针对已经存在key的情况做处理。
                V oldValue = e.value;//定义oldValue，即原存在的节点e的value值。
                if (!onlyIfAbsent || oldValue == null)//前面提到，onlyIfAbsent表示存在key相同时不做覆盖处理，这里作为判断条件，可以看出当onlyIfAbsent为false或者oldValue为null时，进行覆盖操作。
                e.value = value;//覆盖操作，将原节点e上的value设置为插入的新value。
                afterNodeAccess(e);//这个函数在hashmap中没有任何操作，是个空函数，他存在主要是为了linkedHashMap的一些后续处理工作。
                return oldValue;//这里很有意思，他返回的是被覆盖的oldValue。我们在使用put方法时很少用他的返回值，甚至忘了它的存在，这里我们知道，他返回的是被覆盖的oldValue。
            }
        }
        ++modCount;//收尾工作，值得一提的是，对key相同而覆盖oldValue的情况，在前面已经return，不会执行这里，所以那一类情况不算数据结构变化，并不改变modCount值。
        if (++size > threshold)//同理，覆盖oldValue时显然没有新元素添加，除此之外都新增了一个元素，这里++size并与threshold判断是否达到了扩容标准。
        resize();//当HashMap中存在的node节点大于threshold时，hashmap进行扩容。
        afterNodeInsertion(evict);//这里与前面的afterNodeAccess同理，是用于linkedHashMap的尾部操作，HashMap中并无实际意义。1
        return null; //最终，对于真正进行插入元素的情况，put函数一律返回null。
    }