從程式碼層讀懂 Java HashMap 的實現原理

code_xzh發表於2017-03-22

概述

Hashmap繼承於AbstractMap,實現了Map、Cloneable、Java.io.Serializable介面。它的key、value都可以為null,對映不是有序的。
Hashmap不是同步的,如果想要執行緒安全的HashMap,可以通過Collections類的靜態方法synchronizedMap獲得執行緒安全的HashMap。

Map map = Collections.synchronizedMap(new HashMap());

HashMap 中兩個重要的引數:“初始容量” 和 “載入因子”。

容量: 是雜湊表中桶的數量,初始容量 只是雜湊表在建立時的容量

載入因子: 是雜湊表在其容量自動增加之前可以達到多滿的一種尺度(預設0.75)。
當雜湊表中的條目數超出了載入因子與當前容量的乘積時,則要對該雜湊表進行 rehash 操作(即重建內部資料結構,桶數X2)。
載入因子越大,填滿的元素越多,好處是,空間利用率高了,但:衝突的機會加大了.反之,載入因子越小,填滿的元素越少, 好處是:衝突的機會減小了,但:空間浪費多了.

HashMap資料結構

Hashmap本質是陣列加連結串列。通過key的hashCode來計算hash值的,只要hashCode相同,計算出來的hash值就一樣,然後再計算出陣列下標,如果多個key對應到同一個下標,就用連結串列串起來,新插入的在前面。

這裡寫圖片描述

先來看看HashMap中Entry類的程式碼:

static class Entry<K,V> implements Map.Entry<K,V> {
    final K key;
    V value;
    // 指向下一個節點
    Entry<K,V> next;
    final int hash;
    // 建構函式。
    // 輸入引數包括"雜湊值(h)", "鍵(k)", "值(v)", "下一節點(n)"
    Entry(int h, K k, V v, Entry<K,V> n) {
        value = v;
        next = n;
        key = k;
        hash = h;
    }
    public final K getKey() {
        return key;
    }
    public final V getValue() {
        return value;
    }
    public final V setValue(V newValue) {
        V oldValue = value;
        value = newValue;
        return oldValue;
    }
    // 判斷兩個Entry是否相等
    // 若兩個Entry的“key”和“value”都相等,則返回true。
    // 否則,返回false
    public final boolean equals(Object o) {
        if (!(o instanceof Map.Entry))
            return false;
        Map.Entry e = (Map.Entry)o;
        Object k1 = getKey();
        Object k2 = e.getKey();
        if (k1 == k2 || (k1 != null && k1.equals(k2))) {
            Object v1 = getValue();
            Object v2 = e.getValue();
            if (v1 == v2 || (v1 != null && v1.equals(v2)))
                return true;
        }
        return false;
    }
    // 實現hashCode()
    public final int hashCode() {
        return (key==null   ? 0 : key.hashCode()) ^
               (value==null ? 0 : value.hashCode());
    }
    public final String toString() {
        return getKey() + "=" + getValue();
    }
    // 當向HashMap中新增元素時,繪呼叫recordAccess()。
    // 這裡不做任何處理
    void recordAccess(HashMap<K,V> m) {
    }
    // 當從HashMap中刪除元素時,繪呼叫recordRemoval()。
    // 這裡不做任何處理
    void recordRemoval(HashMap<K,V> m) {
    }
}

可以看出HashMap就是一個Entry陣列,Entry物件中包含了鍵和值兩個屬性。

HashMap原始碼分析

HashMap共有4個建構函式,如下:

  • HashMap() 構造一個具有預設初始容量 (16) 和預設載入因子 (0.75) 的空 HashMap。
  • HashMap(int initialCapacity) 構造一個帶指定初始容量和預設載入因子 (0.75) 的空 HashMap。
  • HashMap(int initialCapacity, float loadFactor) 構造一個帶指定初始容量和載入因子的空
    HashMap。
  • HashMap(Map<  extends K, extends V> m) 構造一個對映關係與指定 Map 相同的新 HashMap。

