分析C# Dictionary的實現原理

一、理論知識

對於Dictionary的實現原理，其中有兩個關鍵的算法，一個是Hash算法，一個是用於應對Hash碰撞沖突解決算法。

1.1、Hash算法

Hash算法是一種數字摘要算法，它能將不定長度的二進制數據集給映射到一個較短的二進制長度數據集，常見的MD5算法就是一種Hash算法，通過MD5算法可對任何數據生成數字摘要。而實現瞭Hash算法的函數我們叫她Hash函數。Hash函數有以下幾點特征。

• 相同的數據進行Hash運算，得到的結果一定相同。HashFunc(key1) == HashFunc(key1)
• 不同的數據進行Hash運算，其結果也可能會相同，(Hash會產生碰撞)。key1 != key2 => HashFunc(key1) == HashFunc(key2).
• Hash運算時不可逆的，不能由key獲取原始的數據。key1 => hashCode但是hashCode =\=> key1。

下圖就是Hash函數的一個簡單說明，任意長度的數據通過HashFunc映射到一個較短的數據集中。

關於Hash碰撞下圖很清晰的就解釋瞭，可從圖中得知Sandra Dee 和 John Smith通過hash運算後都落到瞭02的位置，產生瞭碰撞和沖突。

常見的構造Hash函數的算法有以下幾種：

1. 直接尋址法：取keyword或keyword的某個線性函數值為散列地址。即H(key)=key或H(key) = a•key + b，當中a和b為常數（這樣的散列函數叫做自身函數）

2. 數字分析法：分析一組數據，比方一組員工的出生年月日，這時我們發現出生年月日的前幾位數字大體同樣，這種話，出現沖突的幾率就會非常大，可是我們發現年月日的後幾位表示月份和詳細日期的數字區別非常大，假設用後面的數字來構成散列地址，則沖突的幾率會明顯減少。因此數字分析法就是找出數字的規律，盡可能利用這些數據來構造沖突幾率較低的散列地址。

3. 平方取中法：取keyword平方後的中間幾位作為散列地址。

4. 折疊法：將keyword切割成位數同樣的幾部分，最後一部分位數能夠不同，然後取這幾部分的疊加和（去除進位）作為散列地址。

5. 隨機數法：選擇一隨機函數，取keyword的隨機值作為散列地址，通經常使用於keyword長度不同的場合。

6. 除留餘數法：取keyword被某個不大於散列表表長m的數p除後所得的餘數為散列地址。即 H(key) = key MOD p, p<=m。不僅能夠對keyword直接取模，也可在折疊、平方取中等運算之後取模。對p的選擇非常重要，一般取素數或m，若p選的不好，容易產生碰撞.

1.2、Hash桶算法

說到Hash算法大傢就會想到Hash表，一個Key通過Hash函數運算後可快速的得到hashCode，通過hashCode的映射可直接Get到Value，但是hashCode一般取值都是非常大的，經常是2^32以上，不可能對每個hashCode都指定一個映射。

因為這樣的一個問題，所以人們就將生成的HashCode以分段的形式來映射，把每一段稱之為一個Bucket（桶），一般常見的Hash桶就是直接對結果取餘。

假設將生成的hashCode可能取值有2^32個，然後將其切分成一段一段，使用8個桶來映射，那麼就可以通過bucketIndex = HashFunc(key1) % 8這樣一個算法來確定這個hashCode映射到具體的哪個桶中。

大傢可以看出來，通過hash桶這種形式來進行映射，所以會加劇hash的沖突。

1.3、解決沖突算法

對於一個hash算法，不可避免的會產生沖突，那麼產生沖突以後如何處理，是一個很關鍵的地方，目前常見的沖突解決算法有拉鏈法(Dictionary實現采用的)、開放定址法、再Hash法、公共溢出分區法，本文隻介紹拉鏈法與再Hash法，對於其它算法感興趣的同學可參考文章最後的參考文獻。

1. 拉鏈法：這種方法的思路是將產生沖突的元素建立一個單鏈表，並將頭指針地址存儲至Hash表對應桶的位置。這樣定位到Hash表桶的位置後可通過遍歷單鏈表的形式來查找元素。

2. 再Hash法：顧名思義就是將key使用其它的Hash函數再次Hash，直到找到不沖突的位置為止。

對於拉鏈法有一張圖來描述，通過在沖突位置建立單鏈表，來解決沖突。

