一、前言

在上一章节我们讲解并用数据验证了，HashMap中的，散列表的实现、扰动函数、负载因子以及扩容拆分等核心知识点以及相应的作用。

除了以上这些知识点外，HashMap还有基本的数据功能；存储、删除、获取、遍历，在这些功能中经常会听到链表、红黑树、之间转换等功能。而红黑树是在jdk1.8引入到HashMap中解决链表过长问题的，简单说当链表长度>=8时，将链表转换位红黑树(当然这里还有一个扩容的知识点，不一定都会树化[MIN_TREEIFY_CAPACITY])。

那么本章节会进行讲解以下知识点；

  1. 数据插入流程和源码分析
  2. 链表树化以及树转链表
  3. 遍历过程中的无序Set的核心知识

🕵注意： 建议阅读上一篇后，再阅读本篇文章《HashMap核心知识，扰动函数、负载因子、扩容链表拆分，深度学习》

二、HashMap源码分析

1. 插入

1.1 疑问点&考题

通过上一章节的学习：《HashMap核心知识，扰动函数、负载因子、扩容链表拆分，深度学习》

大家对于一个散列表数据结构的HashMap往里面插入数据时，基本已经有了一个印象。简单来说就是通过你的Key值取得哈希再计算下标，之后把相应的数据存放到里面。

但再这个过程中会遇到一些问题，比如；

  1. 如果出现哈希值计算的下标碰撞了怎么办？
  2. 如果碰撞了是扩容数组还是把值存成链表结构，让一个节点有多个值存放呢？
  3. 如果存放的数据的链表过长，就失去了散列表的性能了，怎么办呢？
  4. 如果想解决链表过长，什么时候使用树结构呢，使用哪种树呢？

这些疑问点都会在后面的内容中逐步讲解，也可以自己思考一下，如果是你来设计，你会怎么做。

1.2 插入流程和源码分析

HashMap插入数据流程图

第4篇 HashMap数据插入、查找、删除、遍历，源码分析 - 图1

visio原版流程图，可以通过关注公众号：bugstack虫洞栈，进行下载

以上就是HashMap中一个数据插入的整体流程，包括了；计算下标、何时扩容、何时链表转红黑树等，具体如下；

  1. 首先进行哈希值的扰动，获取一个新的哈希值。(key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);

  2. 判断tab是否位空或者长度为0，如果是则进行扩容操作。

    1. if ((tab = table) == null || (n = tab.length) == 0)
    2.  n = (tab = resize()).length;

  3. 根据哈希值计算下标，如果对应小标正好没有存放数据，则直接插入即可否则需要覆盖。tab[i = (n - 1) & hash])

  4. 判断tab[i]是否为树节点，否则向链表中插入数据，是则向树中插入节点。
  5. 如果链表中插入节点的时候，链表长度大于等于8，则需要把链表转换为红黑树。treeifyBin(tab, hash);
  6. 最后所有元素处理完成后，判断是否超过阈值；threshold，超过则扩容。
  7. treeifyBin,是一个链表转树的方法，但不是所有的链表长度为8后都会转成树，还需要判断存放key值的数组桶长度是否小于64 MIN_TREEIFY_CAPACITY。如果小于则需要扩容，扩容后链表上的数据会被拆分散列的相应的桶节点上，也就把链表长度缩短了。