HashMap提供的API方法:

  • void clear() 從此對映中移除所有對映關係。
  • Object clone() 返回此 HashMap 例項的淺表副本:並不複製鍵和值本身。
  • boolean containsKey(Object key) 如果此對映包含對於指定鍵的對映關係,則返回 true。
  • boolean containsValue(Object value) 如果此對映將一個或多個鍵對映到指定值,則返回 true。
  • Set entrySet() 返回此對映所包含的對映關係的 Set<Map.Entry> 檢視。
  • V get(Object key) 返回指定鍵所對映的值;如果對於該鍵來說,此對映不包含任何對映關係,則返回 null。
  • boolean isEmpty() 如果此對映不包含鍵-值對映關係,則返回 true。
  • Set keySet() 返回此對映中所包含的鍵的 Set<K> 檢視。
  • V put(K key, V value) 在此對映中關聯指定值與指定鍵。
  • void  putAll(Map< extends K, extends V> m)
    將指定對映的所有對映關係複製到此對映中,這些對映關係將替換此對映目前針對指定對映中所有鍵的所有對映關係。
  • V remove(Object key) 從此對映中移除指定鍵的對映關係(如果存在)。
  • int  size() 返回此對映中的鍵-值對映關係數。
  • Collection values() 返回此對映所包含的值的 Collection 檢視。

HashMap原始碼:

