02 HashMap1.8 源码深入剖析

JDK 1.8 的 HashMap 的数据结构如下图所示，当链表节点较少时仍然是以链表存在，当链表节点较多时(大于8)会转为红黑树。

Center.png

1 存储结构

1. 链表节点

static class Node<K,V> implements Map.Entry<K,V> {
  final int hash;
  final K key;
  V value;
  Node<K,V> next;

  Node(int hash, K key, V value, Node<K,V> next) {
    this.hash = hash;
    this.key = key;
    this.value = value;
    this.next = next;
  }
  //...
}

2. 红黑树节点

/**
* 红黑树的节点里包含红黑树的属性信息(parent，left，right，red)，也包含双向链表的信息(prev，next)。
*/
static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {
  TreeNode<K,V> parent;  // red-black tree links
  TreeNode<K,V> left;
  TreeNode<K,V> right;
  TreeNode<K,V> prev;    // needed to unlink next upon deletion
  boolean red;
  TreeNode(int hash, K key, V val, Node<K,V> next) {
    super(hash, key, val, next);
  }
  //...
}

2 构造方法

/**
* 在默认构造方法中，与1.7不同，1.8版本只将加载因子赋值
*/
public HashMap() {
  this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}

3 put方法

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA54Of54Gr57yg6L-H5a6i,size_20,color_FFFFFF,t_70,g_se,x_16.jpeg

1. put方法

/**
* 该方法实际调用putVal方法，将k-v插入。
*/
public V put(K key, V value) {
  return putVal(hash(key), key, value, false, true);
}

2. hash方法

