HashMap 源码解析-中章

    /**
     *  指定节点 key,value，向 hashMap 中插入节点
     */
　  public V put(K key, V value) {
    　 /**
        *  注意待插入节点　hash 值的计算，调用了　hash(key) 函数,实际调用 putVal（）进行节点的插入
        */
       return putVal(hash(key), key, value, false, true);
    }
　
   /**
    *   key 的 hash　值的计算是通过hashCode()的高16位异或低16位实现的：
    *   (h = k.hashCode()) ^ (h >>> 16)，
    *   主要是从速度、功效、质量来考虑的，这么做可以在数组table的length比较小的时候，
    *    也能保证考虑到高低Bit都参与到Hash的计算中，同时不会有太大的开销
    */
    static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

　public void putAll(Map<? extends K, ? extends V> m) {
        putMapEntries(m, true);
  }
　
　/**
   *  把Map<? extends K, ? extends V> m 中的元素插入到　hashMap 中,
   *  若 evict 为 false,代表是在创建 hashMap 时调用了这个函数，例如利用上述构造函数３创建 hashMap;
   *  若 evict　为true,代表是在创建　hashMap 后才调用这个函数，例如上述的　putAll 函数。
   */
　final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        int s = m.size();
        if (s > 0) {
            //如果是在创建 hashMap 时调用的这个函数则 table 一定为空
            if (table == null) { 
　　　　         //根据待插入的map 的 size 计算要创建的　hashMap 的容量。
                float ft = ((float)s / loadFactor) + 1.0F;
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);
　　　　         //把要创建的　hashMap 的容量存在　threshold　中
                if (t > threshold)
                    threshold = tableSizeFor(t);
            }
　　　       //判断待插入的　map 的 size,若　size 大于　threshold，则先进行　扩容resize()
            else if (s > threshold)
                resize();
            for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
                K key = e.getKey();
                V value = e.getValue();
                //实际也是调用　putVal　函数进行元素的插入
                putVal(hash(key), key, value, false, evict);
            }
        }
    }
   
   /**
    *  若 evict 为 false,代表是在创建 hashMap 时调用了这个函数，例如利用上述构造函数３创建 hashMap;
    *  若 evict　为true,代表是在创建　hashMap 后才调用这个函数，例如上述的　putAll 函数。
    *  onlyIfAbsent- true （不覆盖原来的value） false（覆盖原来的value） 
    */
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        /**
         *  根据 hash 值确定节点在数组中的插入位置，若此位置没有元素则进行插入
         *  注意确定插入位置所用的计算方法为　(n - 1) & hash,
         *  由于　n 一定是２的幂次，这个操作相当于　hash % n 
         */    
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {//说明待插入位置存在元素
            Node<K,V> e; K k;
　　　 　　　　//比较原来元素与待插入元素的　hash 值和　key 值
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
　　　 　　　 //若原来元素是红黑树节点，调用红黑树的插入方法:putTreeVal
            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);