JDK1.8 HashMap的put方法源码如下:

  1. public V put(K key, V value) {
  2.     return putVal(hash(key), key, value, false, true);
  3. }
  5. final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
  6.                boolean evict) {
  7.     Node<K,V>[] tab; Node<K,V> p; int n, i;
  8.     // 初始化桶数组 table，table 被延迟到插入新数据时再进行初始化
  9.     if ((tab = table) == null || (n = tab.length) == 0)
  10.         n = (tab = resize()).length;
  11.     // 如果桶中不包含键值对节点引用，则将新键值对节点的引用存入桶中即可
  12.     if ((p = tab[i = (n - 1) & hash]) == null)
  13.         tab[i] = newNode(hash, key, value, null);
  14.     else {
  15.         Node<K,V> e; K k;
  16.         // 如果键的值以及节点 hash 等于链表中的第一个键值对节点时，则将 e 指向该键值对
  17.         if (p.hash == hash &&
  18.             ((k = p.key) == key || (key != null && key.equals(k))))
  19.             e = p;
  21.         // 如果桶中的引用类型为 TreeNode，则调用红黑树的插入方法
  22.         else if (p instanceof TreeNode)  
  23.             e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
  24.         else {
  25.             // 对链表进行遍历，并统计链表长度
  26.             for (int binCount = 0; ; ++binCount) {
  27.                 // 链表中不包含要插入的键值对节点时，则将该节点接在链表的最后
  28.                 if ((e = p.next) == null) {
  29.                     p.next = newNode(hash, key, value, null);
  30.                     // 如果链表长度大于或等于树化阈值，则进行树化操作
  31.                     if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
  32.                         treeifyBin(tab, hash);
  33.                     break;
  34.                 }
  36.                 // 条件为 true，表示当前链表包含要插入的键值对，终止遍历
  37.                 if (e.hash == hash &&
  38.                     ((k = e.key) == key || (key != null && key.equals(k))))
  39.                     break;
  40.                 p = e;
  41.             }
  42.         }
  44.         // 判断要插入的键值对是否存在 HashMap 中
  45.         if (e != null) { // existing mapping for key
  46.             V oldValue = e.value;
  47.             // onlyIfAbsent 表示是否仅在 oldValue 为 null 的情况下更新键值对的值
  48.             if (!onlyIfAbsent || oldValue == null)
  49.                 e.value = value;
  50.             afterNodeAccess(e);
  51.             return oldValue;
  52.         }
  53.     }
  54.     ++modCount;
  55.     // 键值对数量超过阈值时，则进行扩容
  56.     if (++size > threshold)
  57.         resize();
  58.     afterNodeInsertion(evict);
  59.     return null;
  60. }

1.3 扩容机制

HashMap是基于数组+链表和红黑树实现的，但用于存放key值得的数组桶的长度是固定的，由初始化决定。

那么，随着数据的插入数量增加以及负载因子的作用下，就需要扩容来存放更多的数据。而扩容中有一个非常重要的点，就是jdk1.8中的优化操作，可以不需要再重新计算每一个元素的哈希值，这在上一章节中已经讲到，可以阅读系列专题文章，机制如下图；

第4篇 HashMap数据插入、查找、删除、遍历，源码分析 - 图2

