Java1.7全網最深入HashMap源碼解析

transient Entry[] table;  //位桶數組

/** 
 * Entry類實現瞭Map.Entry接口
 * 即 實現瞭getKey()、getValue()、equals(Object o)和hashCode()等方法
**/  
static class Entry<K,V> implements Map.Entry<K,V> {
    final K key;  // 鍵
    V value;  // 值
    Entry<K,V> next; // next指針
    int hash;  //hashCode()方法計算出的hash值
  
    /** 
     * 構造方法，創建一個Entry 
     * 參數：哈希值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;  
    }  
    
   /** 
     * equals（）
     * 作用：判斷2個Entry是否相等，必須key和value都相等，才返回true  
     */ 
      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 Objects.hashCode(getKey()) ^ Objects.hashCode(getValue());  
    }  
  
    public final String toString() {  
        return getKey() + "=" + getValue();  
    }  
  
    /** 
     * 當向HashMap中添加元素時，即調用put(k,v)時， 
     * 對已經在HashMap中k位置進行v的覆蓋時，會調用此方法 
     * 此處沒做任何處理 
     */  
    void recordAccess(HashMap<K,V> m) {  
    }  
  
    /** 
     * 當從HashMap中刪除瞭一個Entry時，會調用該函數 
     * 此處沒做任何處理 
     */  
    void recordRemoval(HashMap<K,V> m) {  
    } 
}

// 1. 容量（capacity）： HashMap中數組的長度
// a. 容量范圍：必須是2的冪 & <最大容量（2的30次方）
// b. 初始容量 = 哈希表創建時的容量
  // 默認容量 = 16 = 1<<4 = 00001中的1向左移4位 = 10000 = 十進制的2^4=16
  static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;

  // 最大容量 =  2的30次方（若傳入的容量過大，將被最大值替換）
  static final int MAXIMUM_CAPACITY = 1 << 30;

// 2. 加載因子(Load factor)：HashMap在其容量自動增加前可達到多滿的一種尺度
// a. 加載因子越大、填滿的元素越多 = 空間利用率高、但沖突的機會加大、查找效率變低（因為鏈表變長瞭）
// b. 加載因子越小、填滿的元素越少 = 空間利用率小、沖突的機會減小、查找效率高（鏈表不長）
  // 實際加載因子
  final float loadFactor;
  // 默認加載因子 = 0.75
  static final float DEFAULT_LOAD_FACTOR = 0.75f;

// 3. 擴容閾值（threshold）：當哈希表的大小 ≥ 擴容閾值時，就會擴容哈希表（即擴充HashMap的容量） 
// a. 擴容 = 對哈希表進行resize操作（即重建內部數據結構），從而哈希表將具有大約兩倍的桶數
// b. 擴容閾值 = 容量 x 加載因子
  int threshold;

    //默認的threshold值  
    static final int ALTERNATIVE_HASHING_THRESHOLD_DEFAULT = Integer.MAX_VALUE;

// 4. 其他
 // 存儲數據的Entry類型 數組，長度 = 2的冪
 // HashMap的實現方式 = 拉鏈法，Entry數組上的每個元素本質上是一個單向鏈表
  transient Entry<K,V>[] table = (Entry<K,V>[]) EMPTY_TABLE;  


