阿里巴巴為什麼讓初始化集合時必須指定大小？

Java中文社群發表於2020-05-29
阿里

哈嘍，親愛的小夥伴們，技術學磊哥，進步沒得說！歡迎來到新一期的效能解讀系列，我是磊哥。

今天給大家帶來的是關於阿里巴巴《Java開發手冊》泰山版（最新）中關於集合初始化時的效能建議。

阿里巴巴《Java開發手冊》第 1 章程式設計規範，第 6 節集合處理的第 17 條規定如下：

【推薦】集合初始化時，指定集合初始值大小。

說明：HashMap 使用 HashMap(int initialCapacity) 初始化，如果暫時無法確定集合大小，那麼指定預設值（16）即可。

正例：initialCapacity = (需要儲存的元素個數 / 負載因子) + 1。注意負載因子（即 loader factor）預設為 0.75，如果暫時無法確定初始值大小，請設定為 16（即預設值）。

反例：HashMap 需要放置 1024 個元素，由於沒有設定容量初始大小，隨著元素不斷增加，容量 7 次被迫擴大，resize 需要重建 hash 表。當放置的集合元素個數達千萬級別時，不斷擴容會嚴重影響效能。

規範解讀

此規範的主要目的完全是出於效能考慮，檢視 HashMap 的原始碼也就可以發現此規範的原因，如果我們能為集合設定合理的大小就可以避免 HashMap 的擴容操作，而 HashMap 的擴容方法 resize 有很多邏輯判斷和業務操作，如果設定了合理的大小就可以避免執行更多的程式碼，因此就可以更大限度的提高集合的執行效率，HashMap 的 resize 原始碼如下：

// 原始碼基於 JDK 8
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;
        }
        // 擴大容量為當前容量的兩倍，但不能超過 MAXIMUM_CAPACITY
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            newThr = oldThr << 1; // double threshold
    }
    // 當前陣列沒有資料，使用初始化的值
    else if (oldThr > 0) // initial capacity was placed in threshold
        newCap = oldThr;
    else {               // zero initial threshold signifies using defaults
        // 如果初始化的值為 0，則使用預設的初始化容量
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    // 如果新的容量等於 0
    if (newThr == 0) {
        float ft = (float)newCap * loadFactor;
        newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                  (int)ft : Integer.MAX_VALUE);
    }
    threshold = newThr; 
    @SuppressWarnings({"rawtypes","unchecked"})
    Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
    // 開始擴容，將新的容量賦值給 table
    table = newTab;
    // 原資料不為空，將原資料複製到新 table 中
    if (oldTab != null) {
        // 根據容量迴圈陣列，複製非空元素到新 table
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            if ((e = oldTab[j]) != null) {
                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
                    // 連結串列複製，JDK 1.8 擴容優化部分
                    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;
                        }
                        // 原索引 + oldCap
                        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;
                    }
                    // 將原索引 + oldCap 放到雜湊桶中
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

效能評測

接下來我們來測試一下設定 size 的效能和不設定 size 的效能差別，我們已知需要插入 1024 個資料，根據預設的負載因子 0.75 和公式 (儲存元素個數/負載因子)+1 得出需要設定的大小為 1367（取整）。

小貼士：公式“(儲存元素個數/負載因子)+1”說明：因為 HashMap 的實際儲存量等於：元素個數*負載因子，為了防止 HashMap 擴容，所以公式必須是“(儲存元素個數/負載因子)+1”才能防止動態擴容。

本文我們依舊使用 Oracle 官方提供的 JMH（Java Microbenchmark Harness，JAVA 微基準測試套件）測試框架，首先現在 pom.xml 中新增 JMH 引用，配置如下：

<!-- https://mvnrepository.com/artifact/org.openjdk.jmh/jmh-core -->
<dependency>
   <groupId>org.openjdk.jmh</groupId>
   <artifactId>jmh-core</artifactId>
   <version>{version}</version>
</dependency>

然後編寫完整的測試程式碼：

import org.openjdk.jmh.annotations.*;
import org.openjdk.jmh.infra.Blackhole;
import org.openjdk.jmh.runner.Runner;
import org.openjdk.jmh.runner.RunnerException;
import org.openjdk.jmh.runner.options.Options;
import org.openjdk.jmh.runner.options.OptionsBuilder;

import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;

@BenchmarkMode(Mode.AverageTime) // 測試完成時間
@OutputTimeUnit(TimeUnit.NANOSECONDS)
@Warmup(iterations = 2, time = 1, timeUnit = TimeUnit.SECONDS) // 預熱 2 輪，每次 1s
@Measurement(iterations = 5, time = 3, timeUnit = TimeUnit.SECONDS) // 測試 5 輪，每次 3s
@Fork(1) // fork 1 個執行緒
@State(Scope.Thread) // 每個測試執行緒一個例項
public class AlibabaHashMapTest {
    public static void main(String[] args) throws RunnerException {
        // 啟動基準測試
        Options opt = new OptionsBuilder()
                .include(AlibabaHashMapTest.class.getSimpleName()) // 要匯入的測試類
                .build();
        new Runner(opt).run(); // 執行測試
    }

    @Benchmark
    public void noSizeTest(Blackhole blackhole) {
        Map map = new HashMap();
        for (int i = 0; i < 1024; i++) {
            map.put(i, i);
        }
        // 為了避免 JIT 忽略未被使用的結果
        blackhole.consume(map);
    }

    @Benchmark
    public void setSizeTest(Blackhole blackhole) {
        Map map = new HashMap(1367);
        for (int i = 0; i < 1024; i++) {
            map.put(i, i);
        }
        // 為了避免 JIT 忽略未被使用的結果
        blackhole.consume(map);
    }
}

測試結果如下：

從上述結果可以看出，設定了大小的 HashMap 的效能約是沒有設定大小的 1.29 倍。

總結

在初始化集合時，如果已知集合的數量，那麼一定要在初始化時設定集合的容量大小，這樣就可以有效的提高集合的效能，但需要注意的是 HashMap 的實際儲存量是“元素個數*負載因子”，而負載因子預設是 0.75，因此在設定大小時，要使用“(儲存元素個數/負載因子)+1”的公式計算出正確的值再進行設定。

相關文章