二、Dictionary實現

Dictionary實現我們主要對照源碼來解析，目前對照源碼的版本是.Net Framwork 4.7。地址可戳一戳這個鏈接 源碼地址：Link

這一章節中主要介紹Dictionary中幾個比較關鍵的類和對象，然後跟著代碼來走一遍插入、刪除和擴容的流程，相信大傢就能理解它的設計原理。

2.1、Entry結構體

首先我們引入Entry這樣一個結構體，它的定義如下代碼所示。這是Dictionary種存放數據的最小單位，調用Add(Key,Value)方法添加的元素都會被封裝在這樣的一個結構體中。

private struct Entry {
    public int hashCode;    // 除符號位以外的31位hashCode值, 如果該Entry沒有被使用，那麼為-1
    public int next;        // 下一個元素的下標索引，如果沒有下一個就為-1
    public TKey key;        // 存放元素的鍵
    public TValue value;    // 存放元素的值
}

2.2、其它關鍵私有變量

除瞭Entry結構體外，還有幾個關鍵的私有變量，其定義和解釋如下代碼所示。

private int[] buckets;		// Hash桶
private Entry[] entries;	// Entry數組，存放元素
private int count;			// 當前entries的index位置
private int version;		// 當前版本，防止迭代過程中集合被更改
private int freeList;		// 被刪除Entry在entries中的下標index，這個位置是空閑的
private int freeCount;		// 有多少個被刪除的Entry，有多少個空閑的位置
private IEqualityComparer<TKey> comparer;	// 比較器
private KeyCollection keys;		// 存放Key的集合
private ValueCollection values;		// 存放Value的集合

上面代碼中，需要註意的是buckets、entries這兩個數組，這是實現Dictionary的關鍵。

2.3、Dictionary – Add操作

經過上面的分析，相信大傢還不是特別明白為什麼需要這麼設計，需要這麼做。那我們現在來走一遍Dictionary的Add流程，來體會一下。

首先我們用圖的形式來描述一個Dictionary的數據結構，其中隻畫出瞭關鍵的地方。桶大小為4以及Entry大小也為4的一個數據結構。

然後我們假設需要執行一個Add操作，dictionary.Add("a","b")，其中key = "a",value = "b"。

1.根據key的值，計算出它的hashCode。我們假設”a”的hash值為6（GetHashCode("a") = 6）。

2.通過對hashCode取餘運算，計算出該hashCode落在哪一個buckets桶中。現在桶的長度（buckets.Length）為4，那麼就是6 % 4最後落在index為2的桶中，也就是buckets[2]。

3.避開一種其它情況不談，接下來它會將hashCode、key、value等信息存入entries[count]中，因為count位置是空閑的；繼續count++指向下一個空閑位置。上圖中第一個位置，index=0就是空閑的，所以就存放在entries[0]的位置。

4.將Entry的下標entryIndex賦值給buckets中對應下標的bucket。步驟3中是存放在entries[0]的位置，所以buckets[2]=0。

5.最後version++，集合發生瞭變化，所以版本需要+1。隻有增加、替換和刪除元素才會更新版本

上文中的步驟1~5隻是方便大傢理解，實際上有一些偏差，後文再談Add操作小節中會補充。

完成上面Add操作後，數據結構更新成瞭下圖這樣的形式。

這樣是理想情況下的操作，一個bucket中隻有一個hashCode沒有碰撞的產生，但是實際上是會經常產生碰撞；那麼Dictionary類中又是如何解決碰撞的呢。

我們繼續執行一個Add操作，dictionary.Add("c","d")，假設GetHashCode(“c”)=6，最後6 % 4 = 2。最後桶的index也是2，按照之前的步驟1~3是沒有問題的，執行完後數據結構如下圖所示。

如果繼續執行步驟4那麼buckets[2] = 1，然後原來的buckets[2]=>entries[0]的關系就會丟失，這是我們不願意看到的。現在Entry中的next就發揮大作用瞭。

如果對應的buckets[index]有其它元素已經存在，那麼會執行以下兩條語句，讓新的entry.next指向之前的元素，讓buckets[index]指向現在的新的元素，就構成瞭一個單鏈表。

entries[index].next = buckets[targetBucket];
...
buckets[targetBucket] = index;

