Java集合之HashMap原始碼解析

GeneralAndroid發表於2017-11-06

Java集合系列的原始碼解析,分析程式碼的版本均為:Sun JDK1.7
這篇文章fuck的是HashMap,為什麼先選擇它呢,因為Android開發中最常用的資料集合就是HashMap和ArrayList,這裡先Fuck HashMap。
通過本篇文章你可以知道下面幾點:
1.HashMap內部採用的資料結構——>HashMap內部採用的是陣列加單連結串列來實現的,單連結串列的插入為頭插法。(如果對連結串列的理論不熟悉可以參考:線性表)
2.HashMap的擴容機制——>大於閥值,且當前索引處的值非null,則直接擴容1倍。
3.HashMap是如何解決碰撞問題的——>拉鍊法,即採用連結串列的形式,關於雜湊表

建立HashMap的物件有4種姿勢,比如像下面這樣:
程式碼清單1:

/**HashMap原始碼解析使用**/  
public class HashMapTest {  
public static void main(String[] args) {  
    HashMap<String, String> hashMap=new HashMap<>(4,0.25f);  
    HashMap<String, String> hashMap2=new HashMap<>(3);  
    HashMap<String, String> hashMap3=new HashMap<>(3, 1);  
    HashMap<String , String> tmp=new HashMap<>();  
    HashMap<String, String> hashMap4=new HashMap<>(tmp);  
    hashMap.put(null, null);  
    System.out.println(hashMap.get(null));  
    int a=(11 > 1) ? Integer.highestOneBit((11- 1) << 1) : 1;//  
    System.out.println(a);  
    hashMap.put("G1", "1");  
    hashMap.put("G2", "2");  
    hashMap.put("G3", "3");  
    hashMap.put("G4", "4");  
    hashMap.put("G5", "5");  
    hashMap.put("G6", "6");  
    hashMap.put("G7", "7");  
    hashMap.put("G8", "8");  
    hashMap.put("G9", "9");  
    hashMap.put("G10", "10");  
    hashMap.put("G11", "11");  
    hashMap.put("G12", "12");  
    System.out.println(hashMap.keySet().toString());//  
    System.out.println(hashMap.values().toString());  
    System.out.println(hashMap.entrySet().toString());  


}  
}複製程式碼

看下HashMap的建構函式:
程式碼清單2:

static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // 預設容量16  
static final int MAXIMUM_CAPACITY = 1 << 30;//最大容量  
static final float DEFAULT_LOAD_FACTOR = 0.75f;//預設裝載因子 0.75  
static final Entry<?,?>[] EMPTY_TABLE = {};  
transient Entry<K,V>[] table = (Entry<K,V>[]) EMPTY_TABLE;//這裡注意一下,transient修飾的變數不能序列化,而且table的長度是2的冪,存資料的載體,這是一個物件陣列  
transient int size;//  
int threshold;//閥值,用於判斷是否需要調整HashMap的容量(threshold=loadFactor*capacity)  
final float loadFactor;//裝載因子,一旦指定不可改變  
transient int modCount;//該hashMap總共被修改了多少次  
static final int ALTERNATIVE_HASHING_THRESHOLD_DEFAULT = Integer.MAX_VALUE;  
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();//空方法,這裡不用管這個方法,沒有多大的實際意義  
}  
public HashMap(int initialCapacity) {  
    this(initialCapacity, DEFAULT_LOAD_FACTOR);  
}  
public HashMap() {  
    this(DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR);//這句話等價於:this(16,0.75);  
}  
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);  
    putAllForCreate(m);  
}複製程式碼

在上面的程式碼中,我們發現建構函式中沒有對table進行初始化,那麼資料儲存在哪呢?一般new HashMap之後我們都要使用put(object object)或putAll(Map)來進行存資料,其實putAll內部是經過迴圈遍歷其引數來呼叫put來完成功能的。
下面我們先著重看一下put方法:
程式碼清單3:

public V put(K key, V value) {  
       if (table == EMPTY_TABLE) {//如果為空則進行初始化,這裡就解決了建構函式中沒有初始化table的問題  
           inflateTable(threshold);  
       }  
       if (key == null)  
           return putForNullKey(value);//從這裡可以看到hashmap是可以接收key為null的鍵值對,這個方法沒有什麼好講的,就不展開了。  
       int hash = hash(key);//計算雜湊值  
       int i = indexFor(hash, table.length);//通過雜湊值來獲取陣列下標  
       for (Entry<K,V> e = table[i]; e != null; e = e.next) {//這裡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;  
   }複製程式碼

關於put方法,我們根據上面的註釋就可以明白大致的意思,這裡先展開看一下inflateTable(threshold)這個函式,程式碼如下:
程式碼清單4:

  /** 
     * Inflates the table,在這個函式的方法體中,我們可以看到table陣列的實際大小要比我們呼叫建構函式傳入的值大,原因再於減一左移調整2冪 
     */  
    private void inflateTable(int toSize) {  
        // Find a power of 2 >= toSize  
        int capacity = roundUpToPowerOf2(toSize);//比如tosize=11則capacity=16。  
        threshold = (int) Math.min(capacity * loadFactor, MAXIMUM_CAPACITY + 1);//重新設定閥值,  
        table = new Entry[capacity];//初始化table,  
        initHashSeedAsNeeded(capacity);//初始化雜湊種子  
    }  
private static int roundUpToPowerOf2(int number) {//調整大小,返回一個2冪的值  
        // assert number >= 0 : "number must be non-negative";  
        return number >= MAXIMUM_CAPACITY  
                ? MAXIMUM_CAPACITY  
                : (number > 1) ? Integer.highestOneBit((number - 1) << 1) : 1;//highestOneBit的作用是:如果一個數是0, 則返回0;如果是負數, 則返回 -2147483648:【1000,0000,0000,0000,0000,0000,0000,0000】(二進位制表示的數);如果是正數, 返回的則是跟它最靠近的比它小的2的N次方  
    }  
 /** 
     * Initialize the hashing mask value. We defer initialization until we 
     * really need it. 
     */  
    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;  
    }複製程式碼

程式碼清單4的最主要任務就是new Entry[capacity],我們繼續put方法,將addEntry展開,如程式碼清單5:
程式碼清單5:

//該函式的主要職責是根據需要調整table的大小     
 void addEntry(int hash, K key, V value, int bucketIndex) {  
//如果當前鍵值對的數量已經大於閥值並且buckeIndex位置上有值(說明發生了碰撞),進行擴容處理。  
        if ((size >= threshold) && (null != table[bucketIndex])) {從這裡我們可以看到,並不是鍵值對的值到達表長才開始擴容,而是達到閥值就開始擴容。  
//擴容擴容,直接兩倍,這裡擴容擴的是陣列的容量,這裡直接乘以2是因為table.length的值本身就已經調整成2的冪  
            resize(2 * table.length);  
            hash = (null != key) ? hash(key) : 0;//重新計算hash值  
            bucketIndex = indexFor(hash, table.length);  
        }  
        createEntry(hash, key, value, bucketIndex);  
    }  
 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++;//size的值只在這裡更新,即只有在建立具體的鍵值對時才會更新值  
    }  
 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);//更新閥值  
    }  
 /** 
     * 這個遷移程式碼的核心,遷移元素的函式並不會對size的進行改變,因為遷移並沒有增加元素。 
     */  
    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);//這個遷移邏輯其實是把單連結串列反序的操作,不影響,因為HashMap本身並不對鍵值對有順序要求。  
                e.next = newTable[i];  
                newTable[i] = e;  
                e = next;  
            }  
        }  
    }複製程式碼

通過程式碼清單3至5的程式碼註釋,我們已經清楚地瞭解了put操作的全過程。存的過程通曉了,存資料就是為了取,我們下面來一起看一下如何取資料,請看程式碼清單6:
程式碼清單6:

public V get(Object key) {  
       if (key == null)  
           return getForNullKey();  
       Entry<K,V> entry = getEntry(key);  
       return null == entry ? null : entry.getValue();  
   }  
   private V getForNullKey() {  
       if (size == 0) {  
           return null;  
       }  
       for (Entry<K,V> e = table[0]; e != null; e = e.next) {//從這裡可以看出key為null其雜湊值為0  
           if (e.key == null)  
               return e.value;  
       }  
       return null;  
   }  
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;  
   }複製程式碼

程式碼清單6整個邏輯比較簡單,其實就是兩步走,定位陣列元素的索引,然後遍歷單連結串列,若找到相應的鍵值對則返回value,沒有直接返回null。
我覺得我們有必要看一下hash相關的函式以及陣列元素的索引定位,如程式碼清單7:
程式碼清單7:


    transient int hashSeed = 0;  

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

    h ^= (h >>> 20) ^ (h >>> 12);  
    return h ^ (h >>> 7) ^ (h >>> 4);//做了4次擾動處理,其實就是為了減少碰撞,jdk1.8中對於該函式進行了優化,只做了一次擾動處理。  
}  
雜湊值來獲取table陣列的索引  

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);//當length為2^n時,這句程式碼等價於h%length,其實在hashmap的初始容量或者以及動態擴容的容量都是2^n,所以這裡其實可以理解為求模的運算  
}複製程式碼

