HashMap 的 7 種遍歷方式與效能分析

DOONDO發表於2022-02-11

前言

隨著 JDK 1.8 Streams API 的釋出,使得 HashMap 擁有了更多的遍歷的方式,但應該選擇那種遍歷方式?反而成了一個問題。

本文先從 HashMap 的遍歷方法講起,然後再從效能、原理以及安全性等方面,來分析 HashMap 各種遍歷方式的優勢與不足,本文主要內容如下圖所示:

HashMap 遍歷

HashMap 遍歷從大的方向來說,可分為以下 4 類

  1. 迭代器(Iterator)方式遍歷;
  2. For Each 方式遍歷;
  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.迭代器 EntrySet

public class HashMapTest {
    public static void main(String[] args) {
        // 建立並賦值 HashMap
        Map<Integer, String> map = new HashMap();
        map.put(1, "Java");
        map.put(2, "JDK");
        map.put(3, "Spring Framework");
        map.put(4, "MyBatis framework");
        map.put(5, "Java中文社群");
        // 遍歷
        Iterator<Map.Entry<Integer, String>> iterator = map.entrySet().iterator();
        while (iterator.hasNext()) {
            Map.Entry<Integer, String> entry = iterator.next();
            System.out.println(entry.getKey());
            System.out.println(entry.getValue());
        }
    }
}

以上程式的執行結果為:

1

Java

2

JDK

3

Spring Framework

4

MyBatis framework

5

Java中文社群

2.迭代器 KeySet

public class HashMapTest {
    public static void main(String[] args) {
        // 建立並賦值 HashMap
        Map<Integer, String> map = new HashMap();
        map.put(1, "Java");
        map.put(2, "JDK");
        map.put(3, "Spring Framework");
        map.put(4, "MyBatis framework");
        map.put(5, "Java中文社群");
        // 遍歷
        Iterator<Integer> iterator = map.keySet().iterator();
        while (iterator.hasNext()) {
            Integer key = iterator.next();
            System.out.println(key);
            System.out.println(map.get(key));
        }
    }
}

以上程式的執行結果為:

1

Java

2

JDK

3

Spring Framework

4

MyBatis framework

5

Java中文社群

3.ForEach EntrySet

public class HashMapTest {
    public static void main(String[] args) {
        // 建立並賦值 HashMap
        Map<Integer, String> map = new HashMap();
        map.put(1, "Java");
        map.put(2, "JDK");
        map.put(3, "Spring Framework");
        map.put(4, "MyBatis framework");
        map.put(5, "Java中文社群");
        // 遍歷
        for (Map.Entry<Integer, String> entry : map.entrySet()) {
            System.out.println(entry.getKey());
            System.out.println(entry.getValue());
        }
    }
}

以上程式的執行結果為:

1

Java

2

JDK

3

Spring Framework

4

MyBatis framework

5

Java中文社群

4.ForEach KeySet

public class HashMapTest {
    public static void main(String[] args) {
        // 建立並賦值 HashMap
        Map<Integer, String> map = new HashMap();
        map.put(1, "Java");
        map.put(2, "JDK");
        map.put(3, "Spring Framework");
        map.put(4, "MyBatis framework");
        map.put(5, "Java中文社群");
        // 遍歷
        for (Integer key : map.keySet()) {
            System.out.println(key);
            System.out.println(map.get(key));
        }
    }
}

以上程式的執行結果為:

1

Java

2

JDK

3

Spring Framework

4

MyBatis framework

5

Java中文社群

5.Lambda

public class HashMapTest {
    public static void main(String[] args) {
        // 建立並賦值 HashMap
        Map<Integer, String> map = new HashMap();
        map.put(1, "Java");
        map.put(2, "JDK");
        map.put(3, "Spring Framework");
        map.put(4, "MyBatis framework");
        map.put(5, "Java中文社群");
        // 遍歷
        map.forEach((key, value) -> {
            System.out.println(key);
            System.out.println(value);
        });
    }
}

以上程式的執行結果為:

1

Java

2

JDK

3

Spring Framework

4

MyBatis framework