里我们主要看下扩容的代码(注释部分)；

  1. final Node<K,V>[] resize() {
  2.     Node<K,V>[] oldTab = table;
  3.     int oldCap = (oldTab == null) ? 0 : oldTab.length;
  4.     int oldThr = threshold;
  5.     int newCap, newThr = 0;
  6.     // Cap 是 capacity 的缩写，容量。如果容量不为空，则说明已经初始化。
  7.     if (oldCap > 0) {
  8.         // 如果容量达到最大1 << 30则不再扩容
  9.         if (oldCap >= MAXIMUM_CAPACITY) {
  10.             threshold = Integer.MAX_VALUE;
  11.             return oldTab;
  12.         }
  14.         // 按旧容量和阀值的2倍计算新容量和阀值
  15.         else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
  16.                  oldCap >= DEFAULT_INITIAL_CAPACITY)
  17.             newThr = oldThr << 1; // double threshold
  18.     }
  19.     else if (oldThr > 0) // initial capacity was placed in threshold
  21.         // initial capacity was placed in threshold 翻译过来的意思，如下；
  22.         // 初始化时，将 threshold 的值赋值给 newCap，
  23.         // HashMap 使用 threshold 变量暂时保存 initialCapacity 参数的值
  24.         newCap = oldThr;
  25.     else {               // zero initial threshold signifies using defaults
  26.         // 这一部分也是，源代码中也有相应的英文注释
  27.         // 调用无参构造方法时，数组桶数组容量为默认容量 1 << 4; aka 16
  28.         // 阀值；是默认容量与负载因子的乘积，0.75
  29.         newCap = DEFAULT_INITIAL_CAPACITY;
  30.         newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
  31.     }
  33.     // newThr为0，则使用阀值公式计算容量
  34.     if (newThr == 0) {
  35.         float ft = (float)newCap * loadFactor;
  36.         newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY
  37.                   (int)ft : Integer.MAX_VALUE);
  38.     }
  39.     threshold = newThr;
  41.     @SuppressWarnings({"rawtypes","unchecked"})
  42.         // 初始化数组桶，用于存放key
  43.         Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
  44.     table = newTab;
  45.     if (oldTab != null) {
  46.         // 如果旧数组桶，oldCap有值，则遍历将键值映射到新数组桶中
  47.         for (int j = 0; j < oldCap; ++j) {
  48.             Node<K,V> e;
  49.             if ((e = oldTab[j]) != null) {
  50.                 oldTab[j] = null;
  51.                 if (e.next == null)
  52.                     newTab[e.hash & (newCap - 1)] = e;
  53.                 else if (e instanceof TreeNode)
  54.                     // 这里split，是红黑树拆分操作。在重新映射时操作的。
  55.                     ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
  56.                 else { // preserve order
  57.                     Node<K,V> loHead = null, loTail = null;
  58.                     Node<K,V> hiHead = null, hiTail = null;
  59.                     Node<K,V> next;
  60.                     // 这里是链表，如果当前是按照链表存放的，则将链表节点按原顺序进行分组{这里有专门的文章介绍，如何不需要重新计算哈希值进行拆分《HashMap核心知识，扰动函数、负载因子、扩容链表拆分，深度学习》}
  61.                     do {
  62.                         next = e.next;
  63.                         if ((e.hash & oldCap) == 0) {
  64.                             if (loTail == null)
  65.                                 loHead = e;
  66.                             else
  67.                                 loTail.next = e;
  68.                             loTail = e;
  69.                         }
  70.                         else {
  71.                             if (hiTail == null)
  72.                                 hiHead = e;
  73.                             else
  74.                                 hiTail.next = e;
  75.                             hiTail = e;
  76.                         }
  77.                     } while ((e = next) != null);
  79.                     // 将分组后的链表映射到桶中
  80.                     if (loTail != null) {
  81.                         loTail.next = null;
  82.                         newTab[j] = loHead;
  83.                     }
  84.                     if (hiTail != null) {
  85.                         hiTail.next = null;
  86.                         newTab[j + oldCap] = hiHead;
  87.                     }
  88.                 }
  89.             }
  90.         }
  91.     }
  92.     return newTab;
  93. }

以上的代码稍微有些长，但是整体的逻辑还是蛮清晰的，主要包括；

  1. 扩容时计算出新的newCap、newThr，这是两个单词的缩写，一个是Capacity ，另一个是阀Threshold
  2. newCap用于创新的数组桶 new Node[newCap];
  3. 随着扩容后，原来那些因为哈希碰撞，存放成链表和红黑树的元素，都需要进行拆分存放到新的位置中。

1.4 链表树化

HashMap这种散列表的数据结构，最大的性能在于可以O(1)时间复杂度定位到元素，但因为哈希碰撞不得已在一个下标里存放多组数据，那么jdk1.8之前的设计只是采用链表的方式进行存放，如果需要从链表中定位到数据时间复杂度就是O(n)，链表越长性能越差。因为在jdk1.8中把过长的链表也就是8个，优化为自平衡的红黑树结构，以此让定位元素的时间复杂度优化近似于O(logn)，这样来提升元素查找的效率。但也不是完全抛弃链表，因为在元素相对不多的情况下，链表的插入速度更快，所以综合考虑下设定阈值为8才进行红黑树转换操作。

链表转红黑树，如下图；

