HashMap源碼解析

HashMap簡介


  • HashMap是基于哈希表實現(xiàn)的,每一個元素都是一個key-value對,其內(nèi)部通過單鏈表解決沖突問題,容量不足(超過了閾值)時,同樣會自動增長。
  • HashMap是非線程安全的,只是用于單線程環(huán)境下,多線程環(huán)境下可以采用concurrent并發(fā)包下的concurrentHashMap。
  • HashMap實現(xiàn)了Serializable接口,因此它支持序列化,實現(xiàn)了Cloneable接口,能被克隆。

HashMap源碼剖析


HashMap的源碼如下(加入了比較詳細的注釋):

package java.util;    
import java.io.*;    

public class HashMap<K,V>    
    extends AbstractMap<K,V>    
    implements Map<K,V>, Cloneable, Serializable    
{    

    // 默認的初始容量(容量為HashMap中槽的數(shù)目)是16,且實際容量必須是2的整數(shù)次冪。    
    static final int DEFAULT_INITIAL_CAPACITY = 16;    

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

    // 默認加載因子為0.75   
    static final float DEFAULT_LOAD_FACTOR = 0.75f;    

    // 存儲數(shù)據(jù)的Entry數(shù)組,長度是2的冪。    
    // HashMap采用鏈表法解決沖突,每一個Entry本質(zhì)上是一個單向鏈表    
    transient Entry[] table;    

    // HashMap的底層數(shù)組中已用槽的數(shù)量    
    transient int size;    

    // HashMap的閾值,用于判斷是否需要調(diào)整HashMap的容量(threshold = 容量*加載因子)    
    int threshold;    

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

    // HashMap被改變的次數(shù)    
    transient volatile int modCount;    

    // 指定“容量大小”和“加載因子”的構(gòu)造函數(shù)    
    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;    
        //加載因此不能小于0  
        if (loadFactor <= 0 || Float.isNaN(loadFactor))    
            throw new IllegalArgumentException("Illegal load factor: " +    
                                               loadFactor);    

        // 找出“大于initialCapacity”的最小的2的冪    
        int capacity = 1;    
        while (capacity < initialCapacity)    
            capacity <<= 1;    

        // 設(shè)置“加載因子”    
        this.loadFactor = loadFactor;    
        // 設(shè)置“HashMap閾值”,當(dāng)HashMap中存儲數(shù)據(jù)的數(shù)量達到threshold時,就需要將HashMap的容量加倍。    
        threshold = (int)(capacity * loadFactor);    
        // 創(chuàng)建Entry數(shù)組,用來保存數(shù)據(jù)    
        table = new Entry[capacity];    
        init();    
    }    


    // 指定“容量大小”的構(gòu)造函數(shù)    
    public HashMap(int initialCapacity) {    
        this(initialCapacity, DEFAULT_LOAD_FACTOR);    
    }    

    // 默認構(gòu)造函數(shù)。    
    public HashMap() {    
        // 設(shè)置“加載因子”為默認加載因子0.75    
        this.loadFactor = DEFAULT_LOAD_FACTOR;    
        // 設(shè)置“HashMap閾值”,當(dāng)HashMap中存儲數(shù)據(jù)的數(shù)量達到threshold時,就需要將HashMap的容量加倍。    
        threshold = (int)(DEFAULT_INITIAL_CAPACITY * DEFAULT_LOAD_FACTOR);    
        // 創(chuàng)建Entry數(shù)組,用來保存數(shù)據(jù)    
        table = new Entry[DEFAULT_INITIAL_CAPACITY];    
        init();    
    }    

    // 包含“子Map”的構(gòu)造函數(shù)    
    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);    
    }    

    //求hash值的方法,重新計算hash值  
    static int hash(int h) {    
        h ^= (h >>> 20) ^ (h >>> 12);    
        return h ^ (h >>> 7) ^ (h >>> 4);    
    }    

    // 返回h在數(shù)組中的索引值,這里用&代替取模,旨在提升效率   
    // 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對應(yīng)的value    
    public V get(Object key) {    
        if (key == null)    
            return getForNullKey();    
        // 獲取key的hash值    
        int hash = hash(key.hashCode());    
        // 在“該hash值對應(yīng)的鏈表”上查找“鍵值等于key”的元素    
        for (Entry<K,V> e = table[indexFor(hash, table.length)];    
             e != null;    
             e = e.next) {    
            Object k;    
            //判斷key是否相同  
            if (e.hash == hash && ((k = e.key) == key || key.equals(k)))    
                return e.value;    
        }  
        //沒找到則返回null  
        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”的則調(diào)用hash()計算哈希值    
        int hash = (key == null) ? 0 : hash(key.hashCode());    
        // 在“該hash值對應(yīng)的鏈表”上查找“鍵值等于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的哈希值,然后將其添加到該哈希值對應(yīng)的鏈表中。    
        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”對應(yīng)的鍵值對已經(jīng)存在,則用新的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”對應(yīng)的鍵值對不存在,則將“key-value”添加到table中    
        modCount++;  
        //將key-value添加到table[i]處  
        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;    
            }    
        }    
        // 如果沒有存在key為null的鍵值對,則直接移動到table[0]處!    
        modCount++;    
        addEntry(0, null, value, 0);    
        return null;    
    }    

    // 創(chuàng)建HashMap對應(yīng)的“添加方法”,    
    // 它和put()不同。putForCreate()是內(nèi)部方法,它被構(gòu)造函數(shù)等調(diào)用,用來創(chuàng)建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中。    
    // 該方法被內(nèi)部的構(gòu)造HashMap的方法所調(diào)用。    
    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());    
        }    
    }    

    // 重新調(diào)整HashMap的大小,newCapacity是調(diào)整后的容量    
    void resize(int newCapacity) {    
        Entry[] oldTable = table;    
        int oldCapacity = oldTable.length;   
        //如果就容量已經(jīng)達到了最大值,則不能再擴容,直接返回  
        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;    

        // 計算容量是否足夠,    
        // 若“當(dāng)前閥值容量 < 需要的容量”,則將容量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;否則調(diào)用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”的元素    
        // 本質(zhì)是“刪除單向鏈表中的節(jié)點”    
        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”    
        // 本質(zhì)是“刪除單向鏈表中的節(jié)點”    
        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,將所有的元素設(shè)為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”,則調(diào)用containsNullValue()查找    
    if (value == null)    
            return containsNullValue();    

    // 若“value不為null”,則查找HashMap中是否有值為value的節(jié)點。    
    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();    
        // 調(diào)用putAllForCreate()將全部元素添加到HashMap中    
        result.putAllForCreate(this);    

        return result;    
    }    

    // Entry是單向鏈表。    
    // 它是 “HashMap鏈?zhǔn)酱鎯Ψā睂?yīng)的鏈表。    
    // 它實現(xiàn)了Map.Entry 接口,即實現(xiàn)getKey(), getValue(), setValue(V value), equals(Object o), hashCode()這些函數(shù)。
    static class Entry<K,V> implements Map.Entry<K,V> {    
        final K key;    
        V value;    
        // 指向下一個節(jié)點    
        Entry<K,V> next;    
        final int hash;    

        // 構(gòu)造函數(shù)。    
        // 輸入?yún)?shù)包括"哈希值(h)", "鍵(k)", "值(v)", "下一節(jié)點(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;    
        }    

        // 實現(xiàn)hashCode()    
        public final int hashCode() {    
            return (key==null   ? 0 : key.hashCode()) ^    
                   (value==null ? 0 : value.hashCode());    
        }    

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

        // 當(dāng)向HashMap中添加元素時,繪調(diào)用recordAccess()。    
        // 這里不做任何處理    
        void recordAccess(HashMap<K,V> m) {    
        }    

        // 當(dāng)從HashMap中刪除元素時,繪調(diào)用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];    
        // 設(shè)置“bucketIndex”位置的元素為“新Entry”,    
        // 設(shè)置“e”為“新Entry的下一個節(jié)點”    
        table[bucketIndex] = new Entry<K,V>(hash, key, value, e);    
        // 若HashMap的實際大小 不小于 “閾值”,則調(diào)整HashMap的大小    
        if (size++ >= threshold)    
            resize(2 * table.length);    
    }    

    // 創(chuàng)建Entry。將“key-value”插入指定位置。    
    void createEntry(int hash, K key, V value, int bucketIndex) {    
        // 保存“bucketIndex”位置的值到“e”中    
        Entry<K,V> e = table[bucketIndex];    
        // 設(shè)置“bucketIndex”位置的元素為“新Entry”,    
        // 設(shè)置“e”為“新Entry的下一個節(jié)點”    
        table[bucketIndex] = new Entry<K,V>(hash, key, value, e);    
        size++;    
    }    

    // HashIterator是HashMap迭代器的抽象出來的父類,實現(xiàn)了公共了函數(shù)。    
    // 它包含“key迭代器(KeyIterator)”、“Value迭代器(ValueIterator)”和“Entry迭代器(EntryIterator)”3個子類。    
    private abstract class HashIterator<E> implements Iterator<E> {    
        // 下一個元素    
        Entry<K,V> next;    
        // expectedModCount用于實現(xiàn)fast-fail機制。    
        int expectedModCount;    
        // 當(dāng)前索引    
        int index;    
        // 當(dāng)前元素    
        Entry<K,V> current;    

        HashIterator() {    
            expectedModCount = modCount;    
            if (size > 0) { // advance to first entry    
                Entry[] t = table;    
                // 將next指向table中第一個不為null的元素。    
                // 這里利用了index的初始值為0,從0開始依次向后遍歷,直到找到不為null的元素就退出循環(huán)。    
                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的下一個節(jié)點不為空,就將next指向下一個節(jié)點;    
            // 否則,將next指向下一個鏈表(也是下一個Entry)的不為null的節(jié)點。    
            if ((next = e.next) == null) {    
                Entry[] t = table;    
                while (index < t.length && (next = t[index++]) == null)    
                    ;    
            }    
            current = e;    
            return e;    
        }    

        // 刪除當(dāng)前元素    
        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對應(yīng)的集合    
    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對應(yīng)的集合    
    // KeySet繼承于AbstractSet,說明該集合中沒有重復(fù)的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中的元素能夠重復(fù)。因為不同的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對應(yīng)的集合    
    // EntrySet繼承于AbstractSet,說明該集合中沒有重復(fù)的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的寫入函數(shù)    
    // 將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的讀取函數(shù):根據(jù)寫入方式讀出    
    // 將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;   }    
}   

幾點總結(jié)


1. 首先要清楚HashMap的存儲結(jié)構(gòu),如下圖所示:


圖中,紫色部分即代表哈希表,也稱為哈希數(shù)組,數(shù)組的每個元素都是一個單鏈表的頭節(jié)點,鏈表是用來解決沖突的,如果不同的key映射到了數(shù)組的同一位置處,就將其放入單鏈表中。

2. 首先看鏈表中節(jié)點的數(shù)據(jù)結(jié)構(gòu):

// Entry是單向鏈表。    
// 它是 “HashMap鏈?zhǔn)酱鎯Ψā睂?yīng)的鏈表。    
// 它實現(xiàn)了Map.Entry 接口,即實現(xiàn)getKey(), getValue(), setValue(V value), equals(Object o), hashCode()這些函數(shù)    
static class Entry<K,V> implements Map.Entry<K,V> {    
    final K key;    
    V value;    
    // 指向下一個節(jié)點    
    Entry<K,V> next;    
    final int hash;    

    // 構(gòu)造函數(shù)。    
    // 輸入?yún)?shù)包括"哈希值(h)", "鍵(k)", "值(v)", "下一節(jié)點(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;    
    }    

    // 實現(xiàn)hashCode()    
    public final int hashCode() {    
        return (key==null   ? 0 : key.hashCode()) ^    
               (value==null ? 0 : value.hashCode());    
    }    

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

    // 當(dāng)向HashMap中添加元素時,繪調(diào)用recordAccess()。    
    // 這里不做任何處理    
    void recordAccess(HashMap<K,V> m) {    
    }    

    // 當(dāng)從HashMap中刪除元素時,繪調(diào)用recordRemoval()。    
    // 這里不做任何處理    
    void recordRemoval(HashMap<K,V> m) {    
    }    
}    

