C# 的 Dictionary 寫入前應注意事項

一個已上線、用戶龐大的系統，幾個月來第一次出現這個系統錯誤訊息 :

「已經加入含有相同索引鍵的項目」
「已添加了具備相同鍵的項」
An item with the same key has already been added.

----------------------------------------------------------------------------
分析緣由：

C# 的 Dictionary 這種資料結構的變數，若宣告為 static，在使用上，要注意寫入或 Add 資料前，只作 if ContainsKey 判斷是不夠的 (以下圖 2)，因其不是「執行緒 ; 線程」(thread) 安全的。由於 Dictionary 的 Key 不能重複，若剛好有兩人或多人，同時進入 if 區塊、同時 Add 同一個 Key，就會引發錯誤。機率不高，但久久偶爾會發生一次。

所以在 Dictionary 寫入或 Add 前，應多作一個 lock 的動做，以下圖 3，以達到一次只有一個人 (一個執行緒)，能進入 lock 區塊中，其餘人要排隊等候。

 

圖 1　宣告 Dictionary 變數

圖 2　改寫前 (久久偶爾會發生一次錯誤的寫法)

圖 3　改寫後

C# 的 lock，但注意必定要是宣告為 static 的變數，纔有鎖定的結果 (經我本身實測)。
(static 變數，表示全網站的全部用戶，共用同一塊「記憶體 ; 內存」(memory)，而不是每個用戶各自 new 一塊記憶體)。

-------------------------------------------------------------------
Dictionary 介紹 (msdn) :
https://msdn.microsoft.com/zh-tw/library/xfhwa508(v=vs.110).aspx
-------------------------------------------------------------------
詳細說明 Dictionary 問題的文章 (推薦好文，臺灣極資深專家-李明儒先生):
http://blog.darkthread.net/post-2012-01-31-dictionary-thread-safe.aspx

如下引用該文的內容：

Dictionary<TKey, TValue>在多執行緒下，「讀取」沒問題；但若打算在多個執行緒中同時「更新」，就必須自行處理鎖定及同步議題

上文中，還提到 .NET 4.0 加入一種新的 System.Collections.Concurrent.ConcurrentDictionary<TKey, TValue>。
但我爬文後，覺得不見得能解決此問題，建議勿用。
-------------------------------------------------------------------
lock 介紹 :
http://www.dotblogs.com.tw/yc421206/archive/2011/01/07/20624.aspx
https://msdn.microsoft.com/zh-tw/library/c5kehkcz.aspx
-------------------------------------------------------------------
ConcurrentDictionary<TKey, TValue> 類別 :
https://msdn.microsoft.com/zh-tw/library/dd287191(v=vs.110).aspx

ConcurrentDictionary<TKey, TValue>.GetOrAdd 方法 (TKey, TValue) :
https://msdn.microsoft.com/zh-tw/library/ee378674(v=vs.110).aspx

Dictionary + Locking versus ConcurrentDictionary
http://www.codeproject.com/Articles/548406/Dictionary-plus-Locking-versus-ConcurrentDictionar
-------------------------------------------------------------------
ConcurrentDictionary 讓你的多線程代碼更優美
http://www.bkjia.com/C_jc/968538.html

如下引用該文的內容 (非我本人的觀點)：

用 Dictionary，而當這個屬性被提高爲 static 靜態的（類級別的）時候，咱們就要考慮它的線程安全性了，由於它有可能被多個線程同時訪問，固然，若是這個對象是隻讀的，也無所謂線程安全，但若是這個屬性是能夠被寫的，那就須要把它加鎖了。
但從性能上看，就不能被接收，咱們知道，lock 會把其它線程鎖在外面，不管是讀仍是寫，都會被鎖，性能很是差。

-------------------------------------------------------------------