第4篇 HashMap数据插入、查找、删除、遍历，源码分析 - 图3

以上就是一组链表转换为红黑树的情况，元素包括；40、51、62、73、84、95、150、161 这些是经过实际验证可分配到Idx：12的节点

通过这张图，基本可以有一个链表换行到红黑树的印象，接下来阅读下对应的源码。

链表树化源码

  1. final void treeifyBin(Node<K,V>[] tab, int hash) {
  2.     int n, index; Node<K,V> e;
  3.     // 这块就是我们上面提到的，不一定树化还可能只是扩容。主要桶数组容量是否小于64 MIN_TREEIFY_CAPACITY 
  4.     if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
  5.         resize();
  6.     else if ((e = tab[index = (n - 1) & hash]) != null) {
  7.         // 又是单词缩写；hd = head (头部)，tl = tile (结尾)
  8.         TreeNode<K,V> hd = null, tl = null;
  9.         do {
  10.             // 将普通节点转换为树节点，但此时还不是红黑树，也就是说还不一定平衡
  11.             TreeNode<K,V> p = replacementTreeNode(e, null);
  12.             if (tl == null)
  13.                 hd = p;
  14.             else {
  15.                 p.prev = tl;
  16.                 tl.next = p;
  17.             }
  18.             tl = p;
  19.         } while ((e = e.next) != null);
  20.         if ((tab[index] = hd) != null)
  21.             // 转红黑树操作，这里需要循环比较，染色、旋转。关于红黑树，在下一章节详细讲解
  22.             hd.treeify(tab);
  23.     }
  24. }

这一部分链表树化的操作并不复杂，复杂点在于下一层的红黑树转换上，这部分知识点会在后续章节中专门介绍；

以上源码主要包括的知识点如下；

  1. 链表树化的条件有两点；链表长度大于等于8、桶容量大于64，否则只是扩容，不会树化。
  2. 链表树化的过程中是先由链表转换为树节点，此时的树可能不是一颗平衡树。同时在树转换过程中会记录链表的顺序，tl.next = p，这主要方便后续树转链表和拆分更方便。
  3. 链表转换成树完成后，在进行红黑树的转换。先简单介绍下，红黑树的转换需要染色和旋转，以及比对大小。在比较元素的大小中，有一个比较有意思的方法，tieBreakOrder加时赛，这主要是因为HashMap没有像TreeMap那样本身就有Comparator的实现。

1.5 红黑树转链

在链表转红黑树中我们重点介绍了一句，在转换树的过程中，记录了原有链表的顺序。

那么，这就简单了，红黑树转链表时候，直接把TreeNode转换为Node即可，源码如下；

  1. final Node<K,V> untreeify(HashMap<K,V> map) {
  2.     Node<K,V> hd = null, tl = null;
  3.     // 遍历TreeNode
  4.     for (Node<K,V> q = this; q != null; q = q.next) {
  5.         // TreeNode替换Node
  6.         Node<K,V> p = map.replacementNode(q, null);
  7.         if (tl == null)
  8.             hd = p;
  9.         else
  10.             tl.next = p;
  11.         tl = p;
  12.     }
  13.     return hd;
  14. }
  16. // 替换方法
  17. Node<K,V> replacementNode(Node<K,V> p, Node<K,V> next) {
  18.     return new Node<>(p.hash, p.key, p.value, next);
  19. }

因为记录了链表关系，所以替换过程很容易。所以好的数据结构可以让操作变得更加容易。

2. 查找

第4篇 HashMap数据插入、查找、删除、遍历，源码分析 - 图4

上图就是HashMap查找的一个流程图，还是比较简单的，同时也是高效的。