它的結(jié)構(gòu)元素除了key、value、hash外,還有next,next指向下一個節(jié)點。另外,這里覆寫了equals和hashCode方法來保證鍵值對的獨一無二。

3. HashMap共有四個構(gòu)造方法。構(gòu)造方法中提到了兩個很重要的參數(shù):初始容量和加載因子。這兩個參數(shù)是影響HashMap性能的重要參數(shù),其中容量表示哈希表中槽的數(shù)量(即哈希數(shù)組的長度),初始容量是創(chuàng)建哈希表時的容量(從構(gòu)造函數(shù)中可以看出,如果不指明,則默認為16),加載因子是哈希表在其容量自動增加之前可以達到多滿的一種尺度,當(dāng)哈希表中的條目數(shù)超出了加載因子與當(dāng)前容量的乘積時,則要對該哈希表進行 resize 操作(即擴容)。

下面說下加載因子,如果加載因子越大,對空間的利用更充分,但是查找效率會降低(鏈表長度會越來越長);如果加載因子太小,那么表中的數(shù)據(jù)將過于稀疏(很多空間還沒用,就開始擴容了),對空間造成嚴重浪費。如果我們在構(gòu)造方法中不指定,則系統(tǒng)默認加載因子為0.75,這是一個比較理想的值,一般情況下我們是無需修改的。

