Java8 HashMap源碼分析

java.util.HashMap是最常用的java容器類之一, 它是一個線程不安全的容器. 本文對JDK1.8.0中的HashMap實現源碼進行分析.

HashMap使用位運算巧妙的進行散列並使用鏈地址法處理沖突. 自JDK1.8后, 若表中某個位置元素數超過閾值 則會將其自動轉換為紅黑樹來提高檢索效率.

HashMap中的迭代器同樣采用fail-fast機制, 即若迭代過程中容器發生結構性改變, 則會終止迭代.

HashMap主要有三個視圖接口keySet(), values(), entrySet(). 它們都是基於迭代器實現的, 並不實際存儲數據.

哈希表

自JDK1.8.0開始HashMap使用靜態內部類Node來存儲鍵值對結構, 不再使用Map.Entry:

static class Node<K,V> implements Map.Entry<K,V> {
    final int hash;
    final K key;
    V value;
    Node<K,V> next;

    Node(int hash, K key, V value, Node<K,V> next) {...}

    public final K getKey()        { return key; }
    public final V getValue()      { return value; }
    public final String toString() { return key + "=" + value; }

    public final int hashCode() { return Objects.hashCode(key) ^ Objects.hashCode(value); }

    public final V setValue(V newValue) {...}

    public final boolean equals(Object o) {...}
}

注意Node.next使得Node可以形成單向鏈表結構. 再來看一下HashMap中的主要字段:

transient Node<K,V>[] table;
transient int size;

HashMap的底層數據結構是存儲在table域中的哈希表(Hash Table, 又稱散列表). 哈希表是存儲鍵值對的數組, 在查找元素時根據鍵的值計算出鍵值對在數組中的位置, 不需要掃描數組.

哈希表類似於詞典, 可以通過詞條快速地找出釋義的位置, 不必從頭開始逐個尋找. 哈希表訪問元素的時間復雜度為O(1), 遠高於普通數組的O(n)或樹狀結構的O(logn).

最簡單的哈希函數自然是key.hashCode() % table.length, 這就引出了哈希表固有的哈希沖突問題.

若table.length為16, key1.hashCode()為1202, key2.hashCode()為3218. 那么,key1和key2的哈希值同為2, 但是table[2]只能放置一個元素於是產生了哈希沖突.

哈希沖突問題主要從兩方面考慮, 一是盡量減少哈希沖突的發生, 二是在哈希沖突發生后仍然正常工作.

哈希函數

HashMap根據Node.key計算出Node在table數組中的位置, 但是並沒有采用上文提及最簡單的哈希函數:

static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

hash函數的代碼非常簡練, 我們稍微改寫一下:

static final int hash(Object key) {
    if(key == null) {
      return 0;
    } else {
      int h = key.hashCode();
      return h ^ (h >>> 16);
    }
}

關鍵的位運算h ^ (h >>> 16), 將32位整數h邏輯右移16位后與原值進行異或操作:

h = 0xf0f00f0f: 
1111 0000 1111 0000 0000 1111 0000 1111   
h >>> 16 = 0x0000f0f0:
0000 0000 0000 0000 1111 0000 1111 0000  
h ^ (h >>> 16) = 0xf0f0ffff
1111 0000 1111 0000 1111 1111 1111 0000

HashMap中Node在table數組中的實際位置為(n - 1) & hash. n為當前table.length, HashMap的擴容機制保證n為2的整數次冪, 因此(n - 1) & hash == hash % n, 取n=16示例:

n - 1 = 15
0000 0000 1111
hash = 2562
1010 0000 0010
(n - 1) & hash = 2
0000 0000 0010

由於n一般較小, 當n < 65535時高16位為0. 若HashMap采用key.hashCode() % n來決定鍵值對的位置, 則hashCode()的高16位對結果產生影響較小.

高16位很可能不參與運算意味着產生哈希沖突的可能性增大, 因此HashMap先讓高16位與低16位進行異或計算, 減少了哈希沖突的可能性.

鏈地址法

在實踐中無論使用什么哈希函數仍然存在沖突的可能性, 因此必須設計合適的機制在發生沖突后仍然能夠正常工作. 常用的方法有開放地址法和鏈地址法.