實際上步驟4也就是做一個這樣的操作，並不會去判斷是不是有其它元素，因為buckets中桶初始值就是-1，不會造成問題。

經過上面的步驟以後，數據結構就更新成瞭下圖這個樣子。

2.4、Dictionary – Find操作

為瞭方便演示如何查找，我們繼續Add一個元素dictionary.Add("e","f")，GetHashCode(“e”) = 7; 7% buckets.Length=3,數據結構如下所示。

假設我們現在執行這樣一條語句dictionary.GetValueOrDefault("a")，會執行以下步驟.

1.獲取key的hashCode，計算出所在的桶位置。我們之前提到，”a”的hashCode=6，所以最後計算出來targetBucket=2。

2.通過buckets[2]=1找到entries[1],比較key的值是否相等，相等就返回entryIndex，不想等就繼續entries[next]查找，直到找到key相等元素或者next == -1的時候。這裡我們找到瞭key == "a"的元素，返回entryIndex=0。

3.如果entryIndex >= 0那麼返回對應的entries[entryIndex]元素，否則返回default(TValue)。這裡我們直接返回entries[0].value。

整個查找的過程如下圖所示.

將查找的代碼摘錄下來，如下所示。

// 尋找Entry元素的位置
private int FindEntry(TKey key) {
    if( key == null) {
        ThrowHelper.ThrowArgumentNullException(ExceptionArgument.key);
    }

    if (buckets != null) {
        int hashCode = comparer.GetHashCode(key) & 0x7FFFFFFF; // 獲取HashCode，忽略符號位
        // int i = buckets[hashCode % buckets.Length] 找到對應桶，然後獲取entry在entries中位置
        // i >= 0; i = entries[i].next 遍歷單鏈表
        for (int i = buckets[hashCode % buckets.Length]; i >= 0; i = entries[i].next) {
            // 找到就返回瞭
            if (entries[i].hashCode == hashCode && comparer.Equals(entries[i].key, key)) return i;
        }
    }
    return -1;
}
...
internal TValue GetValueOrDefault(TKey key) {
    int i = FindEntry(key);
    // 大於等於0代表找到瞭元素位置，直接返回value
    // 否則返回該類型的默認值
    if (i >= 0) {
        return entries[i].value;
    }
    return default(TValue);
}

2.5、Dictionary – Remove操作

前面已經向大傢介紹瞭增加、查找，接下來向大傢介紹Dictionary如何執行刪除操作。我們沿用之前的Dictionary數據結構。

刪除前面步驟和查找類似，也是需要找到元素的位置，然後再進行刪除的操作。

我們現在執行這樣一條語句dictionary.Remove("a")，hashFunc運算結果和上文中一致。步驟大部分與查找類似，我們直接看摘錄的代碼，如下所示。

public bool Remove(TKey key) {
    if(key == null) {
        ThrowHelper.ThrowArgumentNullException(ExceptionArgument.key);
    }

    if (buckets != null) {
        // 1. 通過key獲取hashCode
        int hashCode = comparer.GetHashCode(key) & 0x7FFFFFFF;
        // 2. 取餘獲取bucket位置
        int bucket = hashCode % buckets.Length;
        // last用於確定是否當前bucket的單鏈表中最後一個元素
        int last = -1;
        // 3. 遍歷bucket對應的單鏈表
        for (int i = buckets[bucket]; i >= 0; last = i, i = entries[i].next) {
            if (entries[i].hashCode == hashCode && comparer.Equals(entries[i].key, key)) {
                // 4. 找到元素後，如果last< 0，代表當前是bucket中最後一個元素，那麼直接讓bucket內下標賦值為 entries[i].next即可
                if (last < 0) {
                    buckets[bucket] = entries[i].next;
                }
                else {
                    // 4.1 last不小於0，代表當前元素處於bucket單鏈表中間位置，需要將該元素的頭結點和尾節點相連起來,防止鏈表中斷
                    entries[last].next = entries[i].next;
                }
                // 5. 將Entry結構體內數據初始化
                entries[i].hashCode = -1;
                // 5.1 建立freeList單鏈表
                entries[i].next = freeList;
                entries[i].key = default(TKey);
                entries[i].value = default(TValue);
                // *6. 關鍵的代碼，freeList等於當前的entry位置，下一次Add元素會優先Add到該位置
                freeList = i;
                freeCount++;
                // 7. 版本號+1
                version++;
                return true;
            }
        }
    }
    return false;
}