5

Java中文社群

6.Streams API 單執行緒

public class HashMapTest {
    public static void main(String[] args) {
        // 建立並賦值 HashMap
        Map<Integer, String> map = new HashMap();
        map.put(1, "Java");
        map.put(2, "JDK");
        map.put(3, "Spring Framework");
        map.put(4, "MyBatis framework");
        map.put(5, "Java中文社群");
        // 遍歷
        map.entrySet().stream().forEach((entry) -> {
            System.out.println(entry.getKey());
            System.out.println(entry.getValue());
        });
    }
}

以上程式的執行結果為:

1

Java

2

JDK

3

Spring Framework

4

MyBatis framework

5

Java中文社群

7.Streams API 多執行緒

public class HashMapTest {
    public static void main(String[] args) {
        // 建立並賦值 HashMap
        Map<Integer, String> map = new HashMap();
        map.put(1, "Java");
        map.put(2, "JDK");
        map.put(3, "Spring Framework");
        map.put(4, "MyBatis framework");
        map.put(5, "Java中文社群");
        // 遍歷
        map.entrySet().parallelStream().forEach((entry) -> {
            System.out.println(entry.getKey());
            System.out.println(entry.getValue());
        });
    }
}

以上程式的執行結果為:

4

MyBatis framework

5

Java中文社群

1

Java

2

JDK

3

Spring Framework

效能測試

接下來我們使用 Oracle 官方提供的效能測試工具 JMH(Java Microbenchmark Harness,JAVA 微基準測試套件)來測試一下這 7 種迴圈的效能。

首先,我們先要引入 JMH 框架,在 pom.xml 檔案中新增如下配置:

<!-- https://mvnrepository.com/artifact/org.openjdk.jmh/jmh-core -->
<dependency>
    <groupId>org.openjdk.jmh</groupId>
    <artifactId>jmh-core</artifactId>
    <version>1.23</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.openjdk.jmh/jmh-generator-annprocess -->
<dependency>
    <groupId>org.openjdk.jmh</groupId>
    <artifactId>jmh-generator-annprocess</artifactId>
    <version>1.23</version>
    <scope>provided</scope>
</dependency>

然後編寫測試程式碼,如下所示:

@BenchmarkMode(Mode.AverageTime) // 測試完成時間
@OutputTimeUnit(TimeUnit.NANOSECONDS)
@Warmup(iterations = 2, time = 1, timeUnit = TimeUnit.SECONDS) // 預熱 2 輪,每次 1s
@Measurement(iterations = 5, time = 1, timeUnit = TimeUnit.SECONDS) // 測試 5 輪,每次 1s
@Fork(1) // fork 1 個執行緒
@State(Scope.Thread) // 每個測試執行緒一個例項
public class HashMapCycleTest {
    static Map<Integer, String> map = new HashMap() {{
        // 新增資料
        for (int i = 0; i < 100; i++) {
            put(i, "val:" + i);
        }
    }};

    public static void main(String[] args) throws RunnerException {
        // 啟動基準測試
        Options opt = new OptionsBuilder()
                .include(HashMapCycle.class.getSimpleName()) // 要匯入的測試類
                .output("/Users/admin/Desktop/jmh-map.log") // 輸出測試結果的檔案
                .build();
        new Runner(opt).run(); // 執行測試
    }

    @Benchmark
    public void entrySet() {
        // 遍歷
        Iterator<Map.Entry<Integer, String>> iterator = map.entrySet().iterator();
        while (iterator.hasNext()) {
            Map.Entry<Integer, String> entry = iterator.next();
            Integer k = entry.getKey();
            String v = entry.getValue();
        }
    }

    @Benchmark
    public void forEachEntrySet() {
        // 遍歷
        for (Map.Entry<Integer, String> entry : map.entrySet()) {
            Integer k = entry.getKey();
            String v = entry.getValue();
        }
    }

    @Benchmark
    public void keySet() {
        // 遍歷
        Iterator<Integer> iterator = map.keySet().iterator();
        while (iterator.hasNext()) {
            Integer k = iterator.next();
            String v = map.get(k);
        }
    }

