HashMap源碼詳解:Core Java 9.3

Map接口

keySet values size containsKey put remove
entrySet isEmpty containsValue get clear

以下爲部分JDK1.8添加的默認方法,default

getOrdefault(Object o,V v) replaceAll(BiFunction<K,V,V> f) remvoe(K k,V v)
forEach(BiConsumer<K,V> c) putIfAbsent(K k,V v) replace

Map.Entry接口

此接口是定義在Map接口內部的static的接口

getKey setValue comparingByKey comparingByKey(Comparator c)
getValue equals comparingByValue comparingByValue(Comparator c)

HashMap

源碼解析:

public class HashMap<K,V> extends AbstractMap<K,V>  implements Map<K,V>, Cloneable, Serializable {
定義一些默認值
	// table的初始大小默認值,即桶個數,必須是2的乘方
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
	// table的最大桶數
    static final int MAXIMUM_CAPACITY = 1 << 30;
	// 負載因子,建議0.5-1.5
    static final float DEFAULT_LOAD_FACTOR = 0.75f;
    
    // 當某個桶內元素個數等於此數時,會將桶內元素的存儲結構由單鏈表改爲紅黑樹
    static final int TREEIFY_THRESHOLD = 8;
    // 當桶內元素個數小於此數時,會將桶內元素的存儲結構由紅黑樹改爲單鏈表
    static final int UNTREEIFY_THRESHOLD = 6;
     // 當table的大小小於MIN_TREEIFY_CAPACITY ,但是某個桶內的元素個數達到了TREEIFY_THRESHOLD 後,並不會對這個桶做樹化操作,而是對map進行擴容resize()
    static final int MIN_TREEIFY_CAPACITY = 64;

然後定義了一個內部類,用於封裝桶的一種存儲結構-單鏈表的節點

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;
        }
    }
定義實例域

注意

  • 並沒有定義一個capacity實例域來指明table數組的大小,儘管類中定義了一個靜態常量DEFAULT_INITIAL_CAPACITY。
  • table數組的大小是在初始化時確定的:參看resize()方法。
  • 所有實例域的訪問控制都是默認的
 /* ---------------- Fields -------------- */

	// 裝桶的數組,存儲每個桶內的單鏈表的頭結點或者樹的根節點
    transient Node<K,V>[] table;
    
    transient Set<Map.Entry<K,V>> entrySet;

    // Map中已有的總元素個數
    transient int size;

	// 每次remove,add等都會++modCount,當併發時,發現自己的modCount不是原來的了,就會拋出異常,表示並行修改失敗
    transient int modCount;

    int threshold;

    final float loadFactor;
定義構造函數

