【FastReport.Net】什么是yield return？

---

【下载FastReport.Net最新版本】

yield return运算符是使用C＃的程序员中最不为人知的运算符之一。甚至那些了解它的人也不能完全确定他们正确理解其工作原理。必须纠正这个恼人的差距。而且，我希望这篇文章可以帮助你。

yield return运算符返回迭代器中的集合项，并将当前位置移动到下一个元素。yield return运算符的存在将该方法转换为迭代器。每次迭代器遇到yield return时，它都会返回一个值。此运算符向我们和编译器发出信号，表示此表达式是迭代器。迭代器的任务是在集合的元素之间移动并返回当前元素的值。许多人习惯于在循环中调用计数器作为迭代器，但事实并非如此，因为计数器不返回值。迭代器由编译器转换为“有限状态机”，跟踪当前位置并知道如何“移动”到下一个位置。在这种情况下，序列元素的值在访问它时计算。

这是迭代器的最简单示例：

public static IEnumerable<int> GetItems()
{
 foreach (var i in List)
 {
 yield return i;
 }
}

迭代器只能返回IEnumerable <>类型。

迭代器是更复杂的枚举器模式的语法快捷方式。当C＃编译器遇到迭代器时，它会将其内容扩展为实现枚举器模式的CIL代码。这种封装大大节省了程序员的时间。迭代器允许您执行所谓的“延迟计算”。这意味着仅在请求时才评估元素的值。为了更好地理解收益率回报如何运作，我们将其与传统周期进行比较 通过示例，一切都变得清晰。

（1）请注意，使用yield return，我们不需要创建额外的列表来填充值。因此我们节省了内存，因为我们只需要内存用于集合的当前元素。元素处理不分配内存，只分配缓存。

static IEnumerable<int> GetSequence()
 {
 Random rand = new Random();
 List<int> list = new List<int>();
 for (int i = 0; i < 3; i++)
 list.Add(rand.Next());
 return list;
 }
 
 static IEnumerable<int> GetSequence()
 {
 Random rand = new Random();
 for (int i = 0; i < 3; i++)
 yield return rand.Next();
 }

（2）不计算整个枚举结果的能力。在这个例子中，我们无限地生成数字：

IEnumerable<int> GetInfinityWithIterator()
{
var i = 0;
while (true)
yield return ++i;
}
 
IEnumerable<int> GetInfinityWithLoop()
{
 var i = 0;
 var list = new List<int>();
 while (true)
 list.Add(++i);
 return list;
}

下面来看看他们之间的差异：

foreach(var item in GetInfinityWithIterator().Take(5))
{
 Console.WriteLine(item);
}

我们使用LINQ运算符Take来限制样本量。在收益率返回的情况下，循环在第五个元素处停止。

foreach(var item in GetInfinityWithLoop().Take(5))
{
 Console.WriteLine(item);
}

你不能打断列表填写。结果，我们得到错误的内存不足。

（3）执行迭代器后调整集合值的能力。 由于yield在实际处理时返回一个集合元素（例如，当在控制台中显示元素的值时），即使在执行迭代器之后，我们也可以更改集合的元素。调用它时，迭代器实际上不会返回实际值。迭代器知道从哪里获取值。只有当他们真的需要时，他才会归还他们。这就是所谓的懒惰负载。

IEnumerable<int> MultipleYieldReturn(IEnumerable<int> mass)
{
 foreach (var item in mass)
 yield return item * item;
} 
 
IEnumerable<int> MultipleLoop(IEnumerable<int> mass)
{
 var list = new List<int>();
 foreach (var item in mass)
 list.Add(item * item);
 return list;
}

将调用这些方法：

 var mass = new List<int>() { 1, 2, 3 }; 
 var MultipleYieldReturn = Helper.MultipleYieldReturn(mass);
 var MultipleLoop = Helper.MultipleLoop(mass);
 
 mass.Add(4);
 Console.WriteLine(string.Join(",",MultipleYieldReturn));
 Console.WriteLine(string.Join(",", MultipleLoop));

结果是：

初始化MultipleYieldReturn和MultipleLoop变量后，我们再向集合中添加一个元素：mass.Add（4）;

 Console.WriteLine(string.Join(",",MultipleYieldReturn));
 Console.WriteLine(string.Join(",", MultipleLoop));

结果：

在将结果输出到控制台时，集合包含值4.由于yield return在查询时生成值，因此迭代器处理了所有当前值。在初始化MultipleLoop变量时运行传统循环，此时集合仅包含3个值。

（4）具有收益率回报的异常处理具有细微差别。yield return语句不能在try-catch部分中使用，只能在try-finally中使用。例如，如何在不知道约束的情况下编写：

public IEnumerable TransformData(List<string> data)
{
 foreach (string item in data)
 {
 try
 {
 yield return PrepareDataRow(item);
 }
 catch (Exception ex)
 {
 Console.Error.WriteLine(ex.Message);
 }
 }
}

在这种情况下，catch块永远不会捕获错误。这都是延迟执行收益率回报的原因。我们只在使用迭代器的数据进行实际工作时才了解错误。例如，当我们将数据从迭代器输出到控制台时。在此之前，迭代器不适用于实际数据。

如果你仍然需要“Catch”这个迭代器中的错误，那么你可以这样做：

public IEnumerable TransformData(List<string> data)
{
 string text;
 foreach (string item in data)
 {
 try
 {
 text = PrepareDataRow(item);
 }
 catch (Exception ex)
 {
 Console.Error.WriteLine(ex.Message);
 continue;
 }
 yield return text;
 }
}

yield break类似于break运算符，它只在迭代器中使用。这是一个小例子：

IEnumerable<int> GetNumbers()
{
int i = 0;
while (true)
{
if (i = 5)
yield break;
yield return i++;
}
}

从示例中可以清楚地看出，当达到5的值时，迭代器将结束，但在此之前它将正确返回值。

总结一下，什么时候应该使用yield return？

• 列出对象时。迭代器将比返回的集合更快地工作。并且内存开销较低;
• 在无限循环中。使用Take（）方法，您始终可以限制选择。