java 集合框架-HashMap

一、概述

HashMap應該是我們最常會使用到的Map容器了吧,這裏先簡單羅列寫它的特點:
1.實現所有Map接口方法,允許null值key、null值value
2.不保證元素的順序,包括先後添加的順序,特別是隨着容量增加順序不能保證
3.實現等價於HashTable,區別是HashMap是非線程安全的
4.假設hash方法可以正確的分散,基本的get、put操作的時間複雜度爲常量時間(N)
5.迭代器迭代時間與容量正比例,常用迭代操作的初始化容量不要大,負載因子不要太小
6.主要的兩個參數:初始容量和負載因子;當映射大小達到容量和因子的乘積大小後自動擴大容量,對全部映射重新hash,容量大概變爲原來的2倍;需要衡量好初始容量和因子的大小,默認因子的大小爲0.75,因子大可以增加空間使用率、減少重新hash次數,但是影響get,put的性能
7.非線程安全,可以使用Collection.synchronizedMap或者Collections.synchronizedMap包裝爲線程安全Map
8.與ArrayList相似,HashMap在發現併發時一樣是有‘快速失敗’機制,在獲取迭代器後,如果數據結構發送改變,將會拋出ConcurrentModificationException異常

二、源碼分析

1、變量

由於後面的方法中源碼常出現HashMap的變量,這裏先列出來並說明作用

//默認初始化大小爲16
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
最大容量大小爲230次方:1073741824
static final int MAXIMUM_CAPACITY = 1 << 30;
//默認負載因子大小爲0.75
static final float DEFAULT_LOAD_FACTOR = 0.75f;
//空數組
static final Entry<?,?>[] EMPTY_TABLE = {};
//存儲鍵值對映射的Entry數組,默認爲空數組,大小必須爲2的次冪
transient Entry<K,V>[] table = (Entry<K,V>[]) EMPTY_TABLE;
//保存HashMap實例映射的數量
transient int size;
//當前大小的上限閥值,達到這個值後需要擴容(resize),該值應爲容量與負載因子的乘積
//當table還是空數組情況下,這個值是第一次初始化的大小
int threshold;
//負載因子
final float loadFactor;
//可理解爲修改次數,每次map結構修改都會加1,用於檢測併發快速失敗
transient int modCount;
//String類型key默認的可選threshold,當threshold大於這個值時,啓用可選hash算法,可以減少由於弱hash值計算方法導致的hash衝突,這個值可以通過系統變量:jdk.map.althashing.threshold設置
static final int ALTERNATIVE_HASHING_THRESHOLD_DEFAULT = Integer.MAX_VALUE;

下面的代碼就是爲了從jdk.map.althashing.threshold獲取這個ALTERNATIVE_HASHING_THRESHOLD;
這段’靜態’代碼作用很簡單,就是獲取這個ALTERNATIVE_HASHING_THRESHOLD_DEFAULT值,當設置爲-1時表示不啓用改可選hash方法,值還是Integer.MAX_VALUE;

        static final int ALTERNATIVE_HASHING_THRESHOLD;

        static {
            String altThreshold = java.security.AccessController.doPrivileged(
                new sun.security.action.GetPropertyAction(
                    "jdk.map.althashing.threshold"));

            int threshold;
            try {
                threshold = (null != altThreshold)
                        ? Integer.parseInt(altThreshold)
                        : ALTERNATIVE_HASHING_THRESHOLD_DEFAULT;

                // disable alternative hashing if -1
                if (threshold == -1) {
                    threshold = Integer.MAX_VALUE;
                }

                if (threshold < 0) {
                    throw new IllegalArgumentException("value must be positive integer.");
                }
            } catch(IllegalArgumentException failed) {
                throw new Error("Illegal value for 'jdk.map.althashing.threshold'", failed);
            }

            ALTERNATIVE_HASHING_THRESHOLD = threshold;
        }
    }
