源碼分析之 HashMap

概念

HashMap是Java Collections Framework中Map集合的一種實現。HashMap提供了一種簡單實用的數據存儲和讀取方式。Map接口不一樣於List接口，屬於集合框架的另外一條支線，Map提供了鍵值對K-V數據存儲模型，底層則是經過Hash表存儲。node

本文分析基於JDK1.8。數組

類結構

HashMap實現了Map接口，Map接口設置一系列操做Map集合的方法，如：put、get、remove...等方法，而HashMap也針對此有其自身對應的實現。markdown

HashMap繼承AbstractMap類。AbstractMap類對於Map接口作了基礎的實現，實現了containsKey、containsValue...等方法。數據結構

類成員

構造函數

HashMap提供四種構造函數。最爲基礎是以下這種：app

HashMap(int initialCapacity, float loadFactor)

public HashMap(int initialCapacity, float loadFactor) {

        ...        

        this.loadFactor = loadFactor;
        this.threshold = tableSizeFor(initialCapacity);
    }複製代碼

HashMap(int initialCapacity, float loadFactor)是最基礎的構造函數。該構造函數提供兩個參數initialCapacity(初始大小)、loadFactor(加載因子)。框架

initialCapacity默認值是16 (1 << 4),最大值是 1073 741 824(1 << 30)，且大小必須是小於最大值的2的冪次方；
loadFactor默認值是0.75，做用是擴容時使用；

初始化的過程當中將傳入的參數loadFactor賦值給this.loadFactor，而後調用tableSizeFor(initialCapacity)方法將處理的結果值賦值給this.threshold;函數

threshold是HashMap判斷size是否須要擴容的閾值。這裏調用tableSizeFor(initialCapacity)來設置threshold;性能

tableSizeFor有啥用？

先拋出答案：tableSizeFor方法保證函數返回值是大於等於給定參數initialCapacity最小的2的冪次方的數值。this

如何實現？spa

static final int tableSizeFor(int cap) {
        int n = cap - 1;
        n |= n >>> 1;
        n |= n >>> 2;
        n |= n >>> 4;
        n |= n >>> 8;
        n |= n >>> 16;
        return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
    }複製代碼

能夠看出該方法是一系列的二進制位操做。先說明 |=的做用：a |= b 等同於 a = a|b。逐行分析tableSizeFor方法：

int n = cap - 1
- 給定的cap減1，是爲了不參數cap原本就是2的冪次方，這樣一來，通過後續的未操做的，cap將會變成2 * cap,是不符合咱們預期的。
n |= n >>> 1
- n >>> 1，n無符號右移1位，即n二進制最高位的1右移一位；
- n | (n >>> 1)，致使的結果是n二進制的高2位值爲1;
  
  目前n的高1~2位均爲1。
n |= n >>> 2
- n繼續無符號右移2位。
- n | (n >>> 2)，致使n二進制表示高3~4位通過運算值均爲1；
  
  目前n的高1~4位均爲1。
n |= n >>> 4
- n繼續無符號右移4位。
- n | (n >>> 4)，致使n二進制表示高5~8位通過運算值均爲1；
  
  目前n的高1~8位均爲1。
n |= n >>> 8
- n繼續無符號右移8位。
- n | (n >>> 8)，致使n二進制表示高9~16位通過運算值均爲1；
  
  目前n的高1~16位均爲1。
n |= n >>> 16
- n繼續無符號右移16位。
- n | (n >>> 16)，致使n二進制表示高17~32位通過運算值均爲1；
  
  目前n的高1~32位均爲1。

能夠看出，不管給定cap(cap < MAXIMUM_CAPACITY )的值是多少，通過以上運算，其值的二進制全部位都會是1。再將其加1，這時候這個值必定是2的冪次方。固然若是通過運算值大於MAXIMUM_CAPACITY，直接選用MAXIMUM_CAPACITY。

這裏能夠舉個栗子，假設給定的cap的值爲20。

int n = cap - 1; —> n = 19(二進制表示：0001 0011)
n |= n >>> 1;

n             ->  0001 0011
    n >>> 1       ->  0000 1001
    n |= n >>> 1  ->  0001 1011複製代碼

n |= n >>> 2;

n             ->  0001 1011
    n >>> 2       ->  0000 1101
    n |= n >>> 2  ->  0001 1111複製代碼

此時n全部位均爲1，後續的位操做均再也不改變n的值。

...

n + 1        ->  0010 0000 (32)複製代碼

最終，tableSizeFor(20)的結果爲32(2^5)。

至此tableSizeFor如何保證cap爲2的冪次方已經顯而易見了。那麼問題來了，爲何cap要保持爲2的冪次方？

爲何cap要保持爲2的冪次方？

cap要保持爲2的冪次方主要緣由是HashMap中數據存儲有關。

在JDK1.8中，HashMap中key的Hash值由Hash(key)方法（後面會詳細分析）計算得來。

HashMap中存儲數據table的index是由key的Hash值決定的。在HashMap存儲數據的時候，咱們指望數據可以均勻分佈，以免哈希衝突。天然而然咱們就會想到去用%取餘的操做來實現咱們這一構想。