package java.util;
import java.io.*;
public class HashMap<K,V>
    extends AbstractMap<K,V>
    implements Map<K,V>, Cloneable, Serializable
{
    //  預設的初始容量(容量為HashMap中桶的數目)是16,且實際容量必須是2的整數次冪。 
    static final int DEFAULT_INITIAL_CAPACITY = 16;

    // 最大容量(必須是2的冪且小於2的30次方,傳入容量過大將被這個值替換)
    static final int MAXIMUM_CAPACITY = 1 << 30;

    // 預設載入因子
    static final float DEFAULT_LOAD_FACTOR = 0.75f;

    // 儲存資料的Entry陣列,長度是2的冪。
    // HashMap是採用拉鍊法實現的,每一個Entry本質上是一個單向連結串列
    transient Entry[] table;

    // HashMap的大小,它是HashMap儲存的鍵值對的數量
    transient int size;

    // HashMap的閾值,用於判斷是否需要調整HashMap的容量(threshold = 容量*載入因子)
    int threshold;

    // 載入因子實際大小
    final float loadFactor;

    // HashMap被改變的次數
    transient volatile int modCount;

    // 指定“容量大小”和“載入因子”的建構函式
    public HashMap(int initialCapacity, float loadFactor) {
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " +
                                               initialCapacity);
        // HashMap的最大容量只能是MAXIMUM_CAPACITY
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal load factor: " +
                                               loadFactor);
        // 找出“大於initialCapacity”的最小的2的冪
        int capacity = 1;
        while (capacity < initialCapacity)
            capacity <<= 1;
        // 設定“載入因子”
        this.loadFactor = loadFactor;
        // 設定“HashMap閾值”,當HashMap中儲存資料的數量達到threshold時,就需要將HashMap的容量加倍。
        threshold = (int)(capacity * loadFactor);
        // 建立Entry陣列,用來儲存資料
        table = new Entry[capacity];
        init();
    }

    // 指定“容量大小”的建構函式
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

    // 預設建構函式。
    public HashMap() {
        // 設定“載入因子”
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        // 設定“HashMap閾值”,當HashMap中儲存資料的數量達到threshold時,就需要將HashMap的容量加倍。
        threshold = (int)(DEFAULT_INITIAL_CAPACITY * DEFAULT_LOAD_FACTOR);
        // 建立Entry陣列,用來儲存資料
        table = new Entry[DEFAULT_INITIAL_CAPACITY];
        init();
    }

    // 包含“子Map”的建構函式
    public HashMap(Map<? extends K, ? extends V> m) {
        this(Math.max((int) (m.size() / DEFAULT_LOAD_FACTOR) + 1,
                      DEFAULT_INITIAL_CAPACITY), DEFAULT_LOAD_FACTOR);
        // 將m中的全部元素逐個新增到HashMap中
        putAllForCreate(m);
    }

    static int hash(int h) {
        h ^= (h >>> 20) ^ (h >>> 12);
        return h ^ (h >>> 7) ^ (h >>> 4);
    }

    // 返回索引值
    // h & (length-1)保證返回值的小於length
    static int indexFor(int h, int length) {
        return h & (length-1);
    }

    public int size() {
        return size;
    }

    public boolean isEmpty() {
        return size == 0;
    }

    // 獲取key對應的value
    public V get(Object key) {
        if (key == null)
            return getForNullKey();
        // 獲取key的hash值
        int hash = hash(key.hashCode());
        // 在“該hash值對應的連結串列”上查詢“鍵值等於key”的元素
        for (Entry<K,V> e = table[indexFor(hash, table.length)];
             e != null;
             e = e.next) {
            Object k;
            if (e.hash == hash && ((k = e.key) == key || key.equals(k)))
                return e.value;
        }
        return null;
    }

    // 獲取“key為null”的元素的值
    // HashMap將“key為null”的元素儲存在table[0]位置!
    private V getForNullKey() {
        for (Entry<K,V> e = table[0]; e != null; e = e.next) {
            if (e.key == null)
                return e.value;
        }
        return null;
    }

    // HashMap是否包含key
    public boolean containsKey(Object key) {
        return getEntry(key) != null;
    }

    // 返回“鍵為key”的鍵值對
    final Entry<K,V> getEntry(Object key) {
        // 獲取雜湊值
        // HashMap將“key為null”的元素儲存在table[0]位置,“key不為null”的則呼叫hash()計算雜湊值
        int hash = (key == null) ? 0 : hash(key.hashCode());
        // 在“該hash值對應的連結串列”上查詢“鍵值等於key”的元素
        for (Entry<K,V> e = table[indexFor(hash, table.length)];
             e != null;
             e = e.next) {
            Object k;
            if (e.hash == hash &&
                ((k = e.key) == key || (key != null && key.equals(k))))
                return e;
        }
        return null;
    }

    // 將“key-value”新增到HashMap中
    public V put(K key, V value) {
        // 若“key為null”,則將該鍵值對新增到table[0]中。
        if (key == null)
            return putForNullKey(value);
        // 若“key不為null”,則計算該key的雜湊值,然後將其新增到該雜湊值對應的連結串列中。
        int hash = hash(key.hashCode());
        int i = indexFor(hash, table.length);
        for (Entry<K,V> e = table[i]; e != null; e = e.next) {
            Object k;
            // 若“該key”對應的鍵值對已經存在,則用新的value取代舊的value。然後退出!
            if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue;
            }
        }
        // 若“該key”對應的鍵值對不存在,則將“key-value”新增到table中
        modCount++;
        addEntry(hash, key, value, i);
        return null;
    }

    // putForNullKey()的作用是將“key為null”鍵值對新增到table[0]位置
    private V putForNullKey(V value) {
        for (Entry<K,V> e = table[0]; e != null; e = e.next) {
            if (e.key == null) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue;
            }
        }
        // 這裡的完全不會被執行到!
        modCount++;
        addEntry(0, null, value, 0);
        return null;
    }

    // 建立HashMap對應的“新增方法”,
    // 它和put()不同。putForCreate()是內部方法,它被建構函式等呼叫,用來建立HashMap
    // 而put()是對外提供的往HashMap中新增元素的方法。
    private void putForCreate(K key, V value) {
        int hash = (key == null) ? 0 : hash(key.hashCode());
        int i = indexFor(hash, table.length);
        // 若該HashMap表中存在“鍵值等於key”的元素,則替換該元素的value值
        for (Entry<K,V> e = table[i]; e != null; e = e.next) {
            Object k;
            if (e.hash == hash &&
                ((k = e.key) == key || (key != null && key.equals(k)))) {
                e.value = value;
                return;
            }
        }
        // 若該HashMap表中不存在“鍵值等於key”的元素,則將該key-value新增到HashMap中
        createEntry(hash, key, value, i);
    }

    // 將“m”中的全部元素都新增到HashMap中。
    // 該方法被內部的構造HashMap的方法所呼叫。
    private void putAllForCreate(Map<? extends K, ? extends V> m) {
        // 利用迭代器將元素逐個新增到HashMap中
        for (Iterator<? extends Map.Entry<? extends K, ? extends V>> i = m.entrySet().iterator(); i.hasNext(); ) {
            Map.Entry<? extends K, ? extends V> e = i.next();
            putForCreate(e.getKey(), e.getValue());
        }
    }

    // 重新調整HashMap的大小,newCapacity是調整後的單位
    void resize(int newCapacity) {
        Entry[] oldTable = table;
        int oldCapacity = oldTable.length;
        if (oldCapacity == MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return;
        }
        // 新建一個HashMap,將“舊HashMap”的全部元素新增到“新HashMap”中,
        // 然後,將“新HashMap”賦值給“舊HashMap”。
        Entry[] newTable = new Entry[newCapacity];
        transfer(newTable);
        table = newTable;
        threshold = (int)(newCapacity * loadFactor);
    }

    // 將HashMap中的全部元素都新增到newTable中
    void transfer(Entry[] newTable) {
        Entry[] src = table;
        int newCapacity = newTable.length;
        for (int j = 0; j < src.length; j++) {
            Entry<K,V> e = src[j];
            if (e != null) {
                src[j] = null;
                do {
                    Entry<K,V> next = e.next;
                    int i = indexFor(e.hash, newCapacity);
                    e.next = newTable[i];
                    newTable[i] = e;
                    e = next;
                } while (e != null);
            }
        }
    }

    // 將"m"的全部元素都新增到HashMap中
    public void putAll(Map<? extends K, ? extends V> m) {
        // 有效性判斷
        int numKeysToBeAdded = m.size();
        if (numKeysToBeAdded == 0)
            return;
        // 計算容量是否足夠,
        // 若“當前實際容量 < 需要的容量”,則將容量x2。
        if (numKeysToBeAdded > threshold) {
            int targetCapacity = (int)(numKeysToBeAdded / loadFactor + 1);
            if (targetCapacity > MAXIMUM_CAPACITY)
                targetCapacity = MAXIMUM_CAPACITY;
            int newCapacity = table.length;
            while (newCapacity < targetCapacity)
                newCapacity <<= 1;
            if (newCapacity > table.length)
                resize(newCapacity);
        }
        // 通過迭代器,將“m”中的元素逐個新增到HashMap中。
        for (Iterator<? extends Map.Entry<? extends K, ? extends V>> i = m.entrySet().iterator(); i.hasNext(); ) {
            Map.Entry<? extends K, ? extends V> e = i.next();
            put(e.getKey(), e.getValue());
        }
    }

    // 刪除“鍵為key”元素
    public V remove(Object key) {
        Entry<K,V> e = removeEntryForKey(key);
        return (e == null ? null : e.value);
    }

    // 刪除“鍵為key”的元素
    final Entry<K,V> removeEntryForKey(Object key) {
        // 獲取雜湊值。若key為null,則雜湊值為0;否則呼叫hash()進行計算
        int hash = (key == null) ? 0 : hash(key.hashCode());
        int i = indexFor(hash, table.length);
        Entry<K,V> prev = table[i];
        Entry<K,V> e = prev;
        // 刪除連結串列中“鍵為key”的元素
        // 本質是“刪除單向連結串列中的節點”
        while (e != null) {
            Entry<K,V> next = e.next;
            Object k;
            if (e.hash == hash &&
                ((k = e.key) == key || (key != null && key.equals(k)))) {
                modCount++;
                size--;
                if (prev == e)
                    table[i] = next;
                else
                    prev.next = next;
                e.recordRemoval(this);
                return e;
            }
            prev = e;
            e = next;
        }
        return e;
    }

    // 刪除“鍵值對”
    final Entry<K,V> removeMapping(Object o) {
        if (!(o instanceof Map.Entry))
            return null;
        Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
        Object key = entry.getKey();
        int hash = (key == null) ? 0 : hash(key.hashCode());
        int i = indexFor(hash, table.length);
        Entry<K,V> prev = table[i];
        Entry<K,V> e = prev;
        // 刪除連結串列中的“鍵值對e”
        // 本質是“刪除單向連結串列中的節點”
        while (e != null) {
            Entry<K,V> next = e.next;
            if (e.hash == hash && e.equals(entry)) {
                modCount++;
                size--;
                if (prev == e)
                    table[i] = next;
                else
                    prev.next = next;
                e.recordRemoval(this);
                return e;
            }
            prev = e;
            e = next;
        }
        return e;
    }

    // 清空HashMap,將所有的元素設為null
    public void clear() {
        modCount++;
        Entry[] tab = table;
        for (int i = 0; i < tab.length; i++)
            tab[i] = null;
        size = 0;
    }

    // 是否包含“值為value”的元素
    public boolean containsValue(Object value) {
    // 若“value為null”,則呼叫containsNullValue()查詢
    if (value == null)
            return containsNullValue();
    // 若“value不為null”,則查詢HashMap中是否有值為value的節點。
    Entry[] tab = table;
        for (int i = 0; i < tab.length ; i++)
            for (Entry e = tab[i] ; e != null ; e = e.next)
                if (value.equals(e.value))
                    return true;
    return false;
    }

    // 是否包含null值
    private boolean containsNullValue() {
    Entry[] tab = table;
        for (int i = 0; i < tab.length ; i++)
            for (Entry e = tab[i] ; e != null ; e = e.next)
                if (e.value == null)
                    return true;
    return false;
    }

    // 克隆一個HashMap,並返回Object物件
    public Object clone() {
        HashMap<K,V> result = null;
        try {
            result = (HashMap<K,V>)super.clone();
        } catch (CloneNotSupportedException e) {
            // assert false;
        }
        result.table = new Entry[table.length];
        result.entrySet = null;
        result.modCount = 0;
        result.size = 0;
        result.init();
        // 呼叫putAllForCreate()將全部元素新增到HashMap中
        result.putAllForCreate(this);
        return result;
    }

    // Entry是單向連結串列。
    // 它是 “HashMap鏈式儲存法”對應的連結串列。
    // 它實現了Map.Entry 介面,即實現getKey(), getValue(), setValue(V value), equals(Object o), hashCode()這些函式
    static class Entry<K,V> implements Map.Entry<K,V> {
        final K key;
        V value;
        // 指向下一個節點
        Entry<K,V> next;
        final int hash;
        // 建構函式。
        // 輸入引數包括"雜湊值(h)", "鍵(k)", "值(v)", "下一節點(n)"
        Entry(int h, K k, V v, Entry<K,V> n) {
            value = v;
            next = n;
            key = k;
            hash = h;
        }
        public final K getKey() {
            return key;
        }
        public final V getValue() {
            return value;
        }
        public final V setValue(V newValue) {
            V oldValue = value;
            value = newValue;
            return oldValue;
        }
        // 判斷兩個Entry是否相等
        // 若兩個Entry的“key”和“value”都相等,則返回true。
        // 否則,返回false
        public final boolean equals(Object o) {
            if (!(o instanceof Map.Entry))
                return false;
            Map.Entry e = (Map.Entry)o;
            Object k1 = getKey();
            Object k2 = e.getKey();
            if (k1 == k2 || (k1 != null && k1.equals(k2))) {
                Object v1 = getValue();
                Object v2 = e.getValue();
                if (v1 == v2 || (v1 != null && v1.equals(v2)))
                    return true;
            }
            return false;
        }
        // 實現hashCode()
        public final int hashCode() {
            return (key==null   ? 0 : key.hashCode()) ^
                   (value==null ? 0 : value.hashCode());
        }
        public final String toString() {
            return getKey() + "=" + getValue();
        }
        // 當向HashMap中新增元素時,繪呼叫recordAccess()。
        // 這裡不做任何處理
        void recordAccess(HashMap<K,V> m) {
        }
        // 當從HashMap中刪除元素時,繪呼叫recordRemoval()。
        // 這裡不做任何處理
        void recordRemoval(HashMap<K,V> m) {
        }
    }

    // 新增Entry。將“key-value”插入指定位置,bucketIndex是位置索引。
    void addEntry(int hash, K key, V value, int bucketIndex) {
        // 儲存“bucketIndex”位置的值到“e”中
        Entry<K,V> e = table[bucketIndex];
        // 設定“bucketIndex”位置的元素為“新Entry”,
        // 設定“e”為“新Entry的下一個節點”
        table[bucketIndex] = new Entry<K,V>(hash, key, value, e);
        // 若HashMap的實際大小 不小於 “閾值”,則調整HashMap的大小
        if (size++ >= threshold)
            resize(2 * table.length);
    }

    // 建立Entry。將“key-value”插入指定位置,bucketIndex是位置索引。
    // 它和addEntry的區別是:
    // (01) addEntry()一般用在 新增Entry可能導致“HashMap的實際容量”超過“閾值”的情況下。
    //   例如,我們新建一個HashMap,然後不斷通過put()向HashMap中新增元素;
    // put()是通過addEntry()新增Entry的。
    //   在這種情況下,我們不知道何時“HashMap的實際容量”會超過“閾值”;
    //   因此,需要呼叫addEntry()
    // (02) createEntry() 一般用在 新增Entry不會導致“HashMap的實際容量”超過“閾值”的情況下。
    //   例如,我們呼叫HashMap“帶有Map”的建構函式,它繪將Map的全部元素新增到HashMap中;
    // 但在新增之前,我們已經計算好“HashMap的容量和閾值”。也就是,可以確定“即使將Map中
    // 的全部元素新增到HashMap中,都不會超過HashMap的閾值”。
    //   此時,呼叫createEntry()即可。
    void createEntry(int hash, K key, V value, int bucketIndex) {
        // 儲存“bucketIndex”位置的值到“e”中
        Entry<K,V> e = table[bucketIndex];
        // 設定“bucketIndex”位置的元素為“新Entry”,
        // 設定“e”為“新Entry的下一個節點”
        table[bucketIndex] = new Entry<K,V>(hash, key, value, e);
        size++;
    }

    // HashIterator是HashMap迭代器的抽象出來的父類,實現了公共了函式。
    // 它包含“key迭代器(KeyIterator)”、“Value迭代器(ValueIterator)”和“Entry迭代器(EntryIterator)”3個子類。
    private abstract class HashIterator<E> implements Iterator<E> {
        // 下一個元素
        Entry<K,V> next;
        // expectedModCount用於實現fast-fail機制。
        int expectedModCount;
        // 當前索引
        int index;
        // 當前元素
        Entry<K,V> current;
        HashIterator() {
            expectedModCount = modCount;
            if (size > 0) { // advance to first entry
                Entry[] t = table;
                // 將next指向table中第一個不為null的元素。
                // 這裡利用了index的初始值為0,從0開始依次向後遍歷,直到找到不為null的元素就退出迴圈。
                while (index < t.length && (next = t[index++]) == null)

            }
        }
        public final boolean hasNext() {
            return next != null;
        }
        // 獲取下一個元素
        final Entry<K,V> nextEntry() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
            Entry<K,V> e = next;
            if (e == null)
                throw new NoSuchElementException();
            // 注意!!!
            // 一個Entry就是一個單向連結串列
            // 若該Entry的下一個節點不為空,就將next指向下一個節點;
            // 否則,將next指向下一個連結串列(也是下一個Entry)的不為null的節點。
            if ((next = e.next) == null) {
                Entry[] t = table;
                while (index < t.length && (next = t[index++]) == null)

            }
            current = e;
            return e;
        }
        // 刪除當前元素
        public void remove() {
            if (current == null)
                throw new IllegalStateException();
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
            Object k = current.key;
            current = null;
            HashMap.this.removeEntryForKey(k);
            expectedModCount = modCount;
        }
    }
    // value的迭代器
    private final class ValueIterator extends HashIterator<V> {
        public V next() {
            return nextEntry().value;
        }
    }
    // key的迭代器
    private final class KeyIterator extends HashIterator<K> {
        public K next() {
            return nextEntry().getKey();
        }
    }
    // Entry的迭代器
    private final class EntryIterator extends HashIterator<Map.Entry<K,V>> {
        public Map.Entry<K,V> next() {
            return nextEntry();
        }
    }
    // 返回一個“key迭代器”
    Iterator<K> newKeyIterator()   {
        return new KeyIterator();
    }
    // 返回一個“value迭代器”
    Iterator<V> newValueIterator()   {
        return new ValueIterator();
    }
    // 返回一個“entry迭代器”
    Iterator<Map.Entry<K,V>> newEntryIterator()   {
        return new EntryIterator();
    }
    // HashMap的Entry對應的集合
    private transient Set<Map.Entry<K,V>> entrySet = null;
    // 返回“key的集合”,實際上返回一個“KeySet物件”
    public Set<K> keySet() {
        Set<K> ks = keySet;
        return (ks != null ? ks : (keySet = new KeySet()));
    }
    // Key對應的集合
    // KeySet繼承於AbstractSet,說明該集合中沒有重複的Key。
    private final class KeySet extends AbstractSet<K> {
        public Iterator<K> iterator() {
            return newKeyIterator();
        }
        public int size() {
            return size;
        }
        public boolean contains(Object o) {
            return containsKey(o);
        }
        public boolean remove(Object o) {
            return HashMap.this.removeEntryForKey(o) != null;
        }
        public void clear() {
            HashMap.this.clear();
        }
    }
    // 返回“value集合”,實際上返回的是一個Values物件
    public Collection<V> values() {
        Collection<V> vs = values;
        return (vs != null ? vs : (values = new Values()));
    }
    // “value集合”
    // Values繼承於AbstractCollection,不同於“KeySet繼承於AbstractSet”,
    // Values中的元素能夠重複。因為不同的key可以指向相同的value。
    private final class Values extends AbstractCollection<V> {
        public Iterator<V> iterator() {
            return newValueIterator();
        }
        public int size() {
            return size;
        }
        public boolean contains(Object o) {
            return containsValue(o);
        }
        public void clear() {
            HashMap.this.clear();
        }
    }
    // 返回“HashMap的Entry集合”
    public Set<Map.Entry<K,V>> entrySet() {
        return entrySet0();
    }
    // 返回“HashMap的Entry集合”,它實際是返回一個EntrySet物件
    private Set<Map.Entry<K,V>> entrySet0() {
        Set<Map.Entry<K,V>> es = entrySet;
        return es != null ? es : (entrySet = new EntrySet());
    }
    // EntrySet對應的集合
    // EntrySet繼承於AbstractSet,說明該集合中沒有重複的EntrySet。
    private final class EntrySet extends AbstractSet<Map.Entry<K,V>> {
        public Iterator<Map.Entry<K,V>> iterator() {
            return newEntryIterator();
        }
        public boolean contains(Object o) {
            if (!(o instanceof Map.Entry))
                return false;
            Map.Entry<K,V> e = (Map.Entry<K,V>) o;
            Entry<K,V> candidate = getEntry(e.getKey());
            return candidate != null && candidate.equals(e);
        }
        public boolean remove(Object o) {
            return removeMapping(o) != null;
        }
        public int size() {
            return size;
        }
        public void clear() {
            HashMap.this.clear();
        }
    }
    // java.io.Serializable的寫入函式
    // 將HashMap的“總的容量,實際容量,所有的Entry”都寫入到輸出流中
    private void writeObject(java.io.ObjectOutputStream s)
        throws IOException
    {
        Iterator<Map.Entry<K,V>> i =
            (size > 0) ? entrySet0().iterator() : null;
        // Write out the threshold, loadfactor, and any hidden stuff
        s.defaultWriteObject();
        // Write out number of buckets
        s.writeInt(table.length);
        // Write out size (number of Mappings)
        s.writeInt(size);
        // Write out keys and values (alternating)
        if (i != null) {
            while (i.hasNext()) {
            Map.Entry<K,V> e = i.next();
            s.writeObject(e.getKey());
            s.writeObject(e.getValue());
            }
        }
    }
    private static final long serialVersionUID = 362498820763181265L;
    // java.io.Serializable的讀取函式:根據寫入方式讀出
    // 將HashMap的“總的容量,實際容量,所有的Entry”依次讀出
    private void readObject(java.io.ObjectInputStream s)
         throws IOException, ClassNotFoundException
    {
        // Read in the threshold, loadfactor, and any hidden stuff
        s.defaultReadObject();
        // Read in number of buckets and allocate the bucket array;
        int numBuckets = s.readInt();
        table = new Entry[numBuckets];
        init();  // Give subclass a chance to do its thing.
        // Read in size (number of Mappings)
        int size = s.readInt();
        // Read the keys and values, and put the mappings in the HashMap
        for (int i=0; i<size; i++) {
            K key = (K) s.readObject();
            V value = (V) s.readObject();
            putForCreate(key, value);
        }
    }
    // 返回“HashMap總的容量”
    int   capacity()     { return table.length; }
    // 返回“HashMap的載入因子”
    float loadFactor()   { return loadFactor;   }
}