//hash種子參數,隨機值,每個實例可能不一樣在,計算hash值時使用,用於減少hash碰撞(hash值衝突),爲0時表示可選hash不啓用
transient int hashSeed = 0;

2、方法

    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;
        threshold = initialCapacity;
        init();
    }

    void init() {
    }

使用構造方法創建一個HashMap對象後,實際table還是一個空數組,init方法是空實現,並沒有進行實際的初始化操作;這裏有一點有注意的就是 threshold 等於指定的初始化大小而不是initialCapacity與loadFactor的乘積,當table還是空數組時,第一次初始化到threshold大小就是initialCapacity;

    private static int roundUpToPowerOf2(int number) {
        // assert number >= 0 : "number must be non-negative";
        return number >= MAXIMUM_CAPACITY
                ? MAXIMUM_CAPACITY
                : (number > 1) ? Integer.highestOneBit((number - 1) << 1) : 1;
    }

這個靜態內部方法,用於計算入參number的處於的下一個2次冪結果,這樣說有點難理解,還是解析代碼:當number大於最大容量值,返回最大值;當numer小於等於1時,返回1;其他情況返回(number-1)最高位代表的值乘2。也即是獲取2次冪中第一個大於number的值;所以這個方法的返回值肯定是2次冪的數;

下面我們來看下核心的put方法,涉及容量的擴展、hash計算

    public V put(K key, V value) {
        if (table == EMPTY_TABLE) {
            inflateTable(threshold);
        }
        if (key == null)
            return putForNullKey(value);
        int hash = hash(key);
        int i = indexFor(hash, table.length);
        for (Entry<K,V> e = table[i]; e != null; e = e.next) {
            Object k;
            if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue;
            }
        }

        modCount++;
        addEntry(hash, key, value, i);
        return null;
    }

當表table還是空(剛new出來的實例)會進行一次擴容,每次擴容大小爲threshold,這裏第一次threshold的值是initialCapacity;

從第二段代碼可以看出,key值是允許爲null的,並且是單獨出來,後面我們再看具體處理實現;
接着就是hash計算以及put存儲和碰撞處理,對於以及存在的key,會進行值的替換並返回舊值;
最後如果是新key值,將該key-value保存到table中;

下面我們來看put方法中所調用到方法的具體實現:

    private void inflateTable(int toSize) {
        // Find a power of 2 >= toSize
        int capacity = roundUpToPowerOf2(toSize);

        threshold = (int) Math.min(capacity * loadFactor, MAXIMUM_CAPACITY + 1);
        table = new Entry[capacity];
        initHashSeedAsNeeded(capacity);
    }

實際這個方法可以看成是初始化的方法,因爲第一次table對象創建只在這個方法裏面;roundUpToPowerOf2方法獲取下一個2次冪數,threshold設置爲下一次需要擴容的目標大小(toSize),創建完table數組對象後,初始化hashSeed:

    final boolean initHashSeedAsNeeded(int capacity) {
        boolean currentAltHashing = hashSeed != 0;
        boolean useAltHashing = sun.misc.VM.isBooted() &&
                (capacity >= Holder.ALTERNATIVE_HASHING_THRESHOLD);
        boolean switching = currentAltHashing ^ useAltHashing;
        if (switching) {
            hashSeed = useAltHashing
                ? sun.misc.Hashing.randomHashSeed(this)
                : 0;
        }
        return switching;
    }

只有當capacity大於ALTERNATIVE_HASHING_THRESHOLD且還沒有使用過可選hash因子時,纔會隨機一個值作爲hash因子,否則都是0;這個方法只會在初始化(相當於)inflateTable方法,和擴容方法 resize 才調用;當map的容量大於某個值時切換使用一個隨機的hash因子主要爲了減少hash值的重複;

下面具體看看null值的key處理:

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

可以看出null處理和put方法結果差不多,主要區別是null的hash值固定爲0,當然也不會存在不同key重複的hash值,所以索引index位置也不需要計算,也是0;

