HashMap遍历

1.遍历方法

HashMap 遍历从大的方向来说，可分为以下 4 类：

  1. 迭代器（Iterator）方式遍历；
  2. For Each 方式遍历（加强for循环）；
  3. Lambda 表达式遍历（JDK 1.8+）;
  4. Streams API 遍历（JDK 1.8+）。

但每种类型下又有不同的实现方式，因此具体的遍历方式又可以分为以下 7 种：

  1. 使用迭代器（Iterator）EntrySet 的方式进行遍历；
  2. 使用迭代器（Iterator）KeySet 的方式进行遍历；
  3. 使用 For Each EntrySet 的方式进行遍历；
  4. 使用 For Each KeySet 的方式进行遍历；
  5. 使用 Lambda 表达式的方式进行遍历；
  6. 使用 Streams API 单线程的方式进行遍历；
  7. 使用 Streams API 多线程的方式进行遍历。

接下来我们来看每种遍历方式的具体实现代码。

1.1.迭代器 EntrySet

  1. public class HashMapTest {
  2.     public static void main(String[] args) {
  3.         // 创建并赋值 HashMap
  4.         Map<Integer, String> map = new HashMap();
  5.         map.put(1, "Java");
  6.         map.put(2, "JDK");
  7.         map.put(3, "Spring Framework");
  8.         map.put(4, "MyBatis framework");
  9.         map.put(5, "Java中文社群");
  10.         // 遍历
  11.         Iterator<Map.Entry<Integer, String>> iterator = map.entrySet().iterator();
  12.         while (iterator.hasNext()) {
  13.             Map.Entry<Integer, String> entry = iterator.next();
  14.             System.out.print(entry.getKey());
  15.             System.out.print(entry.getValue());
  16.             // 1 Java 2 JDK 3 Spring Framework 4 MyBatis framework 5 Java中文社群
  17.         }
  18.     }
  19. }

1.2.迭代器 KeySet

  1. public class HashMapTest {
  2.     public static void main(String[] args) {
  3.         // 创建并赋值 HashMap
  4.         Map<Integer, String> map = new HashMap();
  5.         map.put(1, "Java");
  6.         map.put(2, "JDK");
  7.         map.put(3, "Spring Framework");
  8.         map.put(4, "MyBatis framework");
  9.         map.put(5, "Java中文社群");
  10.         // 遍历
  11.         Iterator<Integer> iterator = map.keySet().iterator();
  12.         while (iterator.hasNext()) {
  13.             Integer key = iterator.next();
  14.             System.out.print(key);
  15.             System.out.print(map.get(key));
  16.             // 1 Java 2 JDK 3 Spring Framework 4 MyBatis framework 5 Java中文社群
  17.         }
  18.     }
  19. }

1.3.ForEach EntrySet

  1. public class HashMapTest {
  2.     public static void main(String[] args) {
  3.         // 创建并赋值 HashMap
  4.         Map<Integer, String> map = new HashMap();
  5.         map.put(1, "Java");
  6.         map.put(2, "JDK");
  7.         map.put(3, "Spring Framework");
  8.         map.put(4, "MyBatis framework");
  9.         map.put(5, "Java中文社群");
  10.         // 遍历
  11.         for (Map.Entry<Integer, String> entry : map.entrySet()) {
  12.             System.out.print(entry.getKey());
  13.             System.out.print(entry.getValue());
  14.             // 1 Java 2 JDK 3 Spring Framework 4 MyBatis framework 5 Java中文社群
  15.         }
  16.     }
  17. }

1.4.ForEach KeySet

  1. public class HashMapTest {
  2.     public static void main(String[] args) {
  3.         // 创建并赋值 HashMap
  4.         Map<Integer, String> map = new HashMap();
  5.         map.put(1, "Java");
  6.         map.put(2, "JDK");
  7.         map.put(3, "Spring Framework");
  8.         map.put(4, "MyBatis framework");
  9.         map.put(5, "Java中文社群");
  10.         // 遍历
  11.         for (Integer key : map.keySet()) {
  12.             System.out.print(key);
  13.             System.out.print(map.get(key));
  14.             // 1 Java 2 JDK 3 Spring Framework 4 MyBatis framework 5 Java中文社群
  15.         }
  16.     }
  17. }

