今天来聊聊C#的关键字：yield，它主要用于生成器和迭代器中。
01 yield简介
yield主要用于在迭代器块中定义返回集合的迭代器函数。它允许我们在迭代器函数中逐个生成元素，并在需要时才返回集合。
yield一般是与return语句一起使用，以返回当前元素并继续执行迭代器函数中的下一个元素。
当使用yield return语句时，会将当前元素作为yield return表达式的值返回，并暂停迭代器函数的执行，直到再次调用该迭代器函数。
示例代码，定义一个迭代器函数：
using System;
using System.Collections;
var numbers = GetNumbers(5);
foreach (var number in numbers)
{
Console.WriteLine(number);
}
IEnumerable GetNumbers(int count)
{
for (int i = 1; i <= count; i++)
{
yield return i;
}
}
//输出：
1
2
3
4
5
02 yield使用场景
yield对于优化我们复杂代码，非常有帮助的，下面列举几个场景：
1、简化代码结构
示例代码，遍历数组返回值大于0的数值。
//传统写法
IEnumerable GetNumbers(int[] nums)
{
var list = new List<int>();
foreach (var item in nums)
{
if (item > 0)
{
list.Add(item);
}
}
return list;
}
//yield写法，简化代码结构
IEnumerable GetNumbers(int[] nums)
{
foreach (var item in nums)
{
if (item > 0)
{
yield return item;
}
}
}
使用yield不仅简化代码结构，让代码更加已读，而且减少内存消耗，特别是大集合的情况。
2、耗时并发场景
示例代码，耗时方法无需等待，直接返回：
using System.Collections;
var numbers = GetNumbers(5);
foreach (var number in numbers)
{
Console.WriteLine("当前时间：{0}，返回值：{1}", DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"), number);
}
IEnumerable GetNumbers(int count)
{
for (int i = 1; i <= count; i++)
{
yield return i;
//休眠5秒
Thread.Sleep(5000);
}
}
运行效果，无需等待所有任务执行完毕：
03 yield优缺点
优点：
内存优化： yield可以预先返回值，而不是一次性将所有数据加载到内存中。这对于处理大量数据的情况非常有用，因为它可以显著降低内存占用。
延迟计算： 使用yield可以让程序员轻松实现延迟计算的机制。方便我们实现某些计算密集型任务可以在需要时才进行，而不是在程序启动时就执行。这可以提高程序的性能和响应速度。
代码简洁： 可以使代码更加简洁和易于理解。它允许程序员将复杂的逻辑分解为更小、更易于管理的部分。
易于扩展： 可以轻松地扩展生成器和迭代器的功能。
缺点：
复杂性增加： 对于初学者来说，理解yield关键字可能需要一些时间。正确地使用yield需要一定的经验和技巧，因此可能会增加代码的复杂性和维护难度。
性能开销： 虽然yield关键字可以优化内存使用和提高代码的可读性，但在某些情况下，它可能会导致额外的性能开销。例如，每次使用yield return或yield break时，都会进行函数调用和对象创建，这可能会对性能产生一定的影响。
错误排查难度增加： 不正确地使用yield关键字可能会导致意外的行为和难以调试的问题。例如，如果在迭代器方法中修改了正在迭代的集合，那么结果可能会出现不一致或不可预测。
04 最后
yield还是一个非常棒的语法，用好yield可以大大简化我们的代码。
- End -
推荐阅读