計算hash值的方法:

    final int hash(Object k) {
        int h = hashSeed;
        if (0 != h && k instanceof String) {
            return sun.misc.Hashing.stringHash32((String) k);
        }

        h ^= k.hashCode();

        // This function ensures that hashCodes that differ only by
        // constant multiples at each bit position have a bounded
        // number of collisions (approximately 8 at default load factor).
        h ^= (h >>> 20) ^ (h >>> 12);
        return h ^ (h >>> 7) ^ (h >>> 4);
    }

首先判斷了是否啓用了可選的hash因子,如果啓用了並且key是String類型,則使用特殊底層方法計算hash值;下面的具體的hash值算法,使用了很多的位移和異或操作,我們這裏只需要知道它的目的就是減少不同key的hash值等到相同值的發生,不深入去理解這算法設計爲什麼如此;

    static int indexFor(int h, int length) {
        // assert Integer.bitCount(length) == 1 : "length must be a non-zero power of 2";
        return h & (length-1);
    }

索引index方法,是得到hash值後,計算key對應的hash值應該放在哪個table的那個位置(index);對於這種需求:在一個定長的數組計算位置、位置值範圍爲0~~length-1、且 要儘可能均勻分散,我們一把最常使用的方法就是取模運算;這裏使用一個與運算的巧妙之處是與length有關的,table的length總是爲大於0的2的次冪數,所以length-1的值總是爲$2^x$,二進制就是(11…11),與運算後得到的結果肯定小於length-1,且能均分分佈;加上前面的hash計算算法,能有效的減少hash衝突碰撞;

接下來有必要先看看鍵值對Entry的實現,然後才繼續往下看addEntry方法:

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

        /**
         * Creates new entry.
         */
        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;
        }

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

        public final int hashCode() {
            return Objects.hashCode(getKey()) ^ Objects.hashCode(getValue());
        }

        public final String toString() {
            return getKey() + "=" + getValue();
        }

        /**
         * This method is invoked whenever the value in an entry is
         * overwritten by an invocation of put(k,v) for a key k that's already
         * in the HashMap.
         */
        void recordAccess(HashMap<K,V> m) {
        }

        /**
         * This method is invoked whenever the entry is
         * removed from the table.
         */
        void recordRemoval(HashMap<K,V> m) {
        }
    }

Entry實現也簡單易懂,記錄每個鍵值對key-value,以及key值的hash值,重要的是有一個next變量用於存儲hash衝突(key值hash 值相同)的情況,當有碰撞衝突是,next就相當於一個鏈表,後面會看到如何存儲和查找;equal的邏輯是key和value都相等才任務entry相等,這裏還有兩個接口方法是空實現的:recordAccess 方法在值替換的時候會被調用,recordRemoval 方法在值被移除的時候會被調用;

接下來繼續看 addEntry 方法:

    void addEntry(int hash, K key, V value, int bucketIndex) {
        if ((size >= threshold) && (null != table[bucketIndex])) {
            resize(2 * table.length);
            hash = (null != key) ? hash(key) : 0;
            bucketIndex = indexFor(hash, table.length);
        }

        createEntry(hash, key, value, bucketIndex);
    }

每次增加Entry都先判斷是否需要擴容:當前大小size是否大於等於閥值且本次需要存儲的index在table非空;所以size達到閥值並不是擴容的唯一條件,如果index的位置還是空,還可以繼續存儲不擴容,resize擴容方法,擴容目標直接是當前table長度的2倍,完成擴容後需要重新計算當前需要存儲key的hash值和index;

    void createEntry(int hash, K key, V value, int bucketIndex) {
        Entry<K,V> e = table[bucketIndex];
        table[bucketIndex] = new Entry<>(hash, key, value, e);
        size++;
    }