注意:

  • 構造函數中不會初始化table數組
  • 如果用戶調用了hashMap(int capacity,int loadFactor),構造函數會調用tableSizeFor方法,直接把threshold設置爲大於或者等於capacity的一個值。因此用戶不必擔心自動擴容問題,因爲擴容只會在數據量>=threshold時發生,而此時threshold>=用戶給定的capacity一定成立。
  /* --------------------------構造函數,不會初始化table數組,table數組只有在首次調用put方法時纔會被初始化------ */
   
    //默認構造函數,只設置了loaderFactor的默認值,既不初始化capacity,也不初始化threashold,更不初始化table
   public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }
    // 會初始化loadFactor 、threshold 的值,但是不會定義table數組的大小
    // threshold = 大於initialCapacity的最小的2乘方(如,15 ->16 ,13->16)
 public HashMap(int initialCapacity, float loadFactor) {
       ...
        this.loadFactor = loadFactor;
        this.threshold = tableSizeFor(initialCapacity);
    }
    // 計算出大於cap的最小的2的乘方
    static final int tableSizeFor(int cap) {
        int n = cap - 1;
       
        n |= n >>> 1;  // 00001 0010 | 0000 1001 -> 11011
        n |= n >>> 2;  //  0001 1011 | 0000 0110 -> 11111
        n |= n >>> 4;  //  0001 1111 | 0000 0001 -> 11111
        n |= n >>> 8;  //  
        n |= n >>> 16;
        return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
    }
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }
put方法
  • 如果table還未被初始化,則調用resize()進行初始化
  • 如果散列到桶中之後,桶內元素個數>=TREEIFY_THRESHOLD ,則調用treeifyBin()方法檢查是否要將桶改爲紅黑樹結構
  • 如果散列到Map中之後,Map中元素個數>=threshold了,則調用resize()方法進行擴容
    /* ------------------------------put方法------------------------------------------ */
    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;  // n:table的大小。i:當前節點的桶號
        // 如果還未被初始化過,則調用resize(); HashMap在首次調用put方法之前,是不會初始化table的,因爲那樣的話會浪費一塊連續內存。
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        // 根據key的哈希值,確定桶號,如果沒有獲取到桶的鏈表的頭結點,則直接將其作爲頭結點存儲到桶中
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        // 獲取到了頭結點
        else {
            Node<K,V> e; // 目標節點)
            K k;
            // 如果頭結點的key和新節點的key相同,則頭結點即爲要被取代的目標節點
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            // 如果頭結點是TreeNode類型的,則調用putTreeVal方法將新節點插入,並返回插入後的目標節點
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
			// 桶還未滿
            else {
            	
                for (int binCount = 0; ; ++binCount) {
                	// 目標指針指向鏈表中的下一個元素
                    if ((e = p.next) == null) {
                    	// 如果沒有找到key相同的節點,就直接追加到鏈表尾部
                        p.next = newNode(hash, key, value, null);
                        // 如果桶中元素數是達到了設定的變樹閾值(默認值8),則需要將桶內元素的存儲結構更新爲紅黑樹
                        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;
                }
            }
            // map中有與新節點的key相同的元素,那麼根據條件做一些操作,就返回
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                // onlyIfAbsent 是方法參數,表示只有不存在相同key的節點時,才進行更新操作,如果有相同節點,則不做任何操作。
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);  //此處是留給LinkedHashMap用的。
                return oldValue;
            }
        } // else結束
        // 更新了hashMap,就執行++modCount;
        ++modCount;
        // 當map中的元素數量大於閾值,就要擴容再散列
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }
對table數組初始化 \ 擴容

resize()方法內有兩種邏輯:

  • 一種是當前table爲null時,會對table進行初始化操作;
  • 一種是當前table非null,會對table進行擴容操作;
    final Node<K,V>[] resize() {
    	// 當前table
        Node<K,V>[] oldTab = table;
        // 當前table的大小
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        // 當前的閾值
        int oldThr = threshold;
        int newCap, newThr = 0;
        // oldCap>0,說明是要做擴容操作
        if (oldCap > 0) {
	        // 如果原本的table的大小已經是最大值,無法繼續擴容,直接退出
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            // 擴容:設置新的table的大小爲原來的2倍,新的threshold也爲原來的2背
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
        // oldCap<= 0,說明是要進行初始化table的操作;oldThr>0,說明用戶調用的有參構造函數,設置了threshold;直接將根據用戶參數計算出的閾值設定爲table的大小
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        // oldCap<= 0,說明是要進行初始化table的操作;oldThr<0,說明用戶調用的默認無參構造函數;則將各個域變量的值設置爲默認值。
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        // 如果經過以上設置,newThr 仍爲0,(什麼情況下會出現?)
        if (newThr == 0) {
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                      (int)ft : Integer.MAX_VALUE);
        }
        threshold = newThr;
        
		// 無論是要初始化table,還是要對table進行擴容,經過以上邏輯,都已經確定了要新創建的table的大小、threshold 。
        @SuppressWarnings({"rawtypes","unchecked"})
            Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        table = newTab;
        // 如果當前table不爲null,說明需要進行擴容操作
        if (oldTab != null) {
            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)
                        ((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;
    }
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章