疫苗：Java HashMap的死循环

jopen 12年前

在淘宝内网里看到同事发了贴说了一个 CPU 被 100% 的线上故障，并且这个事发生了很多次，原因是在 Java 语言在并发情况下使用 HashMap 造成 Race Condition，从而导致死循环。这个事情我4、5 年前也经历过，本来觉得没什么好写的，因为 Java 的 HashMap 是非线程安全的，所以在并发下必然出现问题。但是，我发现近几年，很多人都经历过这个事（在网上查“HashMap Infinite Loop”可以看到很多人都在说这个事）所以，觉得这个是个普遍问题，需要写篇疫苗文章说一下这个事，并且给大家看看一个完美的“Race Condition”是怎么形成的。

问题的症状

从前我们的 Java 代码因为一些原因使用了 HashMap 这个东西，但是当时的程序是单线程的，一切都没有问题。后来，我们的程序性能有问题，所以需要变成多线程的，于是，变成多线程后到了线上，发现程序经常占了 100% 的 CPU，查看堆栈，你会发现程序都 Hang 在了 HashMap.get ()这个方法上了，重启程序后问题消失。但是过段时间又会来。而且，这个问题在测试环境里可能很难重现。

我们简单的看一下我们自己的代码，我们就知道 HashMap 被多个线程操作。而 Java 的文档说 HashMap 是非线程安全的，应该用 ConcurrentHashMap。

但是在这里我们可以来研究一下原因。

Hash 表数据结构

我需要简单地说一下 HashMap 这个经典的数据结构。

HashMap 通常会用一个指针数组（假设为 table[]）来做分散所有的 key，当一个 key 被加入时，会通过 Hash 算法通过 key 算出这个数组的下标i，然后就把这个插到 table[i]中，如果有两个不同的 key 被算在了同一个i，那么就叫冲突，又叫碰撞，这样会在 table[i]上形成一个链表。

我们知道，如果 table[]的尺寸很小，比如只有 2 个，如果要放进 10 个 keys 的话，那么碰撞非常频繁，于是一个O(1) 的查找算法，就变成了链表遍历，性能变成了O(n)，这是 Hash 表的缺陷（可参看《Hash Collision DoS 问题》）。

所以，Hash 表的尺寸和容量非常的重要。一般来说，Hash 表这个容器当有数据要插入时，都会检查容量有没有超过设定的 thredhold，如果超过，需要增大 Hash 表的尺寸，但是这样一来，整个 Hash 表里的无素都需要被重算一遍。这叫 rehash，这个成本相当的大。

相信大家对这个基础知识已经很熟悉了。

HashMap 的 rehash 源代码

下面，我们来看一下 Java 的 HashMap 的源代码。

Put 一个 Key,Value 对到 Hash 表中：

 public V put (K key, V value)  {      ......      //算 Hash 值 int hash = hash (key.hashCode ());      int i = indexFor (hash, table.length);      //如果该 key 已被插入，则替换掉旧的 value （链接操作） for (Entry<K,V> e = table[i]; e != null; e = e.next) {          Object k;          if (e.hash == hash && ((k = e.key) == key || key.equals (k))) {              V oldValue = e.value;              e.value = value;              e.recordAccess (this);              return oldValue;          }      }      modCount++;      //该 key 不存在，需要增加一个结点     addEntry (hash, key, value, i);      return null;  }

检查容量是否超标

 void addEntry (int hash, K key, V value, int bucketIndex)  {      Entry<K,V> e = table[bucketIndex];      table[bucketIndex] = new Entry<K,V>(hash, key, value, e);      //查看当前的 size 是否超过了我们设定的阈值 threshold，如果超过，需要 resize if (size++ >= threshold)          resize (2 * table.length);  }

新建一个更大尺寸的 hash 表，然后把数据从老的 Hash 表中迁移到新的 Hash 表中。

 void resize (int newCapacity)  {      Entry[] oldTable = table;      int oldCapacity = oldTable.length;      ......      //创建一个新的 Hash Table Entry[] newTable = new Entry[newCapacity];      //将 Old Hash Table 上的数据迁移到 New Hash Table 上     transfer (newTable);      table = newTable;      threshold = (int)(newCapacity * loadFactor);  }

迁移的源代码，注意高亮处：

 void transfer (Entry[] newTable)  {      Entry[] src = table;      int newCapacity = newTable.length;      //下面这段代码的意思是：      //  从 OldTable 里摘一个元素出来，然后放到 NewTable 中 for (int j = 0; j < src.length; j++) {          Entry<K,V> e = src[j];          if (e != null) {              src[j] = null;              do {                  Entry<K,V> next = e.next;                  int i = indexFor (e.hash, newCapacity);                  e.next = newTable[i];                  newTable[i] = e;                  e = next;              } while (e != null);          }      }  }

好了，这个代码算是比较正常的。而且没有什么问题。

正常的 ReHash 的过程

画了个图做了个演示。

我假设了我们的 hash 算法就是简单的用 key mod 一下表的大小（也就是数组的长度）。
最上面的是 old hash 表，其中的 Hash 表的 size=2, 所以 key = 3, 7, 5，在 mod 2 以后都冲突在 table[1]这里了。
接下来的三个步骤是 Hash 表 resize 成4，然后所有的重新 rehash 的过程

疫苗：Java HashMap的死循环

并发下的 Rehash

1）假设我们有两个线程。我用红色和浅蓝色标注了一下。

我们再回头看一下我们的 transfer 代码中的这个细节：

do {      Entry<K,V> next = e.next; // <--假设线程一执行到这里就被调度挂起了 int i = indexFor (e.hash, newCapacity);      e.next = newTable[i];      newTable[i] = e;      e = next;  } while (e != null);

而我们的线程二执行完成了。于是我们有下面的这个样子。

疫苗：Java HashMap的死循环