有人可以揭开yield关键字的神秘面纱吗？

Question

我在 Stack Overflow 和博客上看到过很多次使用 Yield 关键字。我不使用 LINQ。有人可以解释一下yield关键字吗？

我知道也存在类似的问题。 但没有人真正用简单的语言解释它的用途。

Answer 1

为了揭开神秘面纱，我将避免谈论迭代器，因为它们本身可能就是谜团的一部分。

Yield return 和 Yield Break 语句最常用于提供集合的“延迟评估”。

这意味着当你获取使用yield return的方法的值时，你试图获取的东西的集合还不存在（它本质上是空的）。当您循环遍历它们时（使用 foreach），它将执行当时的方法并获取枚举中的下一个元素。

某些属性和方法将导致整个枚举立即被计算（例如“Count”）。

下面是返回集合和返回yield之间差异的一个简单示例：

string[] names = { "Joe", "Jim", "Sam", "Ed", "Sally" };

public IEnumerable<string> GetYieldEnumerable()
{
    foreach (var name in names)
        yield return name;
}

public IEnumerable<string> GetList()
{
    var list = new List<string>();
    foreach (var name in names)
        list.Add(name);

    return list;
}

// we're going to execute the GetYieldEnumerable() method
// but the foreach statement inside it isn't going to execute
var yieldNames = GetNamesEnumerable();

// now we're going to execute the GetList() method and
// the foreach method will execute
var listNames = GetList();

