Java類集框架 —— HashMap原始碼分析

xiaoyanger發表於2017-09-22

HashMap是基於Map的鍵值對對映表,底層是通過陣列、連結串列、紅黑樹(JDK1.8加入)來實現的。

HashMap結構

HashMap中儲存元素,是將keyvalue封裝成了一個Node,先以一個Node陣列的來儲存,通過keyhashCode來計算hash值,根據hash值和HashMap的大小確定存入元素在陣列中的位置。當hashCode相同時,即產生了相同的陣列索引位置,那麼就會通過單向連結串列的形式來繼續儲存。

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

    // 省略部分程式碼...        

}複製程式碼

HashMap中所有的對映都儲存在節點Node中,同時為了解決發生hash碰撞的衝突,節點可以持有下一個節點的引用,以形成一個單向連結串列。

HashMap結構圖(JDK1.7及之前)
HashMap結構圖(JDK1.7及之前)

在JDK1.8,HashMap又做了一些改動,當陣列table某個索引位置的上鍊表的長度大於8的話,則會將連結串列轉化為紅黑樹。

static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {
    TreeNode<K,V> parent;  // red-black tree links
    TreeNode<K,V> left;
    TreeNode<K,V> right;
    TreeNode<K,V> prev;    // needed to unlink next upon deletion
    boolean red;

    TreeNode(int hash, K key, V val, Node<K,V> next) {
        super(hash, key, val, next);
    }

    // 省略部分程式碼...        

}複製程式碼

同樣地,對映的key-value就儲存在TreeNode中。parentleftright持有相應節點的引用形成紅黑樹。

HashMap結構圖(JDK1.8)
HashMap結構圖(JDK1.8)

HashMap原始碼分析

主要屬性:

transient Node<K,V>[] table; // 陣列
transient int size;          // 大小
int threshold                 // 擴容閾值
final float loadFactor;      // 載入因子,預設值為0.75複製程式碼

構造方法:

// 使用預設的初始容量和載入因子
public HashMap() {
    this(DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR);
}

// 指定初始容量,使用預設的載入因子
public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

// 用現有的Map來構造一個新的HashMap
public HashMap(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}

// 根據自定義的初始容量和載入因子來構造HashMap
public HashMap(int initialCapacity, float loadFactor) {
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " +
                                           initialCapacity);
    if (initialCapacity > MAXIMUM_CAPACITY) {
        initialCapacity = MAXIMUM_CAPACITY;
    } else if (initialCapacity < DEFAULT_INITIAL_CAPACITY) {
        initialCapacity = DEFAULT_INITIAL_CAPACITY;
    }

    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " +
                                           loadFactor);
    threshold = initialCapacity;
    init();
}複製程式碼

建構函式主要是設定HashMap的初始容量,以及擴容的載入因子。HashMap(Map<? extends K, ? extends V> m)建構函式根據已有的對映來構造新的HashMap,它同樣採用的預設的載入因子,並將m中的元素新增到新構造的HashMap中。

資料存放:

public void putAll(Map<? extends K, ? extends V> m) {
    putMapEntries(m, true);
}

final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
    int s = m.size();
    if (s > 0) {
        if (table == null) { // pre-size
            float ft = ((float)s / loadFactor) + 1.0F;
            int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                     (int)ft : MAXIMUM_CAPACITY);
            if (t > threshold)
                threshold = tableSizeFor(t);
        }
        else if (s > threshold)
            resize();
        for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
            K key = e.getKey();
            V value = e.getValue();
            putVal(hash(key), key, value, false, evict);
        }
    }
}複製程式碼

putAll方法直接呼叫putMapEntriesputMapEntries方法中先根據已有的Map中的元素數量對新構造的HashMap進行擴容,然後遍歷舊的Map,取出元素存放到新的HashMap中。

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