　　　　　　　            //若链表上节点超过TREEIFY_THRESHOLD - 1，将链表变为红黑树
                        if (binCount >= TREEIFY_THRESHOLD - 1)
                            //将链表节点转为红黑树节点
                            treeifyBin(tab, hash);
                        break;
                    }
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            if (e != null) { // 待插入元素在　hashMap 中已存在
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                //LinkedHashMap中被覆盖的afterNodeAccess方法，用来保持有序性
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        //LinkedHashMap中被覆盖的afterNodeInsertion方法，用来回调移除最早放入Map的对象
        afterNodeInsertion(evict);
        return null;
    }


    /**
     * 将链表节点转为红黑树节点
     */
    final void treeifyBin(Node<K,V>[] tab, int hash) {
        int n, index; Node<K,V> e;
        // 1.如果table为空或者table的长度小于64, 调用resize方法进行扩容
        if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
            resize();
        // 2.根据hash值计算索引值，将该索引位置的节点赋值给e，从e开始遍历该索引位置的链表
        else if ((e = tab[index = (n - 1) & hash]) != null) {
            TreeNode<K,V> hd = null, tl = null;
            do {
                // 3.将链表节点转红黑树节点
                TreeNode<K,V> p = replacementTreeNode(e, null);
                // 4.如果是第一次遍历，将头节点赋值给hd
                if (tl == null)  // tl为空代表为第一次循环
                    hd = p;
                else {
                    // 5.如果不是第一次遍历，则处理当前节点的prev属性和上一个节点的next属性
                    p.prev = tl;    // 当前节点的prev属性设为上一个节点
                    tl.next = p;    // 上一个节点的next属性设置为当前节点
                }
                // 6.将p节点赋值给tl，用于在下一次循环中作为上一个节点进行一些链表的关联操作（p.prev = tl 和 tl.next = p）
                tl = p;
            } while ((e = e.next) != null);
            // 7.将table该索引位置赋值为新转的TreeNode的头节点，如果该节点不为空，则以以头节点(hd)为根节点, 构建红黑树
            if ((tab[index] = hd) != null)
                hd.treeify(tab);
        }
    }
    

/**
 * 红黑树的put操作，红黑树插入会同时维护原来的链表属性, 即原来的next属性
 */
final TreeNode<K,V> putTreeVal(HashMap<K,V> map, Node<K,V>[] tab,
                               int h, K k, V v) {
    Class<?> kc = null;
    boolean searched = false;
    // 1.查找根节点, 索引位置的头节点并不一定为红黑树的根节点
    TreeNode<K,V> root = (parent != null) ? root() : this;
    // 2.将根节点赋值给p节点，开始进行查找
    for (TreeNode<K,V> p = root;;) {
        int dir, ph; K pk;
        // 3.如果传入的hash值小于p节点的hash值，将dir赋值为-1，代表向p的左边查找树
        if ((ph = p.hash) > h)
            dir = -1;
        // 4.如果传入的hash值大于p节点的hash值， 将dir赋值为1，代表向p的右边查找树
        else if (ph < h)
            dir = 1;
        // 5.如果传入的hash值和key值等于p节点的hash值和key值, 则p节点即为目标节点, 返回p节点
        else if ((pk = p.key) == k || (k != null && k.equals(pk)))
            return p;
        // 6.如果k所属的类没有实现Comparable接口 或者 k和p节点的key相等
        else if ((kc == null &&
                  (kc = comparableClassFor(k)) == null) ||
                 (dir = compareComparables(kc, k, pk)) == 0) {
            // 6.1 第一次符合条件, 从p节点的左节点和右节点分别调用find方法进行查找, 如果查找到目标节点则返回
            if (!searched) {
                TreeNode<K,V> q, ch;
                searched = true;
                if (((ch = p.left) != null &&
                     (q = ch.find(h, k, kc)) != null) ||
                    ((ch = p.right) != null &&
                     (q = ch.find(h, k, kc)) != null))
                    return q;
            }
            // 6.2 否则使用定义的一套规则来比较k和p节点的key的大小, 用来决定向左还是向右查找
            dir = tieBreakOrder(k, pk); // dir<0则代表k<pk，则向p左边查找；反之亦然
        }

        TreeNode<K,V> xp = p;   // xp赋值为x的父节点,中间变量,用于下面给x的父节点赋值
        // 7.dir<=0则向p左边查找,否则向p右边查找,如果为null,则代表该位置即为x的目标位置
        if ((p = (dir <= 0) ? p.left : p.right) == null) {
            // 走进来代表已经找到x的位置，只需将x放到该位置即可
            Node<K,V> xpn = xp.next;    // xp的next节点
            // 8.创建新的节点, 其中x的next节点为xpn, 即将x节点插入xp与xpn之间
            TreeNode<K,V> x = map.newTreeNode(h, k, v, xpn);
            // 9.调整x、xp、xpn之间的属性关系
            if (dir <= 0)   // 如果时dir <= 0, 则代表x节点为xp的左节点
                xp.left = x;
            else        // 如果时dir> 0, 则代表x节点为xp的右节点
                xp.right = x;
            xp.next = x;    // 将xp的next节点设置为x
            x.parent = x.prev = xp; // 将x的parent和prev节点设置为xp
            // 如果xpn不为空,则将xpn的prev节点设置为x节点,与上文的x节点的next节点对应
            if (xpn != null)
                ((TreeNode<K,V>)xpn).prev = x;
            // 10.进行红黑树的插入平衡调整
            moveRootToFront(tab, balanceInsertion(root, x));
            return null;
        }
    }
}