// now we want to look for a specific name in yieldNames.
// only the first two iterations of the foreach loop in the 
// GetYieldEnumeration() method will need to be called to find it.
if (yieldNames.Contains("Jim")
    Console.WriteLine("Found Jim and only had to loop twice!");

// now we'll look for a specific name in listNames.
// the entire names collection was already iterated over
// so we've already paid the initial cost of looping through that collection.
// now we're going to have to add two more loops to find it in the listNames
// collection.
if (listNames.Contains("Jim"))
    Console.WriteLine("Found Jim and had to loop 7 times! (5 for names and 2 for listNames)");

如果您需要在源数据具有值之前获取对枚举的引用，也可以使用此示例。例如，如果名称收集一开始就不完整：

string[] names = { "Joe", "Jim", "Sam", "Ed", "Sally" };

public IEnumerable<string> GetYieldEnumerable()
{
    foreach (var name in names)
        yield return name;
}

public IEnumerable<string> GetList()
{
    var list = new List<string>();
    foreach (var name in names)
        list.Add(name);

    return list;
}

var yieldNames = GetNamesEnumerable();

var listNames = GetList();

// now we'll change the source data by renaming "Jim" to "Jimbo"
names[1] = "Jimbo";

if (yieldNames.Contains("Jimbo")
    Console.WriteLine("Found Jimbo!");

// Because this enumeration was evaluated completely before we changed "Jim"
// to "Jimbo" it isn't going to be found
if (listNames.Contains("Jimbo"))
    // this can't be true
else
   Console.WriteLine("Couldn't find Jimbo, because he wasn't there when I was evaluated.");

Answer 2

yield 关键字是编写 IEnumerator 的便捷方法。例如：

public static IEnumerator<int> Range(int from, int to)
{
    for (int i = from; i < to; i++)
    {
        yield return i;
    }
}

由 C# 编译器转换为类似于：

public static IEnumerator<int> Range(int from, int to)
{
    return new RangeEnumerator(from, to);
}

class RangeEnumerator : IEnumerator<int>
{
    private int from, to, current;

    public RangeEnumerator(int from, int to)
    {
        this.from = from;
        this.to = to;
        this.current = from;
    }

    public bool MoveNext()
    {
        this.current++;
        return this.current < this.to;
    }

    public int Current
    {
        get
        {
            return this.current;
        }
    }
}

Answer 3

请查看 MSDN 文档和示例。它本质上是在 C# 中创建迭代器的一种简单方法。

public class List
{
    //using System.Collections;
    public static IEnumerable Power(int number, int exponent)
    {
        int counter = 0;
        int result = 1;
        while (counter++ < exponent)
        {
            result = result * number;
            yield return result;
        }
    }

    static void Main()
    {
        // Display powers of 2 up to the exponent 8:
        foreach (int i in Power(2, 8))
        {
            Console.Write("{0} ", i);
        }
    }
}

Answer 4

Eric White 的函数式编程系列非常值得完整阅读，但是 Yield 条目 非常清楚正如我所看到的解释。

Answer 5

yield 与 LINQ 没有直接关系，而是迭代器块。链接的 MSDN 文章 提供了有关此语言功能的详细信息。特别请参阅使用迭代器部分。有关迭代器块的详细信息，请参阅 Eric Lippert 最近的博客帖子 关于功能。有关一般概念，请参阅维基百科有关迭代器的文章。

Answer 6

我想出这个来克服 .NET 必须手动深层复制列表的缺点。

我使用这个：

static public IEnumerable<SpotPlacement> CloneList(List<SpotPlacement> spotPlacements)
{
    foreach (SpotPlacement sp in spotPlacements)
    {
        yield return (SpotPlacement)sp.Clone();
    }
}

在另一个地方：

public object Clone()
{
    OrderItem newOrderItem = new OrderItem();
    ...
    newOrderItem._exactPlacements.AddRange(SpotPlacement.CloneList(_exactPlacements));
    ...
    return newOrderItem;
}

我试图想出一个oneliner来做到这一点，但这是不可能的，因为yield在匿名方法块内不起作用。

编辑：

更好的是，使用通用列表克隆器：

class Utility<T> where T : ICloneable
{
    static public IEnumerable<T> CloneList(List<T> tl)
    {
        foreach (T t in tl)
        {
            yield return (T)t.Clone();
        }
    }
}

Answer 7

让我补充一下这一切。产量不是关键词。
仅当您使用“yield return”时它才会起作用，而不是像普通变量一样工作。

它用于从函数返回迭代器。您可以对此进行进一步搜索。
我建议搜索“返回数组与迭代器”

Answer 8

到目前为止（我见过的）对此最好的解释是乔恩·斯基特（Jon Skeet）的书 - 并且该章是免费的！第 6 章，深入了解 C#。我可以在这里添加任何未涵盖的内容。

然后买书；你将因此成为一名更好的 C# 程序员。

---

问：为什么我不在这里写一个更长的答案（从评论中解释）；简单的。正如埃里克·利珀特（Eric Lippert）观察到的（此处），yield 构造（及其背后的魔力）是C# 编译器中最复杂的代码位，试图在这里简短的回复中描述它充其量是天真的。 yield 有很多细微差别，在我看来，最好参考预先存在的（且完全合格的）资源。

Eric 的博客现在有 7 个讨论 yield 的条目（这只是最近的条目）。我对埃里克怀有极大的敬意，但他的博客可能更适合作为那些熟悉该主题的人的“更多信息”（yield 在本例中），因为它通常描述了许多背景设计考虑因素。最好在合理的基础上进行。

（是的，第 6 章确实下载；我已验证......）

Answer 9

yield 关键字与返回 IEnumerable 或 IEnumerator 的方法一起使用，它使编译器生成一个实现使用迭代器的必要管道。例如，

public IEnumerator<int> SequenceOfOneToThree() {
    yield return 1;
    yield return 2;
    yield return 3;
}

鉴于上述情况，编译器将生成一个实现 IEnumerator、IEnumerable 和 IDisposable 的类（实际上它也会实现IEnumerable 和 IEnumerator 的非通用版本）。

这允许您在 foreach 循环中调用方法 SequenceOfOneToThree，如下所示

foreach(var number in SequenceOfOneToThree) {
    Console.WriteLine(number);
}

迭代器是一个状态机，因此每次调用 yield 时位置方法中记录了。如果迭代器移动到下一个元素，该方法将在此位置之后立即恢复。因此第一次迭代返回 1 并标记该位置。下一个迭代器在 1 之后立即恢复，从而返回 2 等等。

不用说，您可以按照您喜欢的任何方式生成序列，因此您不必像我一样对数字进行硬编码。另外，如果您想中断循环，可以使用yield break。