另外,無論我們指定的容量為多少,構(gòu)造方法都會將實際容量設(shè)為不小于指定容量的2的次方的一個數(shù),且最大值不能超過2的30次方。

4. HashMap中key和value都允許為null。

5. 要重點分析下HashMap中用的最多的兩個方法put和get。先從比較簡單的get方法著手,源碼如下:

// 獲取key對應(yīng)的value    
public V get(Object key) {    
    if (key == null)    
        return getForNullKey();    
    // 獲取key的hash值    
    int hash = hash(key.hashCode());    
    // 在“該hash值對應(yīng)的鏈表”上查找“鍵值等于key”的元素    
    for (Entry<K,V> e = table[indexFor(hash, table.length)];    
         e != null;    
         e = e.next) {    
        Object k;    
/判斷key是否相同  
        if (e.hash == hash && ((k = e.key) == key || key.equals(k)))    
            return e.value;    
    }  
沒找到則返回null  
    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;    
}    

首先,如果key為null,則直接從哈希表的第一個位置table[0]對應(yīng)的鏈表上查找。記住,key為null的鍵值對永遠都放在以table[0]為頭結(jié)點的鏈表中,當(dāng)然不一定是存放在頭結(jié)點table[0]中。

如果key不為null,則先求的key的hash值,根據(jù)hash值找到在table中的索引,在該索引對應(yīng)的單鏈表中查找是否有鍵值對的key與目標(biāo)key相等,有就返回對應(yīng)的value,沒有則返回null。

