深入理解C#中的yield关键字：提升迭代性能与效率

news2024/9/20 10:34:38

文章目录

前言
一、yield return
二、yield break
总结

前言

在C#中，yield 关键字是特别用于迭代器块和方法中的，它允许你逐个返回序列中的元素，而不是一次性返回整个集合。使用 yield 可以显著提高处理大数据集或进行复杂迭代时的性能和内存效率，因为它允许按需生成和返回数据，而不是预先生成整个数据集。

一、yield return

yield return 语句用于在迭代器块中返回一个元素，并且每次迭代时只执行到下一个 yield return 语句或迭代器块的末尾。当迭代器块执行完毕时，迭代结束。

public static IEnumerable<int> GetNumbers()  
{  
    for (int i = 0; i < 10; i++)  
    {  
        yield return i;  
    }  
}  
  
// 使用  
foreach (var number in GetNumbers())  
{  
    Console.WriteLine(number);  
}

GetNumbers 方法使用 yield return 逐个返回从0到9的数字。每次迭代调用 GetNumbers() 方法时，它都会从上次停止的地方继续执行，直到所有数字都被返回。

二、yield break

yield break 语句用于提前退出迭代器块。如果在迭代器块中遇到 yield break 语句，迭代器将停止执行，并且不会返回任何更多的元素。

public static IEnumerable<int> GetNumbersUpTo(int limit)  
{  
    for (int i = 0; i < limit; i++)  
    {  
        if (i == 5) // 假设我们只想要前5个数字  
        {  
            yield break;  
        }  
        yield return i;  
    }  
}  
  
// 使用  
foreach (var number in GetNumbersUpTo(10))  
{  
    Console.WriteLine(number);  
}

GetNumbersUpTo 方法在返回第5个数字后立即使用 yield break 退出迭代器块，因此不会返回任何超过5的数字。

总结

注意事项：

含有 yield return 语句的方法必须返回 IEnumerable、IEnumerable、IEnumerator 或 IEnumerator。
迭代器块不能包含 return 语句，除非该语句后面紧跟一个 yield break（在这种情况下，它实际上并不返回任何值）。
使用 yield 可以使代码更加简洁，并且可以提高处理大数据集时的性能。然而，它也有一些限制，比如不能用于非迭代器的上下文中，且不能用于异步方法中（C# 5.0及之前版本）。不过，从C# 8.0开始，引入了异步迭代器（async iterators），允许你在异步方法中使用 yield return 和 await。

不能使用 yield 的情况：