createEntry 方法是很簡單鏈表操作,這裏就可以看出Entry實現中next是如何使用的了;

    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, initHashSeedAsNeeded(newCapacity));
        table = newTable;
        threshold = (int)Math.min(newCapacity * loadFactor, MAXIMUM_CAPACITY + 1);
    }

resize 擴容方法只會由put和putAll方法觸發調用到,用於當容量達到閥值時增加table大小;首先判斷大小不能超過MAXIMUM_CAPACITY,然後新創建一個數組table,並且判斷是否需要重新hash:沒有切換hash因子 hashSeed就不需要重新hash,應該已存在的key 的hash值不會改變;

    void transfer(Entry[] newTable, boolean rehash) {
        int newCapacity = newTable.length;
        for (Entry<K,V> e : table) {
            while(null != e) {
                Entry<K,V> next = e.next;
                if (rehash) {
                    e.hash = null == e.key ? 0 : hash(e.key);
                }
                int i = indexFor(e.hash, newCapacity);
                e.next = newTable[i];
                newTable[i] = e;
                e = next;
            }
        }
    }

transfer 方法將原來table的entry轉換到newTable中;無論是否重hash,index都是需要重新索引的,因爲index值是與table長度有關,所以創建新table後長度改變需要重新索引;後面的就是鏈表操作了;

到這裏,添加鍵值對元素的相關主要方法差不多列舉完了,下面繼續看看獲取的方法:

    public V get(Object key) {
        if (key == null)
            return getForNullKey();
        Entry<K,V> entry = getEntry(key);

        return null == entry ? null : entry.getValue();
    }
    final Entry<K,V> getEntry(Object key) {
        if (size == 0) {
            return null;
        }

        int hash = (key == null) ? 0 : 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;
    }

與put方法類似,get的時候先計算hash值,然後計算索引值index,然後在鏈表做順序判斷key值相等的entry

最後我們來看下HashMap是如何實現迭代器的;Map的元素單位是key-value鍵值對,即是Entry,Map的迭代器其實就是Set的迭代器,Map不僅提供EntrySet,而且還區分開了:KeySet、valueSet,內部實現了的迭代器有:EntryIterator,KeyIterator,ValueIterator,而這個三個迭代器都繼承自一個基類:HashIterator:

    private abstract class HashIterator<E> implements Iterator<E> {
        Entry<K,V> next;        // next entry to return
        int expectedModCount;   // For fast-fail
        int index;              // current slot
        Entry<K,V> current;     // current entry

        HashIterator() {
            expectedModCount = modCount;
            if (size > 0) { // advance to first entry
                Entry[] t = table;
                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();

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

HashIterat 有4個私有變量:
next:迭代器實例下一個值
current:當前值
expectedModCount:修改值,併發修改快速失敗機制
index:next值在table的索引值
HashIterat 只有一個無參構造函數,創建實例是初始化私有變量:記錄expectedModCount 值,遍歷確認next值和index索引,默認current爲null;
與其他集合類相同,nextEntry、remove 等方法先判斷ModCount值,確認是否在迭代器創建後還發生過修改;nextEntry 方法遍歷找下一個值next,並設置current值爲原next值,放回current;remove就是直接從current獲取到key直接移除這個key的鍵值對;

其他三個迭代器EntryIterator,KeyIterator,ValueIterator,都是隻重寫next方法,簡單返回值:

    private final class ValueIterator extends HashIterator<V> {
        public V next() {
            return nextEntry().value;
        }
    }

    private final class KeyIterator extends HashIterator<K> {
        public K next() {
            return nextEntry().getKey();
        }
    }

    private final class EntryIterator extends HashIterator<Map.Entry<K,V>> {
        public Map.Entry<K,V> next() {
            return nextEntry();
        }
    }

對HashMap的源碼分析從變量、保存、獲取、迭代這幾個方法解析了HashMap的實現,當然源碼不止這一點,其他的方法不再一一列出解析;

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章