// 根據key的hashCode來計算hash值
static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    // table為null的話,進行初始化
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    // 根據(n-1)&hash來計算出元素在陣列中的位置i
    if ((p = tab[i = (n - 1) & hash]) == null)
        // 如果陣列中該位置沒有元素,即tab[i]==null,則直接構建Node存放在該位置
        tab[i] = newNode(hash, key, value, null);
    else { // tab[i]不為null
        Node<K,V> e; K k;
        // 如果陣列中已有的節點tab[i]與需要新存入的元素的key相同,則直接替換掉tab[i]
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        else if (p instanceof TreeNode)
            // 如果tab[i]為紅黑樹節點,則直接存入紅黑樹
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {
            // tab[i]為連結串列的第一個節點,遍歷連結串列,將新的節點加入到連結串列的末尾
            for (int binCount = 0; ; ++binCount) {
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    // 如果連結串列的長度大於閾值,則將連結串列轉換為紅黑樹
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        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;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;
    // 新增完成後,檢查是否需要擴容
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}複製程式碼

put方法的主要邏輯:根據新增節點的hash值計算計算它在陣列中的位置i,判斷tab[i]是否為空,為空則直接加入;不為空的話,需要判斷該節點的key是否與新加入的節點的key相同,相同的話直接替換;如果不同則需要判斷tab[i]節點是否是紅黑樹節點,如果是紅黑樹節點,則直接加入到紅黑樹中;如果不是紅黑樹節點,那肯定就是連結串列的第一個節點了,遍歷連結串列,在遍歷的過程中還需要判斷是否與連結串列中已有節點的key相同,如果相同,同樣直接替換掉,都不同的話就直接新增到連結串列的末尾。並且呢,加入連結串列後還需要判斷連結串列的長度是否超過了閾值8,超過了的話,需要將連結串列轉換為紅黑樹。

HashMap在新增資料的時候,會判斷當前資料量是否超過設定的閾值,如果超過的話會進行擴容,在擴容過程中會將已新增的資料進行重新新增,以致原來新增元素的順序和位置都改變了,所以HashMap不能保證元素的存入取出順序。

刪除資料:

// 根據key刪除資料
public V remove(Object key) {
    Node<K,V> e;
    return (e = removeNode(hash(key), key, null, false, true)) == null ?
        null : e.value;
}

// 根據key-value刪除資料
@Override
public boolean remove(Object key, Object value) {
    return removeNode(hash(key), key, value, true, true) != null;
}

// 刪除節點
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;
    // 根據hash值得到陣列索引位置的節點p
    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;
        // p節點的key與需要刪除的節點的key相同的話,則說明p就是需要刪除的節點
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            node = p;    // 賦值給node
        else if ((e = p.next) != null) {
            if (p instanceof TreeNode)
                // p節點為紅黑樹節點,從紅黑樹中獲取匹配的刪除節點
                node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
            else {
                // p節點為連結串列的第一個節點,遍歷連結串列,找到匹配的刪除節點
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key ||
                         (key != null && key.equals(k)))) {
                        node = e;
                        break;
                    }
                    p = e;
                } while ((e = e.next) != null);
            }
        }
        // 匹配的刪除節點node不為null的話,刪除node
        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;
}複製程式碼

remove的邏輯和加入元素的邏輯相似,依次從陣列、紅黑樹、連結串列中找到匹配的刪除節點來刪除。

clear方法:

public void clear() {
    Node<K,V>[] tab;
    modCount++;
    if ((tab = table) != null && size > 0) {
        size = 0;
        for (int i = 0; i < tab.length; ++i)
            tab[i] = null;
    }
}複製程式碼

clear方法要簡單些,直接遍歷陣列tab,將陣列中所有元素都置空即可。

最後

對於HashMap,我們只要知道了它的底層結構,要理解它的實現原理還是非常簡單。在JDK1.8之後,加入了紅黑樹的結構,使HashMap的效率比之前的版本又優化了很多,關於連結串列轉化為紅黑樹,以及紅黑樹轉連結串列的具體實現等細節後續再做分析。

相關文章