// 用于不可比较或者hashCode相同时进行比较的方法, 只是一个一致的插入规则，用来维护重定位的等价性。定义一套规则用于极端情况下比较两个参数的大小。
static int tieBreakOrder(Object a, Object b) {  
    int d;
    if (a == null || b == null ||
        (d = a.getClass().getName().
         compareTo(b.getClass().getName())) == 0)
        d = (System.identityHashCode(a) <= System.identityHashCode(b) ?
             -1 : 1);
    return d;
}

public V get(Object key) {
         Node<K,V> e;
 　　    //实际上是根据输入节点的 hash 值和 key 值利用getNode 方法进行查找
         return (e = getNode(hash(key), key)) == null ? null : e.value;
     }
 　
 　final Node<K,V> getNode(int hash, Object key) {
         Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
         if ((tab = table) != null && (n = tab.length) > 0 &&
             (first = tab[(n - 1) & hash]) != null) {
             if (first.hash == hash && // always check first node
                 ((k = first.key) == key || (key != null && key.equals(k))))
                 return first;
             if ((e = first.next) != null) {
                 if (first instanceof TreeNode)
 　　　　　　　　　　　　//若定位到的节点是　TreeNode 节点，则在树中进行查找
                     return ((TreeNode<K,V>)first).getTreeNode(hash, key);
                 do {//否则在链表中进行查找
                     if (e.hash == hash &&
                         ((k = e.key) == key || (key != null && key.equals(k))))
                         return e;
                 } while ((e = e.next) != null);
             }
         }
         return null;
     }

final TreeNode<K,V> getTreeNode(int h, Object k) {
 　　　　　　　　//从根节点开始，调用 find 方法进行查找
             return ((parent != null) ? root() : this).find(h, k, null);
         }
 　
         final TreeNode<K,V> find(int h, Object k, Class<?> kc) {
            TreeNode<K,V> p = this;
              do {
                 int ph, dir; K pk;
                 TreeNode<K,V> pl = p.left, pr = p.right, q;
 　　　　　　　　　//首先进行hash 值的比较，若不同令当前节点变为它的左孩子或者右孩子
                 if ((ph = p.hash) > h)
                     p = pl;
                 else if (ph < h)
                     p = pr;
 　　　　　　　　　//hash 值相同，进行 key　值的比较 
                 else if ((pk = p.key) == k || (k != null && k.equals(pk)))
                     return p;
                 else if (pl == null)
                     p = pr;
                 else if (pr == null)
                     p = pl;
 　　　　　　　　　//执行到这儿，意味着hash 值相同，key 值不同 
    　　　　　　　　//若k 是可比较的并且k.compareTo(pk) 返回结果不为０可进入下面elseif   
                 else if ((kc != null ||
                           (kc = comparableClassFor(k)) != null) &&
                          (dir = compareComparables(kc, k, pk)) != 0)
                     p = (dir < 0) ? pl : pr;
                 /*若 k 是不可比较的　或者　k.compareTo(pk) 返回结果为０则在整棵树中进行查找，先找右子树，右子树没有再找左子树*/
                 else if ((q = pr.find(h, k, kc)) != null)
                     return q;
                 else
                     p = pl;
             } while (p != null);
             return null;
         }