HashMap putVal()方法源码分析

HashMap源码分析

1. putVal方法

 final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
     //传进五个参数
        Node<K,V>[] tab; Node<K,V> p; int n, i;
     //声明了辅助变量
     /**
     初始化或加倍表大小。如果为 null，则根据字段阈值中保留的初始容量目标进行分配。否则，由于我们使用的是 2 次幂扩展，因此每个 bin 中的元素必须保持在同一索引上，或者在新表中以 2 的偏移量移动。
     */
        if ((tab = table) == null || (n = tab.length) == 0)
            //把原先的table表赋给辅助数组tab,并判断原table表是否为null
            //把原先的table表的长度赋给辅助变量n,并判断原table表长度是否为0
            //两种情况有一种为true,就说明table表为新的(空的,刚创建的),进行初始化操作(扩容到16)or进行两倍扩容
            n = (tab = resize()).length;
     		//resize()是判断是否需要扩容的方法
        if ((p = tab[i = (n - 1) & hash]) == null)
            //"(n - 1) & hash"操作,确定新的value该放的下标(索引),并把该下标的Node对象赋给p,然后判断该下标的位置是否为null
       		
            tab[i] = newNode(hash, key, value, null);
     //如果为true,说明首节点为null,就创建一个新的Node对象,并放在该下标的位置
     //当确定的下标里有元素时,进行else里的操作,p(Node对象)在else里有作用,p为确定的下标的原元素
        else {
            Node<K,V> e; K k;
            //声明了两个辅助变量
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                //进入该分支就说明,没有加入成功
                //首先比较p的哈希与要加入的元素的哈希是否相同,相同则为true;
                
                //然后将p的key(键)赋给临时变量k,接着比较p的key(键)与要加入的原元素的key(键)是否相同,相同则为true;
                /*然后比较要加入的原元素的key(键)是否为null,不是null则为true, 
                且 使用equals方法比较p的key(键)与加入的原元素的key(键),比较的结果取决于equals方法比较的是什么,equals方法是否有被重写
                */
                
                /**
                当它们的哈希相同时,它们的key(键)也相同时or 要加入元素的key(键)不为null 且它们用equals方法比较为true时,执行 e = p;
                当它们的哈希不相同时,执行else if里的语句
                */
                
                e = p;
            //把原下标的元素(p)赋给临时变量e
            else if (p instanceof TreeNode)
                //这里看原下标的元素(p)的运行类型是不是TreeNode(红黑树)类型,如果是
                //则按TreeNode(红黑树)的方式将要加入的元素加入table,
                //然后将返回的对象(Node)赋给临时变量e
                //如果不是则执行else里的语句
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                for (int binCount = 0; ; ++binCount) {
                    //这里是个死循环,有两个if判断,满足其中一个就退出死循环
                    //一直在循环,先将确认下标的元素的下一个元素赋给e,然后比较是否为null,如果为null
                    //则将要加入的元素,赋给该位置
                    //接着进行能否树化判断
                    if ((e = p.next) == null) {
                        //依次和链表的每一个元素比较,每一个都不同,则在链表最后加入该元素
                        p.next = newNode(hash, key, value, null);
                        
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
						//这里判断是否满足树化的前置条件,该条链表上达到八个元素则满足树化的前置条件
                            treeifyBin(tab, hash);
                        //treeifyBin方法接着判断是否满足树花的条件,
                        //当table的容量达到64时,则满足后续树化条件,进行树化;否则不进行树化;
                        //然后退出死循环
                        break;
                    }
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        //进入这里说明没有加入成功
                        /*
                        这里比较的是要加入的元素与通过"(n - 1) & hash"计算得到的下标的元素的下一个或下n个元素;
                       当它们的哈希相同时,它们的key(键)也相同时
                       or 要加入元素的key(键)不为null 且它们用equals方法比较为true时,
                       则退出死循环
                        */
                        break;
                    //否则执行 p = e;将通过"(n - 1) & hash"计算得到的下标的元素的下一个或下n个元素 赋给p;
                    
                   //p指向下一节点
                    p = e;
                     //然后进行下一轮循环,直到找到满足退出的条件
                }
            }
            
           //这里的e是原table表里将要被要加入的元素替换的原元素,可能为null
            //如果e为null,则直接替换
            if (e != null) { // existing mapping for key
                //如果e不为null,则说明原table里可能存在与要加入元素key(键)相同的key(键)
                V oldValue = e.value;
                //这里把e的value赋给临时变量oldValue
                
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
                //没有返回null说明添加失败
            }
        }
        ++modCount;
     //判断长度是否达到临界值(临界因子(0.75)*长度),达到临界值就进行扩容
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
     //返回null说明添加成功
    }