put方法稍微復(fù)雜些,代碼如下:

  // 將“key-value”添加到HashMap中    
  public V put(K key, V value) {    
      // 若“key為null”,則將該鍵值對添加到table[0]中。    
      if (key == null)    
          return putForNullKey(value);    
      // 若“key不為null”,則計算該key的哈希值,然后將其添加到該哈希值對應(yīng)的鏈表中。    
      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”對應(yīng)的鍵值對已經(jīng)存在,則用新的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”對應(yīng)的鍵值對不存在,則將“key-value”添加到table中    
      modCount++;  
//將key-value添加到table[i]處  
      addEntry(hash, key, value, i);    
      return null;    
  }   

如果key為null,則將其添加到table[0]對應(yīng)的鏈表中,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;    
}   

如果key不為null,則同樣先求出key的hash值,根據(jù)hash值得出在table中的索引,而后遍歷對應(yīng)的單鏈表,如果單鏈表中存在與目標(biāo)key相等的鍵值對,則將新的value覆蓋舊的value,比將舊的value返回,如果找不到與目標(biāo)key相等的鍵值對,或者該單鏈表為空,則將該鍵值對插入到改單鏈表的頭結(jié)點位置(每次新插入的節(jié)點都是放在頭結(jié)點的位置),該操作是有addEntry方法實現(xiàn)的,它的源碼如下:

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

