【Java】HashMap源码分析——常用方法详解

上一篇介绍了HashMap的基本概念，这一篇着重介绍HasHMap中的一些常用方法：
put()
get()
**resize()**

首先介绍resize()这个方法，在我看来这是HashMap中一个非常重要的方法，是用来调整HashMap中table的容量的，在很多操作中多需要重新计算容量。
源码如下：

 final Node<K,V>[] resize() {
         Node<K,V>[] oldTab = table;
         int oldCap = (oldTab == null) ? 0 : oldTab.length;
         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 &&
                      oldCap >= DEFAULT_INITIAL_CAPACITY)
                 newThr = oldThr << 1; // double threshold
         }
         else if (oldThr > 0) // initial capacity was placed in threshold
             newCap = oldThr;
         else {               // zero initial threshold signifies using defaults
             newCap = DEFAULT_INITIAL_CAPACITY;
             newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
         }
         if (newThr == 0) {
             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;
         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 { // preserve order
                         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;
     }

可以看到这段代码非常庞大，其内容可以分为两大部分：
第一部分计算并生成新的哈希表（空表）：

 // 记录原表
 Node<K,V>[] oldTab = table;
 // 得到原来哈希表的总长度，及原来总容量
 int oldCap = (oldTab == null) ? 0 : oldTab.length;
 // 得到原来最佳容量
 int oldThr = threshold;
 // 存放新的总容量、新最佳容量的变量
 int newCap, newThr = 0;
 if (oldCap > 0) {
 // 原来总容量达到或超过HashMap的最大容量，则最佳容量设置为int类型的最大值
 // 且原来容量不变，直接返回，不做后需调整
    if (oldCap >= MAXIMUM_CAPACITY) {
        threshold = Integer.MAX_VALUE;
        return oldTab;
    }
    // 让新的总容量等于原来容量的二倍
    else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
             oldCap >= DEFAULT_INITIAL_CAPACITY)
        // 新的最佳容量也变为原来的二倍
        newThr = oldThr << 1;
 }
 // 原来总容量为0，将新的总容量设置为最佳容量，构造方法出入参数是一个派生的Map的时候，就会使用派生的Map计算出新的最佳容量
 else if (oldThr > 0)
    newCap = oldThr;
 else {
 // 原来总容量和原来最佳容量都没有定义
 // 新的总容量设为默认值16
 // 新的最佳容量=默认负载因子×默认容量=0.75×16=12
    newCap = DEFAULT_INITIAL_CAPACITY;
    newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
 }
 // 判断上述操作后新的最佳容量是否计算，若没有，就利用负载因子和新的总容量计算
 if (newThr == 0) {
    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;

可以看出上述操作仅仅是生成了一张大小合适的哈希表，但表还是空的，后面的操作就是把以前的表中的元素重新排列，移动到当前表中合适的位置！

第二部分将原表元素移动到新表合适的位置：

 // 先判断原表是或否为空
 if (oldTab != null) {
     // 遍历原表（一维数组）中的所有元素，
    for (int j = 0; j < oldCap; ++j) {
            // 记录原来一维数组中下标为j的元素
        Node<K,V> e;
        // 只对有效元素进行操作
        if ((e = oldTab[j]) != null) {
                //将原表中的元素置空
            oldTab[j] = null;
            if (e.next == null)
            // 当前元素没有后继，那么直接把它放在新表中合适位置
            // 其中e.hash & (newCap - 1)在我上一篇博客有介绍
            // 就是以该节点的hash值和新表总容量取余，将余数作为下标
                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等于当前结点的后继结点
                    next = e.next;
                    // 这个位运算实际上判断的是该节点在新表中的位置是否发生改变
                    // 成立则说明没有改变，还是原来表中下标为j的位置
                    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) {
                       // 置空低位的尾的next
                    loTail.next = null;
                    // 将该链表的头结点放入新表下标为j的位置，即原表中的原位置
                    newTab[j] = loHead;
                }
                // 新位置上的链表存在
                if (hiTail != null) {
                       // 置空高位的尾的next
                    hiTail.next = null;
                    // 将该链表的头结点放入新表中下标为j+原表长度的位置
                    newTab[j + oldCap] = hiHead;
                }
            }
        }
    }
 }
 return newTab;

链表的移动如图：

可以看出，这个方法可以使得单个结点重新散列，链表可以拆分成两条，红黑树重新移动，这样使得新的哈希表分布比以前均匀！

下面来分析put方法：
源码如下：

  public V put(K key, V value) {
      return putVal(hash(key), key, value, false, true);
  }