接下来我们在结合代码，来分析这段流程，如下；

  1. public V get(Object key) {
  2.     Node<K,V> e;
  3.     // 同样需要经过扰动函数计算哈希值
  4.     return (e = getNode(hash(key), key)) == null ? null : e.value;
  5. }
  7. final Node<K,V> getNode(int hash, Object key) {
  8.     Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
  9.     // 判断桶数组的是否为空和长度值
  10.     if ((tab = table) != null && (n = tab.length) > 0 &&
  11.         // 计算下标，哈希值与数组长度-1
  12.         (first = tab[(n - 1) & hash]) != null) {
  13.         if (first.hash == hash && // always check first node
  14.             ((k = first.key) == key || (key != null && key.equals(k))))
  15.             return first;
  16.         if ((e = first.next) != null) {
  17.             // TreeNode 节点直接调用红黑树的查找方法，时间复杂度O(logn)
  18.             if (first instanceof TreeNode)
  19.                 return ((TreeNode<K,V>)first).getTreeNode(hash, key);
  20.             // 如果是链表就依次遍历查找
  21.             do {
  22.                 if (e.hash == hash &&
  23.                     ((k = e.key) == key || (key != null && key.equals(k))))
  24.                     return e;
  25.             } while ((e = e.next) != null);
  26.         }
  27.     }
  28.     return null;
  29. }

以上查找的代码还是比较简单的，主要包括以下知识点；

  1. 扰动函数的使用，获取新的哈希值，这在上一章节已经讲过
  2. 下标的计算，同样也介绍过 tab[(n - 1) & hash])
  3. 确定了桶数组下标位置，接下来就是对红黑树和链表进行查找和遍历操作了

3. 删除

  1.  public V remove(Object key) {
  2.      Node<K,V> e;
  3.      return (e = removeNode(hash(key), key, null, false, true)) == null ?
  4.          null : e.value;
  5.  }
  7. final Node<K,V> removeNode(int hash, Object key, Object value,
  8.                            boolean matchValue, boolean movable) {
  9.     Node<K,V>[] tab; Node<K,V> p; int n, index;
  10.     // 定位桶数组中的下标位置，index = (n - 1) & hash
  11.     if ((tab = table) != null && (n = tab.length) > 0 &&
  12.         (p = tab[index = (n - 1) & hash]) != null) {
  13.         Node<K,V> node = null, e; K k; V v;
  14.         // 如果键的值与链表第一个节点相等，则将 node 指向该节点
  15.         if (p.hash == hash &&
  16.             ((k = p.key) == key || (key != null && key.equals(k))))
  17.             node = p;
  18.         else if ((e = p.next) != null) {
  19.             // 树节点，调用红黑树的查找方法，定位节点。
  20.             if (p instanceof TreeNode)
  21.                 node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
  22.             else {
  23.                 // 遍历链表，找到待删除节点
  24.                 do {
  25.                     if (e.hash == hash &&
  26.                         ((k = e.key) == key ||
  27.                          (key != null && key.equals(k)))) {
  28.                         node = e;
  29.                         break;
  30.                     }
  31.                     p = e;
  32.                 } while ((e = e.next) != null);
  33.             }
  34.         }
  36.         // 删除节点，以及红黑树需要修复，因为删除后会破坏平衡性。链表的删除更加简单。
  37.         if (node != null && (!matchValue || (v = node.value) == value ||
  38.                              (value != null && value.equals(v)))) {
  39.             if (node instanceof TreeNode)
  40.                 ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
  41.             else if (node == p)
  42.                 tab[index] = node.next;
  43.             else
  44.                 p.next = node.next;
  45.             ++modCount;
  46.             --size;
  47.             afterNodeRemoval(node);
  48.             return node;
  49.         }
  50.     }
  51.     return null;
  52. }
  • 删除的操作也比较简单，这里面都没有太多的复杂的逻辑。
  • 另外红黑树的操作因为被包装了，只看使用上也是很容易。

4. 遍历

4.1 问题点

HashMap中的遍历也是非常常用的API方法，包括；

KeySet

  1.  for (String key : map.keySet()) {
  2.      System.out.print(key + " ");
  3.  }

EntrySet

  1.  for (HashMap.Entry entry : map.entrySet()) {
  2.      System.out.print(entry + " ");
  3.  }