1.5.Lambda

  1. public class HashMapTest {
  2.     public static void main(String[] args) {
  3.         // 创建并赋值 HashMap
  4.         Map<Integer, String> map = new HashMap();
  5.         map.put(1, "Java");
  6.         map.put(2, "JDK");
  7.         map.put(3, "Spring Framework");
  8.         map.put(4, "MyBatis framework");
  9.         map.put(5, "Java中文社群");
  10.         // 遍历
  11.         map.forEach((key, value) -> {
  12.             System.out.print(key);
  13.             System.out.print(value);
  14.             // 1 Java 2 JDK 3 Spring Framework 4 MyBatis framework 5 Java中文社群
  15.         });
  16.     }
  17. }

1.6.Streams API 单线程

  1. public class HashMapTest {
  2.     public static void main(String[] args) {
  3.         // 创建并赋值 HashMap
  4.         Map<Integer, String> map = new HashMap();
  5.         map.put(1, "Java");
  6.         map.put(2, "JDK");
  7.         map.put(3, "Spring Framework");
  8.         map.put(4, "MyBatis framework");
  9.         map.put(5, "Java中文社群");
  10.         // 遍历
  11.         map.entrySet().stream().forEach((entry) -> {
  12.             System.out.print(entry.getKey());
  13.             System.out.print(entry.getValue());
  14.             // 1 Java 2 JDK 3 Spring Framework 4 MyBatis framework 5 Java中文社群
  15.         });
  16.     }
  17. }

1.7.Streams API 多线程

  1. public class HashMapTest {
  2.     public static void main(String[] args) {
  3.         // 创建并赋值 HashMap
  4.         Map<Integer, String> map = new HashMap();
  5.         map.put(1, "Java");
  6.         map.put(2, "JDK");
  7.         map.put(3, "Spring Framework");
  8.         map.put(4, "MyBatis framework");
  9.         map.put(5, "Java中文社群");
  10.         // 遍历
  11.         map.entrySet().parallelStream().forEach((entry) -> {
  12.             System.out.print(entry.getKey());
  13.             System.out.print(entry.getValue());
  14.             // 1 Java 2 JDK 3 Spring Framework 4 MyBatis framework 5 Java中文社群
  15.         });
  16.     }
  17. }

2.性能测试

接下来我们使用 Oracle 官方提供的性能测试工具 JMH（Java Microbenchmark Harness，JAVA 微基准测试套件）来测试一下这 7 种循环的性能。

首先，我们先要引入 JMH 框架，在 pom.xml 文件中添加如下配置：

  1. <!-- https://mvnrepository.com/artifact/org.openjdk.jmh/jmh-core -->
  2. <dependency>
  3.     <groupId>org.openjdk.jmh</groupId>
  4.     <artifactId>jmh-core</artifactId>
  5.     <version>1.23</version>
  6. </dependency>