//HashMap內部的存儲結構是一個數組，此處數組為空，即沒有初始化之前的狀態  
static final Entry<?,?>[] EMPTY_TABLE = {};  

 // HashMap的大小，即 HashMap中存儲的鍵值對的數量
  transient int size;
 

    
  /**
     * 構造函數1：默認構造函數（無參）
		實際上是調用構造函數3：指定“容量大小”和“加載因子”的構造函數
     */
    public HashMap() {
     
        // 傳入默認的容量（16）和負載因子（0.75）
        this(DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR); 
    }

    /**
     * 構造函數2：指定“容量大小”的構造函數
     實際上是調用指定“容量大小”和“加載因子”的構造函數
     */
    public HashMap(int initialCapacity) {
        
        // 傳入指定的容量，和默認的負載因子
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
        
    }

    /**
     * 構造函數3：指定“容量大小”和“加載因子”的構造函數
     * 加載因子 & 容量都由自己指定
     */
    public HashMap(int initialCapacity, float loadFactor) {

        // HashMap的最大容量隻能是MAXIMUM_CAPACITY，哪怕傳入的 > 最大容量
        //如果大於最大容量，還是賦值為1 << 30
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;

        // 設置 加載因子
        this.loadFactor = loadFactor;
        
        // 設置 擴容閾值 = 初始容量
        // 註：此處不是真正的閾值，是為瞭擴展table，該閾值後面會重新計算
        threshold = initialCapacity;   

        init(); // 一個空方法用於未來的子對象擴展
    }

    /**
     * 構造函數4：包含“子Map”的構造函數
     * 即 構造出來的HashMap包含傳入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);

        // 該方法用於初始化 數組 & 閾值，下面會詳細說明
        inflateTable(threshold);

        // 將傳入的子Map中的全部元素逐個添加到HashMap中
        putAllForCreate(m);
    }
}

   /**
     * 確定位桶數組下標主要分為2步：計算hash值、根據hash值再計算得出最後數組位置
     */
        // a. 根據鍵值key計算hash值 ->> 分析1
        int hash = hash(key);
        // b. 根據hash值 最終獲得 key對應存放的數組Table中位置 ->> 分析2
        int i = indexFor(hash, table.length);

     // JDK 1.7實現：將 鍵key 轉換成 哈希碼（hash值）操作  = 使用hashCode() + 4次位運算 + 5次異或運算（9次擾動）
     static final int hash(int h) {
        h ^= k.hashCode(); 
        h ^= (h >>> 20) ^ (h >>> 12);
        return h ^ (h >>> 7) ^ (h >>> 4);
     }

      // JDK 1.8實現：將 鍵key 轉換成 哈希碼（hash值）操作 = 使用hashCode() + 1次位運算 + 1次異或運算（2次擾動）
      // 1. 取hashCode值： h = key.hashCode() 
     //  2. 高位參與低位的運算：h ^ (h >>> 16)  
      static final int hash(Object key) {
           int h;
            return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
            // a. 當key = null時，hash值 = 0，所以HashMap的key 可為null      
            // 註：對比HashTable，HashTable對key直接hashCode（），若key為null時，會拋出異常，所以HashTable的key不可為null
            // b. 當key ≠ null時，則通過先計算出 key的 hashCode()（記為h），然後 對哈希碼進行 擾動處理： 按位 異或（^） 哈希碼自身右移16位後的二進制
     }

   /**
     * 函數源碼分析2：indexFor(hash, table.length)
     * JDK 1.8中實際上無該函數，但原理相同，即具備類似作用的函數
     */
      static int indexFor(int h, int length) {  
          return h & (length-1); 
          // 將對哈希碼擾動處理後的結果 與運算(&) （數組長度-1），最終得到存儲在數組table的位置（即數組下標、索引）
}

 /**
   * 函數使用原型
   */
   map.put("name", "huangkaiyu");
   map.put("age", 21);


    public V put(K key, V value)
		// 1.如果哈希表未初始化（即 table為空) 
        if (table == EMPTY_TABLE) { 
        // 則使用構造函數傳入的閾值(即初始容量) 初始化數組table  
        inflateTable(threshold); 
    }  


        // 2. 判斷key是否為空值null
		// 若key == null，則將該鍵值對放在table [0]（本質：key = Null時，hash值 = 0，故存放到table[0]中）
        if (key == null)
            return putForNullKey(value);

		 //若 key ≠ null，則計算存放數組 table 中的位置（下標、索引）
		
		//計算hash值
        int hash = hash(key);
       //傳入hash值和table長度算出index
        int i = indexFor(hash, table.length);

        // 3. 遍歷table[indexFor]對應的鏈表判斷該key對應的值是否已存在
        for (Entry<K,V> e = table[i]; e != null; e = e.next) {
            Object k;
    	//若該key已存在（即 key-value已存在 ），則用替換原來的值
            if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
                V oldValue = e.value;
                e.value = value;
                e.recordAccess(this);
                return oldValue; //並返回舊的value
            }
        }
		//改動計數器+1
        modCount++;

		// 若該key不存在，則將“key-value”添加到table中
        addEntry(hash, key, value, i);
        return null;
    }

   /**
     * put中調用
     */
      if (table == EMPTY_TABLE) { 
         //此處傳入的是構造函數時設置的閾值(即初始容量)，不是真正的擴容閾值
        inflateTable(threshold); 
    }  

 	
     private void inflateTable(int toSize) {  
    
    // 1. 將傳入的容量大小轉化為：>傳入容量大小的最小的2的次冪（傳入18轉化得32）
    int capacity = roundUpToPowerOf2(toSize);   

    // 2. 重新計算閾值 threshold = 容量 * 加載因子（之前存的是容量）
    threshold = (int) Math.min(capacity * loadFactor, MAXIMUM_CAPACITY + 1);  

    // 3.傳入容量初始化位桶數組table（作為數組長度）
    table = new Entry[capacity];  
    
 
    initHashSeedAsNeeded(capacity);  
}  

    /**
     * roundUpToPowerOf2(toSize)
     * 作用：將傳入的容量大小轉化為：>傳入容量大小的最小的2的冪
     * 特別註意：容量大小必須為2的冪
     */

     private static int roundUpToPowerOf2(int number) {  
   
       //若超過瞭最大值，則設置為最大值；否則，設置為大於傳入容量大小的最小的2的次冪
       return number >= MAXIMUM_CAPACITY  ? 
            MAXIMUM_CAPACITY  : (number > 1) ? Integer.highestOneBit((number - 1) << 1) : 1;  

   /**
     *  put()方法調用時 傳入的key為空
     */
      if (key == null)
           return putForNullKey(value);
		
   	 /**
     * 遍歷以table[0]為首的鏈表，尋找是否存在key==null 對應的鍵值對
     	有就替換並返回舊值，沒有就調用addEntry（）將（null，value）添加到鏈表中
     */
      private V putForNullKey(V value) {  

     
        for (Entry<K,V> e = table[0]; e != null; e = e.next) { 
          //如果鏈表結點key為空
          if (e.key == null) {
            //保存舊值
            V oldValue = e.value;
            //鏈表賦新值
            e.value = value;  
            e.recordAccess(this);  
             //返回舊值
            return oldValue;  
        }  
    }  
    //改動次數+1
    modCount++;  

    // 若沒有key==null的鍵，那麼調用addEntry（）將其加入鏈表
    addEntry(0, null, value, 0); 
          
    // a. addEntry（）的第1個參數hash值傳入0（當key = null時，也有hash值 = 0，所以HashMap的key 可為null）

    // c. 對比HashTable，由於HashTable對key直接hashCode（），若key為null時，會拋出異常，所以HashTable的key不可為null
    // d. 此處隻需知道是將 key-value 添加到HashMap中即可，關於addEntry（）的源碼分析將等到下面再詳細說明，
    return null;  

}     

      /**
        * put中key不存在調用，將Entry對象存入鏈表
        */

      void addEntry(int hash, K key, V value, int bucketIndex) {  

          
          // 1. 插入前先判斷是否需要擴容
          
          // 如果元素個數>=擴容閾值 並且 對應數組下標不為空
          if ((size >= threshold) && (null != table[bucketIndex])) { 
            
            //擴容2倍
            resize(2 * table.length); 
             // 重新計算Key對應的hash值   
            hash = (null != key) ? hash(key) : 0;
          	 // 重新計算該Key對應的hash值的存儲數組下標位置 
            bucketIndex = indexFor(hash, table.length);  
    }  

    //如果不需要擴容，則創建1個新的Entry並放入到數組中
    createEntry(hash, key, value, bucketIndex);  
}  

 /**
   * 分析2：createEntry(hash, key, value, bucketIndex);  
   * 作用： 若容量足夠，則創建1個新的數組元素（Entry） 並放入到數組中
   */  
void createEntry(int hash, K key, V value, int bucketIndex) { 

    // 1. 把table中該位置原來的Entry保存  
    Entry<K,V> e = table[bucketIndex];

    // 2. 在table中該位置新建一個Entry：將原頭結點位置（數組上）的鍵值對 放入到（鏈表）後1個節點中、將需插入的鍵值對 放入到頭結點中（數組上）-> 從而形成鏈表
    // 即 在插入元素時，是在鏈表頭插入的，table中的每個位置永遠隻保存最新插入的Entry，舊的Entry則放入到鏈表中（即 解決Hash沖突）
    table[bucketIndex] = new Entry<>(hash, key, value, e);  

    // 3. 哈希表的鍵值對數量計數增加
    size++;  
}   

 /**
   * resize(2 * table.length)
   * 作用：當容量不足時（容量 > 閾值），則擴容（擴到2倍）
   */ 
   void resize(int newCapacity) {  
    
    // 1. 保存舊數組（old table） 
    Entry[] oldTable = table;  

    // 2. 保存舊容量（數組長度）
    int oldCapacity = oldTable.length; 

    // 3. 若舊容量已經是系統默認最大容量瞭，那麼將擴容閾值設置成整型的最大值，退出 
    if (oldCapacity == MAXIMUM_CAPACITY) {  
        threshold = Integer.MAX_VALUE;  
        return; 
    }  

    // 4. 根據新容量（2倍容量）新建1個數組，即新table  
    Entry[] newTable = new Entry[newCapacity];  

    // 5. 將舊數組上的數據（鍵值對）轉移到新table中，從而完成擴容
    transfer(newTable); 

    // 6. 新數組table引用到HashMap的table屬性上
    table = newTable;  

    // 7. 重新設置閾值  
    threshold = (int)(newCapacity * loadFactor); 
} 

/**
   * transfer(newTable); 
   * 作用：將舊數組上的數據（鍵值對）轉移到新table中，從而完成擴容
   * 過程：按舊鏈表的正序遍歷鏈表采用頭插法插入新鏈表
   */ 
void transfer(Entry[] newTable) {
      // 1. src指向原table
      Entry[] src = table; 

      // 2. 獲取新數組的大小            
      int newCapacity = newTable.length;

      // 3. 通過遍歷舊table，將鍵值對轉移到新table上
      for (int j = 0; j < src.length; j++) { 
          
      	  // 創建輔助entry指向舊數組中的元素  
          Entry<K,V> e = src[j];
          
          if (e != null) {
              // 釋放舊數組的對象引用（for循環後，舊數組不再引用任何對象）
              src[j] = null; 
			  //開始遍歷
              do { 
                  
				//創建輔助指針next（因是單鏈表，故要保存下1個結點，否則轉移後鏈表會斷開	）				
                 Entry<K,V> next = e.next; 
                 // 重新計算每個元素的存儲位置
                 int i = indexFor(e.hash, newCapacity); 
                
                  //頭插法插入
                 e.next = newTable[i]; 
                 newTable[i] = e;
                  
                 // e跳到下一個entry
                 e = next;             
             } while (e != null);
             // 循環直到遍歷完數組上的所有數據元素
         }
     }
 }

   public V get(Object key) {  

    // 1. 當key == null時，則到table[0]為頭結點的鏈表去檢索
    if (key == null)  
        return getForNullKey();

    // 2. 當key ≠ null時，去獲得對應值 
    Entry<K,V> entry = getEntry(key);
  
    return null == entry ? null : entry.getValue();  
}  


 /**
   * getForNullKey()
   * 作用：當key == null時，在table[0]中去尋找對應 key為null的鍵值對
   */ 
private V getForNullKey() {  

    if (size == 0) {  
        return null;  
    }  

    // 遍歷以table[0]為頭結點的鏈表，尋找 key==null 對應的值
    for (Entry<K,V> e = table[0]; e != null; e = e.next) {  

        // 從table[0]中取key==null的value值 
        if (e.key == null)  
            return e.value; 
    }  
    return null;  
}  
 
 /**
   * getEntry(key)
   * 作用：當key ≠ null時，去獲得對應值
   */  
final Entry<K,V> getEntry(Object key) {  
	
    //如果元素個數為空返回null
    if (size == 0) {  
        return null;  
    }  

    // 1. 計算key對應的hash值
    int hash = (key == null) ? 0 : hash(key);  

    // 2. 根據hash值計算出對應的數組下標
    // 3. 遍歷對應index的數組元素為頭結點的鏈表，檢索鍵值對
    for (Entry<K,V> e = table[indexFor(hash, table.length)];  e != null;  e = e.next) {  

        Object k;  
        // 若 hash值 & key 相等，則證明該Entry = 我們要的鍵值對
        // 通過==或者equals（）判斷key是否相等
        if (e.hash == hash &&  
            ((k = e.key) == key || (key != null && key.equals(k))))  
            return e;  
    }  
    return null;  
}  

public V remove(Object key) {  
    Entry<K,V> e = removeEntryForKey(key);  
    return (e == null ? null : e.value);  
}  
  
final Entry<K,V> removeEntryForKey(Object key) {  
    if (size == 0) {  
        return null;  
    }  
    // 1. 計算hash值
    int hash = (key == null) ? 0 : hash(key);  
    // 2. 計算存儲的數組下標位置
    int i = indexFor(hash, table.length);  
    
    //prev記錄要刪除entry的前一個entry
    Entry<K,V> prev = table[i];  
    
    //e記錄要刪除的entry
    Entry<K,V> e = prev;  
  
    while (e != null) {  
        //輔助指針，指向下一個entry
        Entry<K,V> next = e.next;  
        Object k;  
        //如果key相等
        if (e.hash == hash &&  
            ((k = e.key) == key || (key != null && key.equals(k)))) {  				
            modCount++; //改動次數+1
          
            size--;   //元素個數-1
            
            // 若刪除的是鏈表的頭結點 
            if (prev == e) 
               // 則將頭結點的next引用存入table[i]中
                table[i] = next;

            //否則 將當前結點的前1個結點中的next指向當前結點的下一個結點（直接越過當前Entry）
            else  
                prev.next = next;   
            e.recordRemoval(this);  
            return e;  
        }
        
        //prev指向當前結點
        prev = e;  
        //e指向下一個結點
        e = next;  
    }  
    //遍歷結束e為null，表示沒找到返回null
    return e;  
} 

  /**
   * 函數：isEmpty()
   * 作用：判斷HashMap是否為空，即無鍵值對；size == 0時 表示為 空 
   */

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

 /**
   * 函數：size()
   * 作用：返回哈希表中所有 鍵值對的數量 = 數組中的鍵值對 + 鏈表中的鍵值對
   */

   public int size() {  
    return size;  
}  

 /**
   * 函數：clear()
   * 作用：清空哈希表，即刪除所有鍵值對
   * 原理：將數組table中存儲的Entry全部置為null、size置為0
   */ 
public void clear() {
    //改動次數＋1
    modCount++;  
    //全部元素設空
    Arrays.fill(table, null);
    //元素個數清0
    size = 0;
}  

/**
   * 函數：putAll(Map<? extends K, ? extends V> m)
   * 作用：將指定Map中的鍵值對 復制到 此Map中
   * 原理：類似Put函數
   */ 

    public void putAll(Map<? extends K, ? extends V> m) {  
    // 1. 統計需復制多少個鍵值對  
    int numKeysToBeAdded = m.size();  
    if (numKeysToBeAdded == 0)  
        return; 

    // 2. 若table還沒初始化，先用剛剛統計的復制數去初始化table  
    if (table == EMPTY_TABLE) {  
        inflateTable((int) Math.max(numKeysToBeAdded * loadFactor, threshold));  
    }  
  
    // 3. 若需復制的數目 > 閾值，則需先擴容 
    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);  
    }  
    // 4. 開始復制（實際上不斷調用Put函數插入）  
    for (Map.Entry<? extends K, ? extends V> e : m.entrySet())  
        put(e.getKey(), e.getValue());
}  

 
 /**
   * 函數：containsKey(Object key)
   * 作用：判斷是否存在該鍵的鍵值對；是 則返回true
   * 原理：調用get（），判斷是否為Null
   */
   public boolean containsKey(Object key) {  
    return getEntry(key) != null; 
} 

 /**
   * 函數：containsValue(Object value)
   * 作用：判斷是否存在該值的鍵值對；是 則返回true
   */   
public boolean containsValue(Object value) {  
    // 若value為空，則調用containsNullValue()  
    if (value == null)
        return containsNullValue();  
    
    // 若value不為空，則遍歷鏈表中的每個Entry，通過equals（）比較values 判斷是否存在
    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;//返回true  
    return false;  
}  
  
// 判斷是否有空值 
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;  
}