執行完上面代碼後，數據結構就更新成瞭下圖所示。需要註意varsion、freeList、freeCount的值都被更新瞭。

2.6、Dictionary – Resize操作(擴容)

有細心的小夥伴可能看過瞭Add操作以後就想問瞭，buckets、entries不就是兩個數組麼，那萬一數組放滿瞭怎麼辦？接下來就是我所要介紹的Resize（擴容）這樣一種操作，對我們的buckets、entries進行擴容。

2.6.1、擴容操作的觸發條件

首先我們需要知道在什麼情況下，會發生擴容操作；第一種情況自然就是數組已經滿瞭，沒有辦法繼續存放新的元素。如下圖所示的情況。

從上文中大傢都知道，Hash運算會不可避免的產生沖突，Dictionary中使用拉鏈法來解決沖突的問題，但是大傢看下圖中的這種情況。

所有的元素都剛好落在buckets[3]上面，結果就是導致瞭時間復雜度O(n)，查找性能會下降；所以第二種，Dictionary中發生的碰撞次數太多，會嚴重影響性能，也會觸發擴容操作。

目前.Net Framwork 4.7中設置的碰撞次數閾值為100.

public const int HashCollisionThreshold = 100;

2.6.2、擴容操作如何進行

為瞭給大傢演示的清楚，模擬瞭以下這種數據結構，大小為2的Dictionary，假設碰撞的閾值為2；現在觸發Hash碰撞擴容。

開始擴容操作。

1.申請兩倍於現在大小的buckets、entries

2.將現有的元素拷貝到新的entries

完成上面兩步操作後，新數據結構如下所示。

3、如果是Hash碰撞擴容，使用新HashCode函數重新計算Hash值

上文提到瞭，這是發生瞭Hash碰撞擴容，所以需要使用新的Hash函數計算Hash值。新的Hash函數並一定能解決碰撞的問題，有可能會更糟，像下圖中一樣的還是會落在同一個bucket上。

4、對entries每個元素bucket = newEntries[i].hashCode % newSize確定新buckets位置

**5、重建hash鏈，newEntries[i].next=buckets[bucket]; buckets[bucket]=i; **

因為buckets也擴充為兩倍大小瞭，所以需要重新確定hashCode在哪個bucket中；最後重新建立hash單鏈表.

這就完成瞭擴容的操作，如果是達到Hash碰撞閾值觸發的擴容可能擴容後結果會更差。

在JDK中，HashMap如果碰撞的次數太多瞭，那麼會將單鏈表轉換為紅黑樹提升查找性能。目前.Net Framwork中還沒有這樣的優化，.Net Core中已經有瞭類似的優化，以後有時間在分享.Net Core的一些集合實現。

每次擴容操作都需要遍歷所有元素，會影響性能。所以創建Dictionary實例時最好設置一個預估的初始大小。

private void Resize(int newSize, bool forceNewHashCodes) {
    Contract.Assert(newSize >= entries.Length);
    // 1. 申請新的Buckets和entries
    int[] newBuckets = new int[newSize];
    for (int i = 0; i < newBuckets.Length; i++) newBuckets[i] = -1;
    Entry[] newEntries = new Entry[newSize];
    // 2. 將entries內元素拷貝到新的entries總
    Array.Copy(entries, 0, newEntries, 0, count);
    // 3. 如果是Hash碰撞擴容，使用新HashCode函數重新計算Hash值
    if(forceNewHashCodes) {
        for (int i = 0; i < count; i++) {
            if(newEntries[i].hashCode != -1) {
                newEntries[i].hashCode = (comparer.GetHashCode(newEntries[i].key) & 0x7FFFFFFF);
            }
        }
    }
    // 4. 確定新的bucket位置
    // 5. 重建Hahs單鏈表
    for (int i = 0; i < count; i++) {
        if (newEntries[i].hashCode >= 0) {
            int bucket = newEntries[i].hashCode % newSize;
            newEntries[i].next = newBuckets[bucket];
            newBuckets[bucket] = i;
        }
    }
    buckets = newBuckets;
    entries = newEntries;
}

2.7、Dictionary – 再談Add操作

在我們之前的Add操作步驟中，提到瞭這樣一段話，這裡提到會有一種其它的情況，那就是有元素被刪除的情況。