這裏要了解到一個知識：取餘(%)操做中若是除數是2的冪次方則等同於與其除數減一的與(&)操做。

這也就解釋了爲啥必定要求cap要爲2的冪次方。再來看看table的index的計算規則：

index = e.hash & (newCap - 1) 

 等同於：

 index = e.hash % newCap複製代碼

採用二進制位操做&，相對於%，可以提升運算效率，這就是要求cap的值被要求爲2冪次方的緣由。

Node 類

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) {
            this.hash = hash;
            this.key = key;
            this.value = value;
            this.next = 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) {
            V oldValue = value;
            value = newValue;
            return oldValue;
        }

        public final boolean equals(Object o) {
            if (o == this)
                return true;
            if (o instanceof Map.Entry) {
                Map.Entry<?,?> e = (Map.Entry<?,?>)o;
                if (Objects.equals(key, e.getKey()) &&
                    Objects.equals(value, e.getValue()))
                    return true;
            }
            return false;
        }
    }複製代碼

Node<K,V> 類是HashMap中的靜態內部類，實現Map.Entry<K,V>接口。定義了key鍵、value值、next節點，也就是說元素之間構成了單向鏈表。

Node[] table

Node<K,V>[] table是HashMap底層存儲的數據結構，是一個Node數組。上面得知Node類爲元素維護了一個單向鏈表。

至此，HashMap存儲的數據結構也就很清晰了：維護了一個數組，每一個數組又維護了一個單向鏈表。之因此這麼設計，考慮到遇到哈希衝突的時候，同index的value值就用單向鏈表來維護。

hash(K,V) 方法

HashMap中table的index是由Key的哈希值決定的。HashMap並無直接使用key的hashcode()，而是通過以下的運算：

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

而上面咱們提到index的運算規則是e.hash & (newCap - 1)。因爲newCap是2的冪次方，那麼newCap - 1的高位應該所有爲0。若是e.hash值只用自身的hashcode的話，那麼index只會和e.hash低位作&操做。這樣一來，index的值就只有低位參與運算，高位毫無存在感，從而會帶來哈希衝突的風險。因此在計算key的哈希值的時候，用其自身hashcode值與其低16位作異或操做。這也就讓高位參與到index的計算中來了，即下降了哈希衝突的風險又不會帶來太大的性能問題。

put(K,V) 方法

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;
        if ((tab = table) == null || (n = tab.length) == 0)
            // tab 爲空,調用resize()初始化tab。
            n = (tab = resize()).length;
        if ((p = tab[i = (n - 1) & hash]) == null)
            // key沒有被佔用的狀況下,將value封裝爲Node並賦值
            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))))
                // 若是key相同,p賦值給e
                e = p;
            else if (p instanceof TreeNode)
                // 若是p是紅黑樹類型，調用putTreeVal方式賦值
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                // index 相同的狀況下
                for (int binCount = 0; ; ++binCount) {
                    if ((e = p.next) == null) {
                        // 若是p的next爲空，將新的value值添加至鏈表後面
                        p.next = newNode(hash, key, value, null);
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            // 若是鏈表長度大於8，鏈表轉化爲紅黑樹，執行插入
                            treeifyBin(tab, hash);
                        break;
                    }
                    // key相同則跳出循環
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                //根據規則選擇是否覆蓋value
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            // size大於加載因子,擴容
            resize();
        afterNodeInsertion(evict);
        return null;
    }複製代碼

在構造函數中最多也只是設置了initialCapacity、loadFactor的值，並無初始化table，table的初始化工做是在put方法中進行的。

resize() 方法

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) {
            // table已存在
            if (oldCap >= MAXIMUM_CAPACITY) {
                // oldCap大於MAXIMUM_CAPACITY,threshold設置爲int的最大值
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                //newCap設置爲oldCap的2倍並小於MAXIMUM_CAPACITY，且大於默認值, 新的threshold增長爲原來的2倍
                newThr = oldThr << 1; // double threshold
        }
        else if (oldThr > 0) // initial capacity was placed in threshold
            // threshold>0, 將threshold設置爲newCap,因此要用tableSizeFor方法保證threshold是2的冪次方
            newCap = oldThr;
        else {               // zero initial threshold signifies using defaults
            // 默認初始化，cap爲16，threshold爲12。
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        if (newThr == 0) {
            // newThr爲0，newThr = newCap * 0.75
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                      (int)ft : Integer.MAX_VALUE);
        }
        threshold = newThr;
        @SuppressWarnings({"rawtypes","unchecked"})
            // 新生成一個table數組
            Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        table = newTab;
        if (oldTab != null) {
            // oldTab 複製到 newTab
            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)
                        // e爲紅黑樹的狀況
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    else { // preserve order
                        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;
                            }
                            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;
    }複製代碼

remove(key) 方法 & remove(key, value) 方法

remove(key) 方法和 remove(key, value) 方法都是經過調用removeNode的方法來實現刪除元素的。

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))))
                // index 元素只有一個元素
                node = p;
            else if ((e = p.next) != null) {
                if (p instanceof TreeNode)
                    // index處是一個紅黑樹
                    node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
                else {
                    // index處是一個鏈表，遍歷鏈表返回node
                    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;
    }複製代碼