C#中的yield return是线程安全的吗？

Question

我有以下代码：

private Dictionary<object, object> items = new Dictionary<object, object>;
public IEnumerable<object> Keys
{
    get
    {
        foreach (object key in items.Keys)
        {
            yield return key;
        }
    }
}

这是线程安全的吗？如果不是，我是否必须在循环或收益返回周围放置一个锁？

我的意思是：

Thread1 访问 Keys 属性，而 Thread2 向底层字典添加一个项目。 Thread1 是否受到 Thread2 的添加的影响？

Answer 1

线程安全到底是什么意思？

您当然不应该在迭代字典时更改字典，无论是否在同一线程中。

如果通常在多个线程中访问字典，调用者应该取出一个锁（覆盖所有访问的同一个锁），以便他们可以在迭代结果期间锁定。

编辑：为了回应您的编辑，不，它绝不对应于锁定代码。迭代器块不会自动取出锁 - 它如何知道 syncRoot 呢？

此外，仅锁定 IEnumerable 的返回也不会使其成为线程安全的 - 因为锁定仅影响它返回序列的时间段，而不是迭代的时间段。

Answer 2

查看这篇文章，了解 yield 关键字在幕后发生的情况：

C# Yield 关键字的幕后

简而言之 - 编译器采用您的 Yield 关键字并在 IL 中生成整个类来支持该功能。您可以查看跳转后的页面并查看生成的代码...该代码看起来像是跟踪线程 ID 以确保安全。

Answer 3

好的，我做了一些测试并得到了一个有趣的结果。

看起来这更多是底层集合的枚举器的问题，而不是 yield 关键字的问题。枚举器（实际上是其 MoveNext 方法）会抛出（如果正确实现）InvalidOperationException，因为枚举已更改。根据 MoveNext 方法的 MSDN 文档这是预期的行为。

因为通过集合进行枚举通常不是线程安全的，所以 yield return 也不是。

Answer 4

我相信是这样，但我找不到证实这一点的参考文献。每次任何线程在迭代器上调用 foreach 时，都应创建底层 IEnumerator 的新线程 local* 实例，因此不应存在两个线程可能发生冲突的任何“共享”内存状态...

• Thread Local - 在某种意义上它的引用变量的作用域是该线程上的方法堆栈帧

Answer 5

我相信yield实现是线程安全的。事实上，您可以在家运行这个简单的程序，您会注意到 listInt() 方法的状态已为每个线程正确保存和恢复，而没有其他线程的边缘效应。

public class Test
{
    public void Display(int index)
    {
        foreach (int i in listInt())
        {
            Console.WriteLine("Thread {0} says: {1}", index, i);
            Thread.Sleep(1);
        }

    }

    public IEnumerable<int> listInt()
    {
        for (int i = 0; i < 5; i++)
        {
            yield return i;
        }
    }
}

class MainApp
{
    static void Main()
    {
        Test test = new Test();
        for (int i = 0; i < 4; i++)
        {
            int x = i;
            Thread t = new Thread(p => { test.Display(x); });
            t.Start();
        }

        // Wait for user
        Console.ReadKey();
    }
}

Answer 6

class Program
{
    static SomeCollection _sc = new SomeCollection();

    static void Main(string[] args)
    {
        // Create one thread that adds entries and
        // one thread that reads them
        Thread t1 = new Thread(AddEntries);
        Thread t2 = new Thread(EnumEntries);

        t2.Start(_sc);
        t1.Start(_sc);
    }

    static void AddEntries(object state)
    {
        SomeCollection sc = (SomeCollection)state;

        for (int x = 0; x < 20; x++)
        {
            Trace.WriteLine("adding");
            sc.Add(x);
            Trace.WriteLine("added");
            Thread.Sleep(x * 3);
        }
    }

    static void EnumEntries(object state)
    {
        SomeCollection sc = (SomeCollection)state;
        for (int x = 0; x < 10; x++)
        {
            Trace.WriteLine("Loop" + x);
            foreach (int item in sc.AllValues)
            {
                Trace.Write(item + " ");
            }
            Thread.Sleep(30);
            Trace.WriteLine("");
        }
    }
}

class SomeCollection
{
    private List<int> _collection = new List<int>();
    private object _sync = new object();

    public void Add(int i)
    {
        lock(_sync)
        {
            _collection.Add(i);
        }
    }


    public IEnumerable<int> AllValues
    {
        get
        {
            lock (_sync)
            {
                foreach (int i in _collection)
                {
                    yield return i;
                }
            }
        }
    }
}