注意這里倒數(shù)第三行的構(gòu)造方法,將key-value鍵值對賦給table[bucketIndex],并將其next指向元素e,這便將key-value放到了頭結(jié)點中,并將之前的頭結(jié)點接在了它的后面。該方法也說明,每次put鍵值對的時候,總是將新的該鍵值對放在table[bucketIndex]處(即頭結(jié)點處)。

兩外注意最后兩行代碼,每次加入鍵值對時,都要判斷當(dāng)前已用的槽的數(shù)目是否大于等于閥值(容量*加載因子),如果大于等于,則進行擴容,將容量擴為原來容量的2倍。

6. 關(guān)于擴容。上面我們看到了擴容的方法,resize方法,它的源碼如下:

// 重新調(diào)整HashMap的大小,newCapacity是調(diào)整后的單位    
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的底層數(shù)組,而后調(diào)用transfer方法,將就HashMap的全部元素添加到新的HashMap中(要重新計算元素在新的數(shù)組中的索引位置)。transfer方法的源碼如下:

// 將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);    
        }    
    }    
}    

很明顯,擴容是一個相當(dāng)耗時的操作,因為它需要重新計算這些元素在新的數(shù)組中的位置并進行復(fù)制處理。因此,我們在用HashMap的時,最好能提前預(yù)估下HashMap中元素的個數(shù),這樣有助于提高HashMap的性能。

7. 注意containsKey方法和containsValue方法。前者直接可以通過key的哈希值將搜索范圍定位到指定索引對應(yīng)的鏈表,而后者要對哈希數(shù)組的每個鏈表進行搜索。

8. 我們重點來分析下求hash值和索引值的方法,這兩個方法便是HashMap設(shè)計的最為核心的部分,二者結(jié)合能保證哈希表中的元素盡可能均勻地散列。

計算哈希值的方法如下:

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

它只是一個數(shù)學(xué)公式,IDK這樣設(shè)計對hash值的計算,自然有它的好處,至于為什么這樣設(shè)計,我們這里不去追究,只要明白一點,用的位的操作使hash值的計算效率很高。

由hash值找到對應(yīng)索引的方法如下:

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

這個我們要重點說下,我們一般對哈希表的散列很自然地會想到用hash值對length取模(即除法散列法),Hashtable中也是這樣實現(xiàn)的,這種方法基本能保證元素在哈希表中散列的比較均勻,但取模會用到除法運算,效率很低,HashMap中則通過h&(length-1)的方法來代替取模,同樣實現(xiàn)了均勻的散列,但效率要高很多,這也是HashMap對Hashtable的一個改進。

接下來,我們分析下為什么哈希表的容量一定要是2的整數(shù)次冪。首先,length為2的整數(shù)次冪的話,h&(length-1)就相當(dāng)于對length取模,這樣便保證了散列的均勻,同時也提升了效率;其次,length為2的整數(shù)次冪的話,為偶數(shù),這樣length-1為奇數(shù),奇數(shù)的最后一位是1,這樣便保證了h&(length-1)的最后一位可能為0,也可能為1(這取決于h的值),即與后的結(jié)果可能為偶數(shù),也可能為奇數(shù),這樣便可以保證散列的均勻性,而如果length為奇數(shù)的話,很明顯length-1為偶數(shù),它的最后一位是0,這樣h&(length-1)的最后一位肯定為0,即只能為偶數(shù),這樣任何hash值都只會被散列到數(shù)組的偶數(shù)下標(biāo)位置上,這便浪費了近一半的空間,因此,length取2的整數(shù)次冪,是為了使不同hash值發(fā)生碰撞的概率較小,這樣就能使元素在哈希表中均勻地散列。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容