yield 语句 - 提供下一个元素
本文内容
在迭代器中使用 yield
语句提供下一个值或表示迭代结束。 yield
语句有以下两种形式:
-
C#yield return
:在迭代中提供下一个值,如以下示例所示:foreach (int i in ProduceEvenNumbers(9)) { Console.Write(i); Console.Write(" "); } // Output: 0 2 4 6 8 IEnumerable<int> ProduceEvenNumbers(int upto) { for (int i = 0; i <= upto; i += 2) { yield return i; } }
-
C#yield break
:显式示迭代结束,如以下示例所示:Console.WriteLine(string.Join(" ", TakeWhilePositive([2, 3, 4, 5, -1, 3, 4]))); // Output: 2 3 4 5 Console.WriteLine(string.Join(" ", TakeWhilePositive([9, 8, 7]))); // Output: 9 8 7 IEnumerable<int> TakeWhilePositive(IEnumerable<int> numbers) { foreach (int n in numbers) { if (n > 0) { yield return n; } else { yield break; } } }
当控件到达迭代器的末尾时,迭代也结束。
在前面的示例中,迭代器的返回类型为 IEnumerable<T>(在非泛型情况下,使用 IEnumerable 作为迭代器的返回类型)。 还可以使用 IAsyncEnumerable<T> 作为迭代器的返回类型。 这使得迭代器异步。 使用 await foreach
语句对迭代器的结果进行迭代,如以下示例所示:
await foreach (int n in GenerateNumbersAsync(5))
{
Console.Write(n);
Console.Write(" ");
}
// Output: 0 2 4 6 8
async IAsyncEnumerable<int> GenerateNumbersAsync(int count)
{
for (int i = 0; i < count; i++)
{
yield return await ProduceNumberAsync(i);
}
}
async Task<int> ProduceNumberAsync(int seed)
{
await Task.Delay(1000);
return 2 * seed;
}
迭代器的返回类型可以是 IEnumerator<T> 或 IEnumerator。 在以下场景中实现 GetEnumerator
方法时,这非常有用:
-
设计实现 IEnumerable<T> 或 IEnumerable 接口的类型。
-
添加实例或扩展
C#GetEnumerator
方法来使用foreach
语句对类型的实例启用迭代,如以下示例所示:public static void Example() { var point = new Point(1, 2, 3); foreach (int coordinate in point) { Console.Write(coordinate); Console.Write(" "); } // Output: 1 2 3 } public readonly record struct Point(int X, int Y, int Z) { public IEnumerator<int> GetEnumerator() { yield return X; yield return Y; yield return Z; } }
不能在下列情况中使用 yield
语句:
迭代器的执行
迭代器的调用不会立即执行,如以下示例所示:
C#var numbers = ProduceEvenNumbers(5);
Console.WriteLine("Caller: about to iterate.");
foreach (int i in numbers)
{
Console.WriteLine($"Caller: {i}");
}
IEnumerable<int> ProduceEvenNumbers(int upto)
{
Console.WriteLine("Iterator: start.");
for (int i = 0; i <= upto; i += 2)
{
Console.WriteLine($"Iterator: about to yield {i}");
yield return i;
Console.WriteLine($"Iterator: yielded {i}");
}
Console.WriteLine("Iterator: end.");
}
// Output:
// Caller: about to iterate.
// Iterator: start.
// Iterator: about to yield 0
// Caller: 0
// Iterator: yielded 0
// Iterator: about to yield 2
// Caller: 2
// Iterator: yielded 2
// Iterator: about to yield 4
// Caller: 4
// Iterator: yielded 4
// Iterator: end.
如前面的示例所示,当开始对迭代器的结果进行迭代时,迭代器会一直执行,直到到达第一个 yield return
语句为止。 然后,迭代器的执行会暂停,调用方会获得第一个迭代值并处理该值。 在后续的每次迭代中,迭代器的执行都会在导致上一次挂起的 yield return
语句之后恢复,并继续执行,直到到达下一个 yield return
语句为止。 当控件到达迭代器或 yield break
语句的末尾时,迭代完成。
C# 语言规范
有关详细信息,请参阅 C# 语言规范中的 yield 语句部分。
另请参阅
在 GitHub 上与我们协作 可以在 GitHub 上找到此内容的源,还可以在其中创建和查看问题和拉取请求。 有关详细信息,请参阅参与者指南。.NET 反馈
.NET 是一个开放源代码项目。 选择一个链接以提供反馈:
提出文档问题 提供产品反馈 标签:语句,return,迭代,int,元素,yield,Console From: https://www.cnblogs.com/sexintercourse/p/18148330