使用開放地址法的哈希表每個位置只能放一個元素. 當發生哈希沖突時, 按照某種方法繼續探測哈希表中的其他存儲單元，直到找到空位置為止.

典型的如線性再散列: H = (e.hashCode + n) % table.length, 其中n為再散列的次數, 即發生第1次沖突時需要再散列時n = 1.

開放地址法的缺點在於再散列占據了哈希表中另一個位置, 增加了后續操作中發生哈希沖突的可能性.

HashMap采用了另一種沖突解決方案 - 鏈地址法. 即哈希表中每個位置是一個鏈表, 允許放置多個元素. 發生哈希沖突時, 新元素只需添加到鏈表尾即可.

注意到Node.next域可以讓Node連接為一個單鏈表, 即可使用鏈地址法解決哈希沖突.

若鏈表長度過長仍會造成查詢效率降低, 在JDK1.8中的HashMap實現中若某個位置鏈表長度達到閾值TREEIFY_THRESHOLD = 8則會將鏈表變形為紅黑樹. 當刪除元素使紅黑樹中元素數低於UNTREEIFY_THRESHOLD = 6時會變回鏈表.

本文將在添加元素一節中詳細介紹鏈地址法的實現.

構造器

與ArrayList中的構造器類似, HashMap的構造器只是計算並寫入參數, 當第一次添加元素時才會實際分配存儲空間:

public HashMap(int initialCapacity, float loadFactor) {
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " +
                                           initialCapacity);
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " +
                                           loadFactor);
    this.loadFactor = loadFactor;
    this.threshold = tableSizeFor(initialCapacity);
}

public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}

三個構造器主要是設置initialCapacity和loadFactor參數. initialCapcity是table的初始大小; 當元素數達到threshold時, HashMap會執行擴容.

loadFactor是影響threshold的參數:threshold = table.length * loadFactor. loadFactor默認為0.75, 這是在空間利用率和執行效率之間比較平衡的取值.

int tableSizeFor(cap)方法的返回值是大於cap的最小的2的整數冪. 注意到構造器只是設置了threshold, 保證在初次擴容時達到initialCapacity並沒有實際分配存儲空間.

添加元素

首先閱讀添加單個鍵值對的put方法:

public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    // resize方法用於檢查空間足夠和擴容
    // 構造器只指定了參數並沒有實際分配空間, 此處調用resize的目的是分配初始空間
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    // 若沒有發生哈希沖突, 直接添加一個Node對象
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    else {
        Node<K,V> e; K k;
        // 若鍵相同, 則對值進行更新
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        // 若該位置已經存在一個紅黑樹節點, 則將新元素添加到樹中
        else if (p instanceof TreeNode)
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {
            // 若該位置存在一個鏈表, 則先查找鏈表中是否存在相同鍵
            // 若存在相同鍵則更新值
            // 若不存在相同鍵則添加節點
            for (int binCount = 0; ; ++binCount) {
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    // 若添加后達到閾值, 則將鏈表轉換為紅黑樹
                    if (binCount >= TREEIFY_THRESHOLD - 1) 
                        treeifyBin(tab, hash);
                    break;
                }
                // 發現相同鍵
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        // 存在相同鍵, 更新值
        if (e != null) { 
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;
    // 添加元素后再次檢查是否需要擴容
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

然后閱讀進行擴容的resize方法, HashMap的擴容並不是簡單地創建一個更大的table並把原來的元素復制過去.

因為table.length發生了變化, 所以哈希地址hash(key) % table.length也會隨之變化, 因此需要重新計算哈希地址. 除了保證正確索引外, 重新計算哈希值也可以將一個鏈表分散為多個較短的鏈表, 提高索引效率.

resize()的擴容策略為2倍擴容, 因為原大小為2的整數次冪, 擴容后仍然保持該性質使基於位運算的哈希函數不會失效.

容量變為2倍使哈希地址增加了1位, 原來哈希地址相同的元素將會根據新增位的0-1取值被分散到兩個兩個地址中.

如當容量為16時, 5 % 16, 21 % 16得到的哈希地址均為5, 容量加倍后5 % 32 = 5; 21 % 32 = 21. 注意到5的二進制表示00101與21的二進制表示10101僅有最高位不同.

計算最高位的取值非常簡單, 若e.hashCode < oldCapacity則最高位取0, 否則最高位取1. 因為 oldCapacity是2的整數冪(二進制形式為1000...), 所以可以用e.hashCode & oldCapacity = 0代替e.hashCode < oldCapacity.

HashMap的實現采用了上述位運算策略將哈希表中的鏈表一分為二, 而避免重新計算哈希位置的開銷.

final Node<K,V>[] resize() {
    Node<K,V>[] oldTab = table;
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    int oldThr = threshold;
    int newCap, newThr = 0;
    // 計算新的容量, 默認為原容量的2倍
    if (oldCap > 0) {
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            newThr = oldThr << 1; // double threshold
    }
    // 指定初始容量的構造器並沒有實際分配緩沖區, 而是將大小寫入threshold域
    // 根據構造器寫入的參數分配初始空間
    else if (oldThr > 0) 
        newCap = oldThr;
    else {
        // 沒有將初始容量寫入threshold則按默認值分配
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    // 確保newThr被正確計算 
    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 = newTab;
    if (oldTab != null) {
        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 { 
                    // 處理鏈表, 
                    Node<K,V> loHead = null, loTail = null; // low
                    Node<K,V> hiHead = null, hiTail = null; // high
                    Node<K,V> next;
                    do {
                        next = e.next;
                        // 若新哈希值最高位為0, 則添加到lo鏈表中
                        if ((e.hash & oldCap) == 0) {
                            if (loTail == null)
                                loHead = e;
                            else
                                loTail.next = e;
                            loTail = e;
                        }
                        // 若新哈希值最高位為1, 則添加到hi鏈表中
                        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;
                    }
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

批量添加元素的putAll(map)方法通過map.entrySet獲得要添加的元素, 然后調用putVal方法逐個添加元素.

查找元素

在了解HashMap的數據結構和添加元素策略之后, 查找元素的實現也不難理解:

public V get(Object key) {
    Node<K,V> e;
    return (e = getNode(hash(key), key)) == null ? null : e.value;
}

final Node<K,V> getNode(int hash, Object key) {
    Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
    // 確定哈希表非空, 且目標位置非空
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (first = tab[(n - 1) & hash]) != null) {
        // 首先檢查第一個元素是否為目標
        if (first.hash == hash && 
            ((k = first.key) == key || (key != null && key.equals(k))))
            return first;
        if ((e = first.next) != null) {
            // 若是紅黑樹則搜索樹
            if (first instanceof TreeNode)
                return ((TreeNode<K,V>)first).getTreeNode(hash, key);
            // 否則搜索鏈表
            do {
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    return e;
            } while ((e = e.next) != null);
        }
    }
    return null;
}

刪除元素

刪除元素同樣考慮了單節點, 鏈表和樹三種情況:

public V remove(Object key) {
    Node<K,V> e;
    return (e = removeNode(hash(key), key, null, false, true)) == null ?
        null : e.value;
}

final Node<K,V> removeNode(int hash, Object key, Object value,
                           boolean matchValue, boolean movable) {
    Node<K,V>[] tab; Node<K,V> p; int n, index;
    // 確定哈希表非空, 且目標位置非空
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (p = tab[index = (n - 1) & hash]) != null) {
        Node<K,V> node = null, e; K k; V v;
        // 若目標位置的第一個節點即為要刪除的節點
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            node = p;
        else if ((e = p.next) != null) {
            // 在紅黑樹中尋找要刪除的節點
            if (p instanceof TreeNode)
                node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
            else {
                // 在鏈表中尋找要刪除的節點
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key ||
                         (key != null && key.equals(k)))) {
                        node = e;
                        break;
                    }
                    p = e;
                } while ((e = e.next) != null);
            }
        }
        if (node != null && (!matchValue || (v = node.value) == value ||
                             (value != null && value.equals(v)))) {
            // 刪除樹節點
            if (node instanceof TreeNode)
                ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
            // 刪除單個節點
            else if (node == p)
                tab[index] = node.next;
            // 刪除鏈表中的節點
            else
                p.next = node.next;
            ++modCount;
            --size;
            afterNodeRemoval(node);
            return node;
        }
    }
    return null;
}