避開一種其它情況不談，接下來它會將hashCode、key、value等信息存入entries[count]中，因為count位置是空閑的；繼續count++指向下一個空閑位置。上圖中第一個位置，index=0就是空閑的，所以就存放在entries[0]的位置。

因為count是通過自增的方式來指向entries[]下一個空閑的entry，如果有元素被刪除瞭，那麼在count之前的位置就會出現一個空閑的entry；如果不處理，會有很多空間被浪費。

這就是為什麼Remove操作會記錄freeList、freeCount，就是為瞭將刪除的空間利用起來。實際上Add操作會優先使用freeList的空閑entry位置，摘錄代碼如下。

private void Insert(TKey key, TValue value, bool add){
    
    if( key == null ) {
        ThrowHelper.ThrowArgumentNullException(ExceptionArgument.key);
    }

    if (buckets == null) Initialize(0);
    // 通過key獲取hashCode
    int hashCode = comparer.GetHashCode(key) & 0x7FFFFFFF;
    // 計算出目標bucket下標
    int targetBucket = hashCode % buckets.Length;
	// 碰撞次數
    int collisionCount = 0;
    for (int i = buckets[targetBucket]; i >= 0; i = entries[i].next) {
        if (entries[i].hashCode == hashCode && comparer.Equals(entries[i].key, key)) {
            // 如果是增加操作，遍歷到瞭相同的元素，那麼拋出異常
            if (add) {      
				ThrowHelper.ThrowArgumentException(ExceptionResource.Argument_AddingDuplicate);
            }
            // 如果不是增加操作，那可能是索引賦值操作 dictionary["foo"] = "foo"
            // 那麼賦值後版本++，退出
            entries[i].value = value;
            version++;
            return;
        }
        // 每遍歷一個元素，都是一次碰撞
        collisionCount++;
    }
    int index;
    // 如果有被刪除的元素，那麼將元素放到被刪除元素的空閑位置
    if (freeCount > 0) {
        index = freeList;
        freeList = entries[index].next;
        freeCount--;
    }
    else {
        // 如果當前entries已滿，那麼觸發擴容
        if (count == entries.Length)
        {
            Resize();
            targetBucket = hashCode % buckets.Length;
        }
        index = count;
        count++;
    }

    // 給entry賦值
    entries[index].hashCode = hashCode;
    entries[index].next = buckets[targetBucket];
    entries[index].key = key;
    entries[index].value = value;
    buckets[targetBucket] = index;
    // 版本號++
    version++;

    // 如果碰撞次數大於設置的最大碰撞次數，那麼觸發Hash碰撞擴容
    if(collisionCount > HashHelpers.HashCollisionThreshold && HashHelpers.IsWellKnownEqualityComparer(comparer)) 
    {
        comparer = (IEqualityComparer<TKey>) HashHelpers.GetRandomizedEqualityComparer(comparer);
        Resize(entries.Length, true);
    }
}

上面就是完整的Add代碼，還是很簡單的對不對？

2.8、Collection版本控制

在上文中一直提到瞭version這個變量，在每一次新增、修改和刪除操作時，都會使version++；那麼這個version存在的意義是什麼呢？

首先我們來看一段代碼，這段代碼中首先實例化瞭一個Dictionary實例，然後通過foreach遍歷該實例，在foreach代碼塊中使用dic.Remove(kv.Key)刪除元素。

結果就是拋出瞭System.InvalidOperationException:"Collection was modified..."這樣的異常，迭代過程中不允許集合出現變化。如果在Java中遍歷直接刪除元素，會出現詭異的問題，所以.Net中就使用瞭version來實現版本控制。

那麼如何在迭代過程中實現版本控制的呢？我們看一看源碼就很清楚的知道。

在迭代器初始化時，就會記錄dictionary.version版本號，之後每一次迭代過程都會檢查版本號是否一致，如果不一致將拋出異常。

這樣就避免瞭在迭代過程中修改瞭集合，造成很多詭異的問題。

以上就是分析C# Dictionary的實現原理的詳細內容，更多關於C# Dictionary的資料請關註WalkonNet其它相關文章！

推薦閱讀：

• Java集合-HashMap
• c# 復寫Equals方法的實現
• C#使用struct類型作為泛型Dictionary<TKey,TValue>的鍵
• elasticsearch bucket 之rare terms聚合使用詳解
• Golang map實現原理深入分析