这里我们可以知道其调用了内部的一个putVal方法：
首先第一个参数是通过内部的hash方法（在前一篇博客有介绍过）计算出键对象的hash（int类型）值，再把key和value对象传过去，置于后面两个参数先不着急
先来看下putVal方法是如何说明的：

 /**
      * Implements Map.put and related methods
      *
      * @param hash hash for key
      * @param key the key
      * @param value the value to put
      * // 看以看出，put方法传入的onlyIfAbsent是false，那么就会改变原来已存在的值
      * @param onlyIfAbsent if true, don't change existing value
      * // 这个参数先不考虑，往后慢慢分析
      * @param evict if false, the table is in creation mode.
      * @return previous value, or null if none
      */
     final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict)

该方法内容：

  // 用于保存原表
  Node<K,V>[] tab;
  // 保存下标为hash的结点
  Node<K,V> p;
  // n用来记录表长
  int n, i;
  // 先检查原表是否存在，或者是空表
  if ((tab = table) == null || (n = tab.length) == 0)
       // 如果为空就生成一张大小为16的新表
      n = (tab = resize()).length;
  if ((p = tab[i = (n - 1) & hash]) == null)
       // 如果以该方法形参hash对表长取余，令其作为下标的表中的元素为空，那么就产生一个新结点放在这个位置
      tab[i] = newNode(hash, key, value, null);
  else {
       // 如果该结点不空，那么就会出现两种情况：链表和红黑树
      Node<K,V> e; K k;
      if (p.hash == hash &&
          ((k = p.key) == key || (key != null && key.equals(k))))
          // 如果当前结点的hash并且key值（指针值和内容值）相等，由于onlyIfAbsent是false，那么就会改变这个结点的V值，先用e将其保存起来
          e = p;
      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) {
                   // 如果该节点的next为空
                   // 就需要新增一个结点追加其后
                  p.next = newNode(hash, key, value, null);
                  if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                       // 这里进行红黑树阈值的判断，由于TREEIFY_THRESHOLD默认值是8，binCount是从0开始，那么当链表长度大于等于8的时候，就将该链表转换成红黑树，并且结束循环
                      treeifyBin(tab, hash);
                  break;
              }
              // 这里和之前的判断是一样的
              if (e.hash == hash &&
                  ((k = e.key) == key || (key != null && key.equals(k))))
                  break;
              // 让p = p->next
              p = e;
          }
      }
      // 若e非空，则就是说明原表中存在hash值相等，且key的值或内容相同的结点
      if (e != null) {
          // 将原来的V值保存
          V oldValue = e.value;
          // 判断是否是需要进行覆盖原来V值的操作
          if (!onlyIfAbsent || oldValue == null)
              // 覆盖原来的V值
              e.value = value;
          // 这个方法是一个空的方法，预留的一个操作，不用去管它
          afterNodeAccess(e);
          // 由于在这里面的操作只是替换了原来的V值，并没有改变原来表的大小，直接返回oldValue
          return oldValue;
      }
  }
  // 操作数自增
  ++modCount;
  // 实际大小自增
  // 若其大于最佳容量进行扩容的操作，使其分布均匀
  if (++size > threshold)
      resize();
  // 这也是一个空的方法，预留操作
  afterNodeInsertion(evict);
  // 并没有替换原来的V值，返回null
  return null;

下来是get方法，逻辑相对简单不难分析：

 public V get(Object key) {
     Node<K,V> e;
     return (e = getNode(hash(key), key)) == null ? null : e.value;
 }

同样也是通过hash方法计算出key对象的hash值，调用内部的getNode方法：

 final Node<K,V> getNode(int hash, Object key) {
     // 记录表对象
     Node<K,V>[] tab;
     // 记录第一个结点和当前节点
     Node<K,V> first, e;
     // 记录表长
     int n;
     // 记录K值
     K k;
     // 表非空或者长度大于0才对其操作
     // 并且key的hash值对表长取余为下标，其所对应的哈希表中的结点存在
     if ((tab = table) != null && (n = tab.length) > 0 &&
         (first = tab[(n - 1) & hash]) != null) {
         // 当前结点满足情况，直接返回给该节点
         if (first.hash == hash &&
             ((k = first.key) == key || (key != null && key.equals(k))))
             return first;
         // 后面就分为两种情况：在红黑树或者链表中查找
         if ((e = first.next) != null) {
             // 当前结点是红黑树，进行红黑树的查找
             if (first instanceof 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;
 }

若有不足还请指出！

我在CSDN也放了一篇【Java】HashMap源码分析——常用方法详解