C#中的yield

在C#中，yield是一个关键字，用于创建迭代器方法、迭代器块或者异步流。

借助yield，方法可以逐个返回值，而非一次性返回完整集合，让代码在遍历数据时更加高效和简洁。

yield主要有 yield return 和 yield break 两种形式。

使用场景

1、处理大数据集

当需要处理大量数据时，一次性将所有数据加载到内存可能会导致内存不足。使用yield可以逐个返回数据，减少内存占用。

2、实现自定义迭代逻辑

当需要实现自定义的迭代行为，如按特定顺序遍历数据、过滤数据等，可以使用yield来创建自定义的迭代器。

3、异步数据生成

在异步编程中，需要逐个逐步生成数据时，可以使用yield结合IAsyncEnumerable<T>实现异步流。

用法示例

1、yield return 用于同步迭代器

using System;
using System.Collections.Generic;

class Program
{
    // 定义一个返回 IEnumerable<int> 的迭代器方法
    static IEnumerable<int> GenerateNumbers(int count)
    {
        for (int i = 1; i <= count; i++)
        {
            // 使用 yield return 逐个返回值
            yield return i;
        }
    }

    static void Main()
    {
        // 使用 foreach 循环遍历迭代器返回的序列
        foreach (int num in GenerateNumbers(5))
        {
            Console.WriteLine(num);
        }
    }
}

2、yield break 提前终止迭代器

using System;
using System.Collections.Generic;

class Program
{
    static IEnumerable<int> GenerateNumbersWithBreak(int count)
    {
        for (int i = 1; i <= count; i++)
        {
            if (i == 3)
            {
                // 使用 yield break 提前终止迭代
                yield break;
            }
            yield return i;
        }
    }

    static void Main()
    {
        foreach (int num in GenerateNumbersWithBreak(5))
        {
            Console.WriteLine(num);
        }
    }
}

3、yield return 用于异步流

using System;
using System.Collections.Generic;
using System.Threading.Tasks;

class Program
{
    // 定义一个返回 IAsyncEnumerable<int> 的异步迭代器方法
    static async IAsyncEnumerable<int> GenerateNumbersAsync(int count)
    {
        for (int i = 1; i <= count; i++)
        {
            await Task.Delay(100); // 模拟异步操作
            // 异步返回值
            yield return i;
        }
    }

    static async Task Main()
    {
        // 使用 await foreach 异步遍历异步流
        await foreach (int num in GenerateNumbersAsync(5))
        {
            Console.WriteLine(num);
        }
    }
}

注意事项

方法限制：包含yield关键字的方法有一些限制，不能有ref或out参数，不能是匿名方法，也不能在try-catch块中直接使用yield return,但可以在try-finally块中使用。

性能影响：虽然yield可以占用减少内存占用，但每次调用yield return都会有一定的性能开销，因此在处理小数据集时可能并不划算。

异步流兼容性：使用IAsyncEnumerable需要C#8.0及以上版本，并且在调用异步流时需要使用await foreach语法。

状态管理：迭代器方法在暂时和恢复执行时会保存状态，这可能会导致意外的行为，特别是在多线程环境中使用时需要注意线程安全。