/**
* 1.8版本中的hash计算方法比1.7版本中简单不少，减少了很多异或运算的逻辑。
* 异或运算可以增加数据在map数组中的散列性。但由于1.8版本引入新的数据结构红黑树可以
* 一定程度上解决查询检索的效率问题(红黑树是平衡树可以提高hashmap的检索效率) 。
* 故猜测这是1.8版本的hash运算不需要过于复杂的原因
*/
static final int hash(Object key) {
  int h;
  // key 为 null 时，默认会存储到数组下标为 0 的位置
  return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

3. putval方法

/**
 * 承接hashmap主要的插入逻辑
 */
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
  Node<K,V>[] tab; Node<K,V> p; int n, i;
  // 如果当前数组为空需要通过 resize() 方法初始化数组，默认数组大小 16
  if ((tab = table) == null || (n = tab.length) == 0)
    n = (tab = resize()).length;
  // 如果插入的位置为 null，可直接插入，让当前 tab 指针指向这个新节点
  if ((p = tab[i = (n - 1) & hash]) == null)
    //如果没有hash碰撞则直接插入元素
    tab[i] = newNode(hash, key, value, null);
  // 向链表或红黑树追加数据逻辑
  else {
    Node<K,V> e; K k;
    // 如果和 tab指向的数据相同则新值替换旧值
    if (p.hash == hash &&
        ((k = p.key) == key || (key != null && key.equals(k))))
      e = p;
    // 如果插入的位置为红黑树，走向红黑树插入数据的逻辑，插入后需要对红黑树进行平衡操作
    else if (p instanceof TreeNode)
      e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
    // 走插入链表的逻辑
    else {
      // 循环遍历链表，binCount 记录链表中节点个数
      for (int binCount = 0; ; ++binCount) {
        // 找到插入的位置
        if ((e = p.next) == null) {
          p.next = newNode(hash, key, value, null);
          // 如果满足当前链表存在 8 个节点，加上新节点 9 个节点的条件，则准备变为红黑树(treeifyBin方法中会进一步验证当前hashmap的数组长度是否超过64，没超过的话不会变为红黑树，而是走数组扩容的逻辑)
          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;
      }
    }
    // 找到相同元素后，返回旧数据，根据参数条件看是否修改hashmap中的位置数据
    if (e != null) { // existing mapping for key
      V oldValue = e.value;
      if (!onlyIfAbsent || oldValue == null)
        e.value = value;
      afterNodeAccess(e);
      return oldValue;
    }
  }
  // 修改次数增加，快速失败
  ++modCount;
  // 数组元素个数超过阈值，扩容
  if (++size > threshold)
    resize();
  afterNodeInsertion(evict);
  return null;
}

• 注意，1.8版本的HashMap同样有并发安全的问题

if ((p = tab[i = (n - 1) & hash]) == null){
  //如果没有hash碰撞则直接插入元素
  tab[i] = newNode(hash, key, value, null);
}

说明：这是jdk1.8中HashMap中put操作的主函数， 注意如果没有hash碰撞则会直接插入元素。如果线程A和线程B同时进行put操作，刚好这两条不同的数据hash值一样，并且该位置数据为null，就会产生并发安全问题，造成后一个线程将前一个线程插入的数据覆盖。

4. resize方法

/**
 * 初始化或加倍表的大小。 如果为空，则按照与字段阈值中持有的初始容量目标一致。
 * 否则，因为我们使用的是2次方扩展，所以每个bin的元素必须保持在相同的索引上，
 * 或者移动到新表中以2的幂数偏移。
 */
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
  }
  // 如果旧数组的容量为0，而临界值存在，就将该临界值作为新数组的容量
  else if (oldThr > 0) // initial capacity was placed in threshold
    newCap = oldThr;
  else {               // zero initial threshold signifies using defaults
    // 初始化新数组的容量为默认容量16
    newCap = DEFAULT_INITIAL_CAPACITY;
    // 新数组的临界值为16*0.75=12
    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;
  // 新建一个table数组，大小是newCap
  @SuppressWarnings({"rawtypes","unchecked"})
  Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
  // 赋值给全局的table变量，如果是初始化数组则已完成数组初始化，结束逻辑
  table = newTab;
  // 如果是扩容操作，我们需要把旧数组的数据移动到新数组中去
  if (oldTab != null) {
    // 遍历旧数组的每一个桶的位置，因为可能是链表或者红黑树的结构，所以需要循环遍历 
    for (int j = 0; j < oldCap; ++j) {
      Node<K,V> e;
      if ((e = oldTab[j]) != null) {
        // 应该是方便GC回收
        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;
}

链表迁移过程：

• 链表迁移前

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA54Of54Gr57yg6L-H5a6i,size_20,color_FFFFFF,t_70,g_se,x_16.png

• 链表迁移中

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA54Of54Gr57yg6L-H5a6i,size_20,color_FFFFFF,t_70,g_se,x_16-20220831203440301.png

• 链表迁移后

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA54Of54Gr57yg6L-H5a6i,size_20,color_FFFFFF,t_70,g_se,x_16-20220831203517863.png

5. treeifyBin方法

/**
*   当链表的长度达到8个时，需要考虑对链表进行树化，treeifyBin 方法提供树化的具体流程
*/
final void treeifyBin(Node<K,V>[] tab, int hash) {
  int n, index; Node<K,V> e;
  // 如果数组为空或者数组的长度没有达到树化阈值64，则进行扩容操作
  if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
    resize();
  // 进行树化操作
  else if ((e = tab[index = (n - 1) & hash]) != null) {
    TreeNode<K,V> hd = null, tl = null;
    do {
      // 循环将链表中的 Node 节点变为 TreeNode 节点
      TreeNode<K,V> p = replacementTreeNode(e, null);
      // 构建双向链表，将节点串联起来，方便之后进行树root节点移动到首个位置的操作
      if (tl == null)
        hd = p;
      else {
        p.prev = tl;
        tl.next = p;
      }
      tl = p;
    } while ((e = e.next) != null);
    if ((tab[index] = hd) != null)
      // 调用头节点的 treeify 方法进行树化
      hd.treeify(tab);
  }
}

6. treeify 方法

/**
*   treeify 方法会从头至尾遍历双向链表的各个节点完成红黑树的构建逻辑
*/
final void treeify(Node<K,V>[] tab) {
  TreeNode<K,V> root = null;
  // 从自己开始循环遍历双向链表的节点
  for (TreeNode<K,V> x = this, next; x != null; x = next) {
    // 下一个节点
    next = (TreeNode<K,V>)x.next;
    // 构建树节点的属性
    x.left = x.right = null;
    // 如果是第一个节点，将它变为树root节点，root节点为黑色，并且没有父亲节点
    if (root == null) {
      x.parent = null;
      x.red = false;
      root = x;
    }
    // 向红黑树插入节点逻辑
    else {
      K k = x.key;
      int h = x.hash;
      Class<?> kc = null;
      // 从 root 节点开始遍历插入位置
      for (TreeNode<K,V> p = root;;) {
        int dir, ph;
        K pk = p.key;
        // 如果待插入节点的hash比当前节点小，则向左插入
        if ((ph = p.hash) > h)
          dir = -1;
        // 如果待插入节点的hash比当前节点大，则向右插入
        else if (ph < h)
          dir = 1;
        // 如果当前 key 对象实现了 Comparable 接口，则调用这个用户自定义的规则比较
        else if ((kc == null &&
                  (kc = comparableClassFor(k)) == null) ||
                 (dir = compareComparables(kc, k, pk)) == 0)
          dir = tieBreakOrder(k, pk);
                // 记录父节点
        TreeNode<K,V> xp = p;
        // 根据大小，决定向左还是向右遍历
        if ((p = (dir <= 0) ? p.left : p.right) == null) {
          // 给当前节点赋值父节点
          x.parent = xp;
          // 给父节点赋值左右孩子节点
          if (dir <= 0)
            xp.left = x;
          else
            xp.right = x;
          // 对红黑树进行平衡操作(具体查看红黑树如何平衡的相关博客)
          root = balanceInsertion(root, x);
          break;
        }
      }
    }
  }
  // 将红黑树的root节点放到tab指向的第一个节点
  moveRootToFront(tab, root);
}

7. moveRootToFront 方法

/**
*   moveRootToFront 方法会根据双向链表将红黑树的root节点前后数据相连，自己放到开始的位置，并设置next指针指向当前第一个位置的元素
*/
static <K,V> void moveRootToFront(Node<K,V>[] tab, TreeNode<K,V> root) {
  int n;
  if (root != null && tab != null && (n = tab.length) > 0) {
    // 再计算一次插入的下标
    int index = (n - 1) & root.hash;
    // 记录当前的第一个节点
    TreeNode<K,V> first = (TreeNode<K,V>)tab[index];
    // 如果当前的第一个节点不是红黑树的root节点，就需要进行移动的操作
    if (root != first) {
      Node<K,V> rn;
      tab[index] = root;
      // 记录 root 的上一个节点
      TreeNode<K,V> rp = root.prev;
      // root上一个节点与root下一个节点相连
      if ((rn = root.next) != null)
        ((TreeNode<K,V>)rn).prev = rp;
      if (rp != null)
        rp.next = rn;
      // root节点与第一个节点相连
      if (first != null)
        first.prev = root;
      root.next = first;
      root.prev = null;
    }
    assert checkInvariants(root);
  }
}