然后编写测试代码，如下所示：

  1. import org.openjdk.jmh.annotations.*;
  2. import org.openjdk.jmh.runner.Runner;
  3. import org.openjdk.jmh.runner.RunnerException;
  4. import org.openjdk.jmh.runner.options.Options;
  5. import org.openjdk.jmh.runner.options.OptionsBuilder;
  7. import java.util.HashMap;
  8. import java.util.Iterator;
  9. import java.util.Map;
  10. import java.util.concurrent.TimeUnit;
  12. @BenchmarkMode(Mode.Throughput) // 测试类型：吞吐量
  13. @OutputTimeUnit(TimeUnit.MILLISECONDS)
  14. @Warmup(iterations = 2, time = 1, timeUnit = TimeUnit.SECONDS) // 预热 2 轮，每次 1s
  15. @Measurement(iterations = 5, time = 3, timeUnit = TimeUnit.SECONDS) // 测试 5 轮，每次 3s
  16. @Fork(1) // fork 1 个线程
  17. @State(Scope.Thread) // 每个测试线程一个实例
  19. public class HashMapCycle {
  21.     static Map<Integer, String> map = new HashMap() {{
  22.         // 添加数据
  23.         for (int i = 0; i < 10; i++) {
  24.             put(i, "val:" + i);
  25.         }
  26.     }};
  28.     public static void main(String[] args) throws RunnerException {
  29.         // 启动基准测试
  30.         Options opt = new OptionsBuilder()
  31.                 .include(HashMapCycle.class.getSimpleName()) // 要导入的测试类
  32.                 .output("/Users/admin/Desktop/jmh-map.log") // 输出测试结果的文件
  33.                 .build();
  34.         new Runner(opt).run(); // 执行测试
  35.     }
  37.     @Benchmark
  38.     public void entrySet() {
  39.         // 遍历
  40.         Iterator<Map.Entry<Integer, String>> iterator = map.entrySet().iterator();
  41.         while (iterator.hasNext()) {
  42.             Map.Entry<Integer, String> entry = iterator.next();
  43.             System.out.println(entry.getKey());
  44.             System.out.println(entry.getValue());
  45.         }
  46.     }
  48.     @Benchmark
  49.     public void keySet() {
  50.         // 遍历
  51.         Iterator<Integer> iterator = map.keySet().iterator();
  52.         while (iterator.hasNext()) {
  53.             Integer key = iterator.next();
  54.             System.out.println(key);
  55.             System.out.println(map.get(key));
  56.         }
  57.     }
  59.     @Benchmark
  60.     public void forEachEntrySet() {
  61.         // 遍历
  62.         for (Map.Entry<Integer, String> entry : map.entrySet()) {
  63.             System.out.println(entry.getKey());
  64.             System.out.println(entry.getValue());
  65.         }
  66.     }
  68.     @Benchmark
  69.     public void forEachKeySet() {
  70.         // 遍历
  71.         for (Integer key : map.keySet()) {
  72.             System.out.println(key);
  73.             System.out.println(map.get(key));
  74.         }
  75.     }
  77.     @Benchmark
  78.     public void lambda() {
  79.         // 遍历
  80.         map.forEach((key, value) -> {
  81.             System.out.println(key);
  82.             System.out.println(value);
  83.         });
  84.     }
  86.     @Benchmark
  87.     public void streamApi() {
  88.         // 单线程遍历
  89.         map.entrySet().stream().forEach((entry) -> {
  90.             System.out.println(entry.getKey());
  91.             System.out.println(entry.getValue());
  92.         });
  93.     }
  95.     @Benchmark
  96.     public void parallelStreamApi() {
  97.         // 多线程遍历
  98.         map.entrySet().parallelStream().forEach((entry) -> {
  99.             System.out.println(entry.getKey());
  100.             System.out.println(entry.getValue());
  101.         });
  102.     }
  103. }

所有被添加了 @Benchmark 注解的方法都会被测试，测试结果如下：

HashMap遍历及删除 - 图1

其中 Score 列表示平均执行时间， ± 符号表示误差。从以上结果可以看出，如果加上后面的误差值的话，可以得出的结论是，除了并行循环的 parallelStream 性能比极高之外（多线程方式性能肯定比较高），其他方式的遍历方法在性能方面几乎没有任何差别。

注：以上结果基于测试环境：JDK 1.8 / Mac mini (2018) / Idea 2020.1

3.性能原理分析