从方法上以及日常使用都知道，KeySet是遍历是无序的，但每次使用不同方式遍历包括keys.iterator()，它们遍历的结果是固定的。

那么从实现的角度来看，这些种遍历都是从散列表中的链表和红黑树获取集合值，那么他们有一个什么固定的规律吗？

4.2 用代码测试

测试的场景和前提；

  1. 这里我们要设定一个既有红黑树又有链表结构的数据场景
  2. 为了可以有这样的数据结构，我们最好把HashMap的初始长度设定为64，避免在链表超过8位后扩容，而是直接让其转换为红黑树。
  3. 找到18个元素，分别放在不同节点(这些数据通过程序计算得来)；
    1. 桶数组02节点：24、46、68
    2. 桶数组07节点：29
    3. 桶数组12节点：150、172、194、271、293、370、392、491、590

代码测试

  1. @Test
  2. public void test_Iterator() {
  3.     Map<String, String> map = new HashMap<String, String>(64);
  4.     map.put("24", "Idx：2");
  5.     map.put("46", "Idx：2");
  6.     map.put("68", "Idx：2");
  7.     map.put("29", "Idx：7");
  8.     map.put("150", "Idx：12");
  9.     map.put("172", "Idx：12");
  10.     map.put("194", "Idx：12");
  11.     map.put("271", "Idx：12");
  12.     System.out.println("排序01：");
  13.     for (String key : map.keySet()) {
  14.         System.out.print(key + " ");
  15.     }
  17.     map.put("293", "Idx：12");
  18.     map.put("370", "Idx：12");
  19.     map.put("392", "Idx：12");
  20.     map.put("491", "Idx：12");
  21.     map.put("590", "Idx：12");
  22.     System.out.println("\n\n排序02：");
  23.     for (String key : map.keySet()) {
  24.         System.out.print(key + " ");
  25.     }    
  27.     map.remove("293");
  28.     map.remove("370");
  29.     map.remove("392");
  30.     map.remove("491");
  31.     map.remove("590");
  32.     System.out.println("\n\n排序03：");
  33.     for (String key : map.keySet()) {
  34.         System.out.print(key + " ");
  35.     }
  37. }

这段代码分别测试了三种场景，如下；

  1. 添加元素，在HashMap还是只链表结构时，输出测试结果01
  2. 添加元素，在HashMap转换为红黑树时候，输出测试结果02
  3. 删除元素，在HashMap转换为链表结构时，输出测试结果03

4.3 测试结果分析

  1. 排序01：
  2. 24 46 68 29 150 172 194 271 
  4. 排序02：
  5. 24 46 68 29 271 150 172 194 293 370 392 491 590 
  7. 排序03：
  8. 24 46 68 29 172 271 150 194 
  9. Process finished with exit code 0

从map.keySet()测试结果可以看到，如下信息；

  1. 01情况下，排序定位哈希值下标和链表信息

第4篇 HashMap数据插入、查找、删除、遍历，源码分析 - 图5

  1. 02情况下，因为链表转换为红黑树，树根会移动到数组头部。moveRootToFront()方法

第4篇 HashMap数据插入、查找、删除、遍历，源码分析 - 图6

  1. 03情况下，因为删除了部分元素，红黑树退化成链表。

第4篇 HashMap数据插入、查找、删除、遍历，源码分析 - 图7

三、总结

  • 这一篇API源码以及逻辑与上一篇数据结构中扰动函数、负载因子、散列表实现等，内容的结合，算是把HashMap基本常用技术点，梳理完成了。但知识绝不止于此，这里还有红黑树的相关技术内容，后续会进行详细。
  • 除了HashMap以外还有TreeMap、ConcurrentHashMap等，每一个核心类都有一些相关的核心知识点，每一个都非常值得深入研究。这个烧脑的过程，是学习获得知识的最佳方式。
  • 可能关于HashMap还有一些疏漏的点，也希望阅读的小伙伴可以提出更多的问题，互相学习，共同进步，本文就到这里，感谢您的阅读！