2023-03-24
C#
00
请注意,本文编写于 344 天前,最后修改于 296 天前,其中某些信息可能已经过时。

目录

引言
初级
进阶
进阶举例场景
总结

引言

yield关键字是 C# 中的一种语言特性,用于在枚举器中简化迭代器的实现。它使得开发人员可以通过定义自己的迭代器来简化代码,而不必手动实现 IEnumerable 和 IEnumerator 接口。

使用 yield 关键字,可以将迭代器中的值一次一个地返回,而不必使用一个集合对象存储所有的值。当执行到yield return语句时,代码将会暂停执行,将返回值传递给迭代器的调用者,并将迭代器的状态保存下来。当下一次调用MoveNext方法时,代码将从之前的暂停点继续执行,直到遇到下一个yield return语句或者迭代器结束。

接下来探索一下 yield 的三种玩法:

初级

例如通过 yield 创建出一个 IEnumerable 以供 foreach 遍历,代码如下:

csharp
internal class Program { static void Main(string[] args) { foreach (int i in EvenSequence(5, 18)) { Console.Write(i + " "); } Console.ReadKey(); } static IEnumerable<int> EvenSequence(int start, int end) { for (int i = start; i <= end; i++) { if (i % 2 == 0) { yield return i; } } } }

在上面的代码中,我们定义了一个名为EvenSequence的方法,它返回一个实现了IEnumerable<int>接口的对象。在EvenSequence方法中,我们使用yield return语句来返回每个偶数值,并在每次暂停后保存方法的状态。

Main方法中,我们使用foreach循环语句来遍历EvenSequence方法返回的集合对象,并输出每个偶数值。由于我们使用了 yield 关键字,即使我们没有显式地实现IEnumerableIEnumerator接口,也能够遍历集合对象。

进阶

另一个方面,异步编程中也常常使用yield来创建异步生成器。使用yield创建异步生成器可以让我们轻松地以异步方式生成一系列值,而无需显式地管理异步状态。如以下代码:

csharp
public class Program { public static void Main(string[] args) { AsynchronousIterate(); Console.ReadLine(); } public static async void AsynchronousIterate() { await foreach (var number in GenerateNumbersAsync()) { Console.WriteLine(number); } } public static async IAsyncEnumerable<int> GenerateNumbersAsync() { for (int i = 0; i < 10; i++) { await Task.Delay(1000); yield return i; } } }

上述代码定义了一个名为 GenerateNumbersAsync 的异步方法,该方法返回一个 IAsyncEnumerable<int> 类型的对象。在方法体中,我们使用一个 for 循环来生成一系列整数,并在每次迭代中异步等待1秒钟。紧接着,我们使用 yield return 语句将生成的整数返回给调用方。 要注意调用时使用异步迭代器(具有 await 关键字的foreach)来进行遍历>。

上述输出则是一秒输出一个结果,知道全部输出。

进阶举例场景

现在有这一样一个场景,有一大缸水,你手里有一个水瓢,,现在需要你把水缸里的水,全部移到另一个水缸。

前提条件:现在不知道缸里由具体多少水,也无法确定一瓢能舀多少,也无法确定你每一次舀水操作需要多长时间。

现在写一段代码,模拟这个过程。

拟定前提条件,如下代码:

csharp
static Random Random = new Random(); /// <summary> /// 假设水缸能盛水90~100 /// </summary> public static int GetOneWaterTankCapacity() { return Random.Next(150, 200); } /// <summary> /// 假设水瓢一次只能舀水2~5 /// </summary> public static int GetOneWaterLadleCapacity() { return Random.Next(2, 5); } /// <summary> /// 模拟舀水所消耗的时间(0.5s~2S) /// </summary> /// <returns></returns> public static async Task<int> ScoopingWater() { await Task.Delay(Random.Next(500, 2000)); return GetOneWaterLadleCapacity(); }

开始舀水,代码如下:

csharp
/// <summary> /// 开始搬水 /// </summary> /// <returns></returns> public static async void MoveWater() { //先确定缸里有多少水 var WaterTankCapacity = GetOneWaterTankCapacity(); await foreach (var item in CreateTasks(WaterTankCapacity)) { Console.WriteLine($"这一瓢舀水量:{item.Result}\t{DateTime.Now}"); } Console.WriteLine($"水全部舀完~\t{DateTime.Now}"); } private static async IAsyncEnumerable<Task<int>> CreateTasks(int waterTankCapacity) { int totle = 0; while (totle < waterTankCapacity) { Task<int> someWater = ScoopingWater(); yield return someWater; totle += await someWater; } }

最终会每次随机舀水,花费随机时间,水全部舀完。

输出:

csharp
这一瓢舀水量:4 2023/5/11 23:06:29 这一瓢舀水量:3 2023/5/11 23:06:30 这一瓢舀水量:2 2023/5/11 23:06:32 这一瓢舀水量:2 2023/5/11 23:06:34 这一瓢舀水量:3 2023/5/11 23:06:35 这一瓢舀水量:4 2023/5/11 23:06:36 这一瓢舀水量:2 2023/5/11 23:06:37 .... 水全部舀完~ 2023/5/11 23:07:27

通过上文例子,可以更深入理解 yield 创建的异步生成器。

总结

  • 使用 yield 关键字可以将一个方法转换为一个返回可枚举对象或迭代器的方法,而不必手动实现 IEnumerable 和 IEnumerator 接口
  • 使用 yield 来创建异步生成器,在某些场景下可以实现更高效、可靠的异步编程。

本文作者:Peter.Pan

本文链接:

版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!