要理解性能测试的结果，我们需要把所有遍历代码通过 javac，编译成字节码来看具体的原因，编译之后我们使用 Idea 打开字节码信息，内容如下：

  1. // Source code recreated from a .class file by IntelliJ IDEA
  2. // (powered by Fernflower decompiler)
  4. package com.example;
  6. import java.util.HashMap;
  7. import java.util.Iterator;
  8. import java.util.Map;
  9. import java.util.Map.Entry;
  11. public class HashMapTest {
  12.     static Map<Integer, String> map = new HashMap() {
  13.         {
  14.             for(int var1 = 0; var1 < 2; ++var1) {
  15.                 this.put(var1, "val:" + var1);
  16.             }
  18.         }
  19.     };
  21.     public HashMapTest() {
  22.     }
  24.     public static void main(String[] var0) {
  25.         entrySet();
  26.         keySet();
  27.         forEachEntrySet();
  28.         forEachKeySet();
  29.         lambda();
  30.         streamApi();
  31.         parallelStreamApi();
  32.     }
  34.     public static void entrySet() {
  35.         Iterator var0 = map.entrySet().iterator();
  37.         while(var0.hasNext()) {
  38.             Entry var1 = (Entry)var0.next();
  39.             System.out.println(var1.getKey());
  40.             System.out.println((String)var1.getValue());
  41.         }
  43.     }
  45.     public static void keySet() {
  46.         Iterator var0 = map.keySet().iterator();
  48.         while(var0.hasNext()) {
  49.             Integer var1 = (Integer)var0.next();
  50.             System.out.println(var1);
  51.             System.out.println((String)map.get(var1));
  52.         }
  54.     }
  56.     public static void forEachEntrySet() {
  57.         Iterator var0 = map.entrySet().iterator();
  59.         while(var0.hasNext()) {
  60.             Entry var1 = (Entry)var0.next();
  61.             System.out.println(var1.getKey());
  62.             System.out.println((String)var1.getValue());
  63.         }
  65.     }
  67.     public static void forEachKeySet() {
  68.         Iterator var0 = map.keySet().iterator();
  70.         while(var0.hasNext()) {
  71.             Integer var1 = (Integer)var0.next();
  72.             System.out.println(var1);
  73.             System.out.println((String)map.get(var1));
  74.         }
  76.     }
  78.     public static void lambda() {
  79.         map.forEach((var0, var1) -> {
  80.             System.out.println(var0);
  81.             System.out.println(var1);
  82.         });
  83.     }
  85.     public static void streamApi() {
  86.         map.entrySet().stream().forEach((var0) -> {
  87.             System.out.println(var0.getKey());
  88.             System.out.println((String)var0.getValue());
  89.         });
  90.     }
  92.     public static void parallelStreamApi() {
  93.         map.entrySet().parallelStream().forEach((var0) -> {
  94.             System.out.println(var0.getKey());
  95.             System.out.println((String)var0.getValue());
  96.         });
  97.     }
  98. }

从结果可以看出，除了 Lambda 和 Streams API 之外，通过迭代器循环和 for 循环的遍历的 EntrySet 最终生成的代码是一样的，他们都是在循环中创建了一个遍历对象 Entry ，如下所示：

  1. public static void entrySet() {
  2.     Iterator var0 = map.entrySet().iterator();
  3.     while(var0.hasNext()) {
  4.         Entry var1 = (Entry)var0.next();
  5.         System.out.println(var1.getKey());
  6.         System.out.println((String)var1.getValue());
  7.     }
  8. }
  9. public static void forEachEntrySet() {
  10.     Iterator var0 = map.entrySet().iterator();
  11.     while(var0.hasNext()) {
  12.         Entry var1 = (Entry)var0.next();
  13.         System.out.println(var1.getKey());
  14.         System.out.println((String)var1.getValue());
  15.     }
  16. }

而通过迭代器和 for 循环遍历的 KeySet 代码也是一样的，如下所示：

  1. public static void keySet() {
  2.     Iterator var0 = map.keySet().iterator();
  3.     while(var0.hasNext()) {
  4.         Integer var1 = (Integer)var0.next();
  5.         System.out.println(var1);
  6.         System.out.println((String)map.get(var1));
  7.     }
  8. } 
  9. public static void forEachKeySet() {
  10.     Iterator var0 = map.keySet().iterator();
  11.     while(var0.hasNext()) {
  12.         Integer var1 = (Integer)var0.next();
  13.         System.out.println(var1);
  14.         System.out.println((String)map.get(var1));
  15.     }
  16. }

可以看出 KeySet 在循环中创建了一个 Integer 的局部变量，并且值是从 map 对象中直接获取的。

所以通过字节码来看，使用 EntrySet 和 KeySet 代码差别不是很大，并不像网上说的那样 KeySet 的性能远不如 EntrySet，因此从性能的角度来说 EntrySet 和 KeySet 几乎是相近的，但从代码的优雅型和可读性来说，还是推荐使用 EntrySet。

4.安全性测试

从上面的性能测试结果和原理分析，我想大家应该选用那种遍历方式，已经心中有数的，而接下来我们就从「安全」的角度入手，来分析那种遍历方式更安全。我们把以上遍历划分为四类进行测试：迭代器方式、For 循环方式、Lambda 方式和 Stream 方式，测试代码如下。

