抓的是周树人，与我鲁迅有什么关系？

周树人,鲁迅,什么,关系 · 浏览次数 : 1096

小编点评

**1. `Dictionary<string, string> newDict = new Dictionary<string, string>();` 创建的是一个指向现有 `Dictionary` 的新引用。 **2. `Dictionary.Clear()` 创建的新字典只清空了该字典的** `_count`、`_freeList` 和 `_freeCount` 字段，而其他字段如 `_buckets` 和 `_entries` 仍然保留着原始值。 **3. `foreach` 对 `newDict` 进行迭代时，内部会利用原对象 `newDict` 的 `_version` 字段进行比较。** 如果 `_version` 与当前迭代对象的版本不同，则抛出 `InvalidOperationException`。 **4. `Dictionary` 的 `Clear()` 方法是 **可变** 的，这意味着它可以改变其内部数据结构。 **5. `Dictionary` 的`_version` 字段在 `Clear()` 方法中被初始化为 `_count`，因此，`Clear()` 方法只是清空了 `_count` 和相关字段的值。

正文

单独拎出这个题目，是因为昨天看到一线码农大佬公众号的分享Dictionary.Clear 和 new Dictionary() 有什么不同?

无心插画

    void Example1()
    {
      var newDict = new Dictionary<string, string>();
      newDict.Add("key1", "value1");
      newDict.Add("key2", "value2");
      foreach (var item in newDict)
      {
        newDict = new Dictionary<string, string>();
        Console.WriteLine($"new : {item}");
      }
    }

    void  Example2() 
    {
        var newDict= new Dictionary<string, string>();
        newDict.Add("key1", "value1");
        newDict.Add("key2", "value2");
        foreach (var item in newDict)
        {
            newDict.Clear();       // 这里修改了原引用的数据，为啥不报错？
            Console.WriteLine($"clear : {item}");
        }
    }

这个栗子输出的是：

new : [key1, value1]
new : [key2, value2]
clear : [key1, value1]

这个输出是不是也很奇怪:

(1) 重新new赋值难道不是修改了原字典对象newDict吗？ foreach字典为什么不报InvalidOperation异常？

(2) 都肉眼可见的Clear字典了，foreach字典为什么还不报InvalidOperation异常？

Example1：抓的是周树人，与我鲁迅何干？

这个问题是我大意了，没有闪。

这个问题与foreach倒是没有深入的关系，其实就是多引用指向同一片内存的问题。

稍微聊一下流程吧。

(1) 对字典做foreach，内部会利用原对象newDict产生一个Enumerator迭代器。 IDictionaryEnumerator IDictionary.GetEnumerator() => new Enumerator(this, Enumerator.DictEntry);

https://github.com/dotnet/runtime/blob/45acd380b37c9ee883070a70a2ef2cb7eca77683/src/libraries/System.Private.CoreLib/src/System/Collections/Generic/Dictionary.cs#L1331

有关foreach本质，强烈推荐看这个：2021年了，IEnumerator、IEnumerable还傻傻分不清楚？。

(2) 关键是迭代器使用的新的readonly Dictionary<TKey, TValue> _dictionary;字段指向了原newDict指向的对象。

https://github.com/dotnet/runtime/blob/45acd380b37c9ee883070a70a2ef2cb7eca77683/src/libraries/System.Private.CoreLib/src/System/Collections/Generic/Dictionary.cs#L1367

(3) 于是在外部尝试重置newDict，与_dictionary无关,故会出现上面看似诡异的效果。

抓的是周树人，与我鲁迅何干

Example2：.Net Core3.0+ breakChange

Example2肉眼可见地在foreach内变更了原迭代对象，竟然不报InvalidOperationException。

这个问题说来话长，是真的说来话长。

循着源码查看[迭代器报InvalidOperationException异常的时机、查看字典Clear方法]：

    // https://github.com/dotnet/runtime/blob/64243bbf5e9ee53c0c4c5678f2cd8c7f1c9b4f6f/src/libraries/System.Private.CoreLib/src/System/Collections/Generic/Dictionary.cs#L1385
    if (_version != _dictionary._version)
    {
         ThrowHelper.ThrowInvalidOperationException_InvalidOperation_EnumFailedVersion();
    }
      
    // https://github.com/dotnet/runtime/blob/cf258a14b70ad9069470a108f13765e0e5988f51/src/libraries/System.Private.CoreLib/src/System/Collections/Generic/Dictionary.cs#L223C5-L238C10
    public void Clear()
    {
        int count = _count;
        if (count > 0)
        {
            Debug.Assert(_buckets != null, "_buckets should be non-null");
            Debug.Assert(_entries != null, "_entries should be non-null");

            Array.Clear(_buckets, 0, _buckets.Length);

            _count = 0;
            _freeList = -1;
            _freeCount = 0;
            Array.Clear(_entries, 0, count);
         }
    }

静态分析源码，貌似Dictionary认定字典正在变更的关键是verison字段发生变化，Clear()字典清空了原键值对、count、空闲空间等字段，确实没引起version字段变化。

看微软官方Dictionary信源：

属性 Count 设置为 0，并且也会释放对集合元素中其他对象的引用。容量保持不变。

此方法是 O (n) 操作，其中 n 是字典的容量。

仅限 .NET Core 3.0+ ：可以安全地调用此可变方法，而不会使实例上的 Dictionary<TKey,TValue> 活动枚举器失效。 这并不表示线程安全。

画外音: 食之无用弃之可惜

ok， That'all，这是看一线大佬昨日分享DictionaryClear和newDictionary有什么不同的一点补充，[把原文给出的字典Example改成List Example]那又是一个有意思的话题，暂时不表，读者自行尝试。

最后总结技能点，食之无用弃之可惜。: 一个是多引用指向同一区域、另一个是程序逻辑的breakChange。

预告：今日既然聊到了C#字典，字典也是必考八股文，我会抽时间温习C# Dictionary的实现并给出自己的理解。