開篇的3個問題已經解釋清楚了,到這裡又引出新的問題:
為什麼容量一定要是2的冪(即2^n)呢?
要解釋為什麼HashMap的長度是2的整次冪,就必須indexFor和hash函式一起來分析。
h&(length-1)中的length-1正好相當於一個"地位掩碼",“與”操作的結果就是雜湊值的高位全部歸零,只保留低位值,用來做陣列下標訪問,這樣保證了求得的索引indx即indexFor函式的返回值不會發生越界情況。這裡我們看兩組資料:
16:0000 0000 0000 0000 0000 0000 0001 0000 減去1=15:0000 0000 0000 0000 0000 0000 0000 1111
32:0000 0000 0000 0000 0000 0000 0010 0000 減去1=31:0000 0000 0000 0000 0000 0000 0001 1111
第一組資料:
---------h=8,length=16,indexFor返回值:8------------------------
0000 0000 0000 0000 0000 0000 0000 0000 1000(h)
0000 0000 0000 0000 0000 0000 0000 0000 1111 (length-1)
0000 0000 0000 0000 0000 0000 0000 0000 1000 (index)
---------h=24,length=16,indexFor返回值:8------------------------
0000 0000 0000 0000 0000 0000 0000 0001 1000
0000 0000 0000 0000 0000 0000 0000 0000 1111
0000 0000 0000 0000 0000 0000 0000 0000 1000
---------h=56,length=16,indexFor返回值:8------------------------
0000 0000 0000 0000 0000 0000 0000 0011 1000
0000 0000 0000 0000 0000 0000 0000 0000 1111
0000 0000 0000 0000 0000 0000 0000 0000 1000

第二組資料:
---------h=8,length=32,indexFor返回值:8------------------------
0000 0000 0000 0000 0000 0000 0000 0000 1000
0000 0000 0000 0000 0000 0000 0000 0001 1111
0000 0000 0000 0000 0000 0000 0000 0000 1000
---------h=24,length=32,indexFor返回值:24------------------------
0000 0000 0000 0000 0000 0000 0000 0001 1000
0000 0000 0000 0000 0000 0000 0000 0001 1111
0000 0000 0000 0000 0000 0000 0000 0001 1000
---------h=56,length=32,indexFor返回值:24------------------------
0000 0000 0000 0000 0000 0000 0000 0011 1000
0000 0000 0000 0000 0000 0000 0000 0001 1111
0000 0000 0000 0000 0000 0000 0000 0001 1000
看到沒有如果我們不對hash進行擾動處理,直接進行求模運算,則發生了碰撞。來我們對上面的資料進行騷動,額,不對,進行擾動。
---------h=8,r_h=8,length=16,indexFor返回值:8------------------------
0000 0000 0000 0000 0000 0000 0000 0000 1000 (h)
0000 0000 0000 0000 0000 0000 0000 0000 1000 (r_h)
0000 0000 0000 0000 0000 0000 0000 0000 1111 (length-1)
0000 0000 0000 0000 0000 0000 0000 0000 1000 (index)
---------h=24,r_h=25,length=16,indexFor返回值:9------------------------
0000 0000 0000 0000 0000 0000 0000 0001 1000 (h)
0000 0000 0000 0000 0000 0000 0000 0001 1001 (r_h)
0000 0000 0000 0000 0000 0000 0000 0000 1111 (length-1)
0000 0000 0000 0000 0000 0000 0000 0000 1001 (index)
---------h=56,r_h=59,length=16,indexFor返回值:11------------------------
0000 0000 0000 0000 0000 0000 0000 0011 1000 (h)
0000 0000 0000 0000 0000 0000 0000 0011 1011 (r_h)
0000 0000 0000 0000 0000 0000 0000 0000 1111 (length-1)
0000 0000 0000 0000 0000 0000 0000 0000 1011 (index)

看到沒,就因為對hash進行了擾動處理,所以第一組資料樣本發生的碰撞消除了。r_h的求值是根據:h ^= (h >>> 20) ^ (h >>> 12);h ^ (h >>> 7) ^ (h >>> 4);通過上面的資料,我相信大家已經明白了hash以及indexFor兩個函式了。HashMap的原始碼分析到此結束,其餘部分的程式碼自行了解,此篇文章是基於jdk1.7的程式碼來分析的,至於1.8的改動,有時間會再出一篇文章。

轉載請註明出處:blog.csdn.net/android_jia…

相關文章