主要程式碼分析:

  • public V get(Object key):如果key不為null,則先求的key的hash值,根據hash值找到在table中的索引,在該索引對應的單連結串列中查詢是否有鍵值對的key與目標key相等,有就返回對應的value,沒有則返回null。   如果key為null,則直接從雜湊表的第一個位置table[0]對應的連結串列上查詢。記住,key為null的鍵值對永遠都放在以table[0]為頭結點的連結串列中,當然不一定是存放在頭結點table[0]中。
  • public V put(K key, V value)如果key不為null,則同樣先求出key的hash值,根據hash值得出在table中的索引,而後遍歷對應的單連結串列,如果單連結串列中存在與目標key相等的鍵值對,則將新的value覆蓋舊的value,並將舊的value返回,如果找不到與目標key相等的鍵值對,或者該單連結串列為空,則將該鍵值對插入到改單連結串列的頭結點位置(每次新插入的節點都是放在頭結點的位置),該操作是有addEntry方法實現的,它的原始碼如下:
void addEntry(int hash, K key, V value, int bucketIndex) {
        Entry<K,V> e = table[bucketIndex]; //如果要加入的位置有值,將該位置原先的值設定為新entry的next,也就是新entry連結串列的下一個節點
        table[bucketIndex] = new Entry<>(hash, key, value, e);
        if (size++ >= threshold) //如果大於臨界值就擴容
            resize(2 * table.length); //以2的倍數擴容
    }