    @Benchmark
    public void forEachKeySet() {
        // 遍歷
        for (Integer key : map.keySet()) {
            Integer k = key;
            String v = map.get(k);
        }
    }

    @Benchmark
    public void lambda() {
        // 遍歷
        map.forEach((key, value) -> {
            Integer k = key;
            String v = value;
        });
    }

    @Benchmark
    public void streamApi() {
        // 單執行緒遍歷
        map.entrySet().stream().forEach((entry) -> {
            Integer k = entry.getKey();
            String v = entry.getValue();
        });
    }

    public void parallelStreamApi() {
        // 多執行緒遍歷
        map.entrySet().parallelStream().forEach((entry) -> {
            Integer k = entry.getKey();
            String v = entry.getValue();
        });
    }
}

所有被新增了 @Benchmark 註解的方法都會被測試,因為 parallelStream 為多執行緒版本效能一定是最好的,所以就不參與測試了,其他 6 個方法的測試結果如下:

其中 Units 為 ns/op 意思是執行完成時間(單位為納秒),而 Score 列為平均執行時間, ± 符號表示誤差。從以上結果可以看出,兩個 entrySet 的效能相近,並且執行速度最快,接下來是 stream ,然後是兩個 keySet,效能最差的是 KeySet

注:以上結果基於測試環境:JDK 1.8 / Mac mini (2018) / Idea 2020.1

結論

從以上結果可以看出 entrySet 的效能比 keySet 的效能高出了一倍之多,因此我們應該儘量使用 entrySet 來實現 Map 集合的遍歷

位元組碼分析

要理解以上的測試結果,我們需要把所有遍歷程式碼通過 javac 編譯成位元組碼來看具體的原因。

編譯後,我們使用 Idea 開啟位元組碼,內容如下:

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package com.example;

import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;

public class HashMapTest {
    static Map<Integer, String> map = new HashMap() {
        {
            for(int var1 = 0; var1 < 2; ++var1) {
                this.put(var1, "val:" + var1);
            }

        }
    };

    public HashMapTest() {
    }

    public static void main(String[] var0) {
        entrySet();
        keySet();
        forEachEntrySet();
        forEachKeySet();
        lambda();
        streamApi();
        parallelStreamApi();
    }

    public static void entrySet() {
        Iterator var0 = map.entrySet().iterator();

        while(var0.hasNext()) {
            Entry var1 = (Entry)var0.next();
            System.out.println(var1.getKey());
            System.out.println((String)var1.getValue());
        }

    }

    public static void keySet() {
        Iterator var0 = map.keySet().iterator();

        while(var0.hasNext()) {
            Integer var1 = (Integer)var0.next();
            System.out.println(var1);
            System.out.println((String)map.get(var1));
        }

    }

    public static void forEachEntrySet() {
        Iterator var0 = map.entrySet().iterator();

        while(var0.hasNext()) {
            Entry var1 = (Entry)var0.next();
            System.out.println(var1.getKey());
            System.out.println((String)var1.getValue());
        }

    }

    public static void forEachKeySet() {
        Iterator var0 = map.keySet().iterator();

        while(var0.hasNext()) {
            Integer var1 = (Integer)var0.next();
            System.out.println(var1);
            System.out.println((String)map.get(var1));
        }

    }

    public static void lambda() {
        map.forEach((var0, var1) -> {
            System.out.println(var0);
            System.out.println(var1);
        });
    }

    public static void streamApi() {
        map.entrySet().stream().forEach((var0) -> {
            System.out.println(var0.getKey());
            System.out.println((String)var0.getValue());
        });
    }

    public static void parallelStreamApi() {
        map.entrySet().parallelStream().forEach((var0) -> {
            System.out.println(var0.getKey());
            System.out.println((String)var0.getValue());
        });
    }
}

從結果可以看出,除了 Lambda 和 Streams API 之外,通過迭代器迴圈和 for 迴圈的遍歷的 EntrySet 最終生成的程式碼是一樣的,他們都是在迴圈中建立了一個遍歷物件 Entry ,程式碼如下:

public static void entrySet() {
    Iterator var0 = map.entrySet().iterator();
    while(var0.hasNext()) {
        Entry var1 = (Entry)var0.next();
        System.out.println(var1.getKey());
        System.out.println((String)var1.getValue());
    }
}
public static void forEachEntrySet() {
    Iterator var0 = map.entrySet().iterator();
    while(var0.hasNext()) {
        Entry var1 = (Entry)var0.next();
        System.out.println(var1.getKey());
        System.out.println((String)var1.getValue());
    }
}

KeySet 的程式碼也是類似的,如下所示:

public static void keySet() {
    Iterator var0 = map.keySet().iterator();
    while(var0.hasNext()) {
        Integer var1 = (Integer)var0.next();
        System.out.println(var1);
        System.out.println((String)map.get(var1));
    }
} 
public static void forEachKeySet() {
    Iterator var0 = map.keySet().iterator();
    while(var0.hasNext()) {
        Integer var1 = (Integer)var0.next();
        System.out.println(var1);
        System.out.println((String)map.get(var1));
    }
}

所以我們在使用迭代器或是 for 迴圈 EntrySet 時,他們的效能都是相同的,因為他們最終生成的位元組碼基本都是一樣的;同理 KeySet 的兩種遍歷方式也是類似的。

效能分析

EntrySet 之所以比 KeySet 的效能高是因為,KeySet 在迴圈時使用了 map.get(key),而 map.get(key) 相當於又遍歷了一遍 Map 集合去查詢 key 所對應的值。為什麼要用“又”這個詞?那是因為在使用迭代器或者 for 迴圈時,其實已經遍歷了一遍 Map 集合了,因此再使用 map.get(key) 查詢時,相當於遍歷了兩遍

EntrySet 只遍歷了一遍 Map 集合,之後通過程式碼“Entry<Integer, String> entry = iterator.next()”把物件的 keyvalue 值都放入到了 Entry 物件中,因此再獲取 keyvalue 值時就無需再遍歷 Map 集合,只需要從 Entry 物件中取值就可以了。

所以,EntrySet 的效能比 KeySet 的效能高出了一倍,因為 KeySet 相當於迴圈了兩遍 Map 集合,而 EntrySet 只迴圈了一遍

安全性測試

從上面的效能測試結果和原理分析,我想大家應該選用那種遍歷方式,已經心中有數的,而接下來我們就從「安全」的角度入手,來分析那種遍歷方式更安全。

我們把以上遍歷劃分為四類進行測試:迭代器方式、For 迴圈方式、Lambda 方式和 Stream 方式,測試程式碼如下。

1.迭代器方式

Iterator<Map.Entry<Integer, String>> iterator = map.entrySet().iterator();
while (iterator.hasNext()) {
    Map.Entry<Integer, String> entry = iterator.next();
    if (entry.getKey() == 1) {
        // 刪除
        System.out.println("del:" + entry.getKey());
        iterator.remove();
    } else {
        System.out.println("show:" + entry.getKey());
    }
}

以上程式的執行結果:

show:0

del:1

show:2

測試結果:迭代器中迴圈刪除資料安全

2.For 迴圈方式

for (Map.Entry<Integer, String> entry : map.entrySet()) {
    if (entry.getKey() == 1) {
        // 刪除
        System.out.println("del:" + entry.getKey());
        map.remove(entry.getKey());
    } else {
        System.out.println("show:" + entry.getKey());
    }
}

以上程式的執行結果:

測試結果:For 迴圈中刪除資料非安全

3.Lambda 方式

map.forEach((key, value) -> {
    if (key == 1) {
        System.out.println("del:" + key);
        map.remove(key);
    } else {
        System.out.println("show:" + key);
    }
});

以上程式的執行結果:

測試結果: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());
    }
});

以上程式的執行結果:

測試結果: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 種遍歷方法,綜合效能和安全性來看,我們應該儘量使用迭代器(Iterator)來遍歷 EntrySet 的遍歷方式來操作 Map 集合,這樣就會既安全又高效了。

相關文章