Java8 HashMap源碼分析

時間 2019-11-13

標籤 java8 java hashmap 源碼分析欄目 Java 简体版

原文原文鏈接

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

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

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, 又稱散列表). 哈希表是存儲鍵值對的數組, 在查找元素時根據鍵的值計算出鍵值對在數組中的位置, 不須要掃描數組.this

哈希表相似於詞典, 能夠經過詞條快速地找出釋義的位置, 沒必要從頭開始逐個尋找. 哈希表訪問元素的時間複雜度爲O(1), 遠高於普通數組的O(n)或樹狀結構的O(logn).線程

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

若table.length爲16, key1.hashCode()爲1202, key2.hashCode()爲3218. 那麼,key1和key2的哈希值同爲2, 可是table[2]只能放置一個元素因而產生了哈希衝突.code

哈希衝突問題主要從兩方面考慮, 一是儘可能減小哈希衝突的發生, 二是在哈希衝突發生後仍然正常工做.

哈希函數

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;
}