引數bucketIndex就是indexFor函式計算出來的索引值,第2行程式碼是取得陣列中索引為bucketIndex的Entry物件,第3行就是用hash、key、value構建一個新的Entry物件放到索引為bucketIndex的位置,並且將該位置原先的物件設定為新物件的next構成連結串列。第4行和第5行就是判斷put後size是否達到了臨界值threshold,如果達到了臨界值就要進行擴容,HashMap擴容是擴為原來的兩倍。

如果key為null,則將其新增到table[0]對應的連結串列中,由putForNullKey()實現。

// putForNullKey()的作用是將“key為null”鍵值對新增到table[0]位置  
    private V putForNullKey(V value) {  
        for (Entry<K,V> e = table[0]; e != null; e = e.next) {  
            if (e.key == null) {  
                V oldValue = e.value;  
                e.value = value;  
                e.recordAccess(this);  
                return oldValue;  
            }  
        }  
        // 如果沒有存在key為null的鍵值對,則直接題阿見到table[0]處!  
        modCount++;  
        addEntry(0, null, value, 0);  
        return null;  
    }

涉及到的resize擴容方法:

void resize(int newCapacity) {
        Entry[] oldTable = table;
        int oldCapacity = oldTable.length;
        if (oldCapacity == MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return;
        }

        Entry[] newTable = new Entry[newCapacity];
        transfer(newTable);//用來將原先table的元素全部移到newTable裡面
        table = newTable;  //再將newTable賦值給table
        threshold = (int)(newCapacity * loadFactor);//重新計算臨界值
    }