4.1.迭代器方式

  1. Iterator<Map.Entry<Integer, String>> iterator = map.entrySet().iterator();
  2. while (iterator.hasNext()) {
  3.     Map.Entry<Integer, String> entry = iterator.next();
  4.     if (entry.getKey() == 1) {
  5.         // 删除
  6.         System.out.println("del:" + entry.getKey());
  7.         iterator.remove();
  8.     } else {
  9.         System.out.println("show:" + entry.getKey());
  10.     }
  11. }

以上程序的执行结果：

show:0

del:1

show:2

测试结果：迭代器中循环删除数据安全。

4.2.For 循环方式

  1. for (Map.Entry<Integer, String> entry : map.entrySet()) {
  2.     if (entry.getKey() == 1) {
  3.         // 删除
  4.         System.out.println("del:" + entry.getKey());
  5.         map.remove(entry.getKey());
  6.     } else {
  7.         System.out.println("show:" + entry.getKey());
  8.     }
  9. }

以上程序的执行结果：

HashMap遍历及删除 - 图2

测试结果：For 循环中删除数据非安全。

3.Lambda 方式

  1. map.forEach((key, value) -> {
  2.     if (key == 1) {
  3.         System.out.println("del:" + key);
  4.         map.remove(key);
  5.     } else {
  6.         System.out.println("show:" + key);
  7.     }
  8. });

以上程序的执行结果：

HashMap遍历及删除 - 图3测试结果：Lambda 循环中删除数据非安全。

Lambda 删除的正确方式：

// 根据 map 中的 key 去判断删除
map.keySet().removeIf(key -> key == 1);
map.forEach((key, value) -> {
    System.out.println("show:" + key);
});

以上程序的执行结果：

show:0

show:2

从上面的代码可以看出，可以先使用 Lambda 的 removeIf 删除多余的数据，再进行循环是一种正确操作集合的方式。

4.Stream 方式

map.entrySet().stream().forEach((entry) -> {
    if (entry.getKey() == 1) {
        System.out.println("del:" + entry.getKey());
        map.remove(entry.getKey());
    } else {
        System.out.println("show:" + entry.getKey());
    }
});

以上程序的执行结果：

HashMap遍历及删除 - 图4

测试结果：Stream 循环中删除数据非安全。

Stream 循环的正确方式：

map.entrySet().stream().filter(m -> 1 != m.getKey()).forEach((entry) -> {
    if (entry.getKey() == 1) {
        System.out.println("del:" + entry.getKey());
    } else {
        System.out.println("show:" + entry.getKey());
    }
});

以上程序的执行结果：

show:0

show:2

从上面的代码可以看出，可以使用 Stream 中的 filter 过滤掉无用的数据，再进行遍历也是一种安全的操作集合的方式。

小结

我们不能在遍历中使用集合 map.remove() 来删除数据，这是非安全的操作方式，但我们可以使用迭代器的 iterator.remove() 的方法来删除数据，这是安全的删除集合的方式。同样的我们也可以使用 Lambda 中的 removeIf 来提前删除数据，或者是使用 Stream 中的 filter 过滤掉要删除的数据进行循环，这样都是安全的，当然我们也可以在 for 循环前删除数据再遍历也是线程安全的。

总结

本文我们讲了 HashMap 4 大类（迭代器、for、lambda、stream）遍历方式，以及具体的 7 种遍历方法，除了 Stream 的并行循环，其他几种遍历方法的性能差别不大，但从简洁性和优雅性上来看，Lambda 和 Stream 无疑是最适合的遍历方式。除此之外我们还从「安全性」方面测试了 4 大类遍历结果，从安全性来讲，我们应该使用迭代器提供的 iterator.remove() 方法来进行删除，这种方式是安全的在遍历中删除集合的方式，或者使用 Stream 中的 filter 过滤掉要删除的数据再进行循环，也是安全的操作方式。

总体来说，本文提供了 7 种方式肯定也不是最全的，只是想给读者在使用 HashMap 时多一种选择，然而选择那一种形式的写法，要综合：性能、安全性、使用环境的 JDK 版本以及优雅性和可读性等方面来综合考虑。