它新建了一個HashMap的底層陣列,而後呼叫transfer方法,將就HashMap的全部元素新增到新的HashMap中(要重新計算元素在新的陣列中的索引位置)。   擴容是需要進行陣列複製的,非常消耗效能的操作,所以如果我們已經預知HashMap中元素的個數,那麼預設元素的個數能夠有效的提高HashMap的效能。

hash()

static int hash(int h) {
        h ^= (h >>> 20) ^ (h >>> 12);
        return h ^ (h >>> 7) ^ (h >>> 4);
    }

hash值找到對應索引

static int indexFor(int h, int length) {
        return h & (length-1);
    }

HashMap中則通過h&(length-1)的方法來代替取模,同樣實現了均勻的雜湊,但效率要高很多,這也是HashMap對Hashtable的一個改進。

length為2的整數次冪的話,h&(length-1)就相當於對length取模,這樣便保證了雜湊的均勻,同時也提升了效率。

說明:length為2的整數次冪的話,為偶數,這樣length-1為奇數,奇數的最後一位是1,這樣便保證了h&(length-1)的最後一位可能為0,也可能為1(這取決於h的值),即與後的結果可能為偶數,也可能為奇數,這樣便可以保證雜湊的均勻性,而如果length為奇數的話,很明顯length-1為偶數,它的最後一位是0,這樣h&(length-1)的最後一位肯定為0,即只能為偶數,這樣任何hash值都只會被雜湊到陣列的偶數下標位置上,這便浪費了近一半的空間。

相關文章