在如何只能暴露IList<>的一个片段问题中，其中一个答案有以下代码片段:
IEnumerable<object> FilteredList()
{
foreach(object item in FullList)
{
if(IsItemInPartialList(item))
yield return item;
}
}
yield关键字在这里做什么?我在一些地方看到过它，还有一个问题，但我还没搞清楚它到底是干什么的。我习惯于从一个线程屈服于另一个线程的意义上考虑屈服，但这在这里似乎无关紧要。
这是一个非常简单和容易的方法来创建一个枚举对象。编译器创建了一个类来包装您的方法，并在本例中实现IEnumerable<object>。如果没有yield关键字，则必须创建一个实现IEnumerable<object>的对象。
直观地，关键字从函数中返回一个值而不离开它，即在您的代码示例中，它返回当前项的值，然后继续循环。更正式地说，它被编译器用来为迭代器生成代码。迭代器是返回IEnumerable对象的函数。MSDN上有几篇关于它们的文章。
yield上下文关键字实际上在这里做了很多事情。
该函数返回一个实现IEnumerable<object>接口的对象。如果调用函数开始覆盖该对象，则再次调用该函数，直到它“屈服”。这是c# 2.0中引入的语法糖。在早期的版本中，你必须创建你自己的IEnumerable和IEnumerator对象来做这样的事情。
理解这类代码的最简单方法是输入一个示例，设置一些断点，然后看看会发生什么。试试下面这个例子:
public void Consumer()
{
foreach(int i in Integers())
{
Console.WriteLine(i.ToString());
}
}
public IEnumerable<int> Integers()
{
yield return 1;
yield return 2;
yield return 4;
yield return 8;
yield return 16;
yield return 16777216;
}
当您逐步浏览这个示例时，您将发现对Integers()的第一个调用返回1。第二次调用返回2，并且不再执行yield return 1行。
下面是一个现实生活中的例子:
public IEnumerable<T> Read<T>(string sql, Func<IDataReader, T> make, params object[] parms)
{
using (var connection = CreateConnection())
{
using (var command = CreateCommand(CommandType.Text, sql, connection, parms))
{
command.CommandTimeout = dataBaseSettings.ReadCommandTimeout;
using (var reader = command.ExecuteReader())
{
while (reader.Read())
{
yield return make(reader);
}
}
}
}
}
最近Raymond Chen也发表了一系列关于yield关键字的有趣文章。
c#中迭代器的实现及其后果(第1部分) c#中迭代器的实现及其后果(第2部分) c#中迭代器的实现及其后果(第3部分) c#中迭代器的实现及其后果(第4部分)
虽然它名义上用于轻松实现迭代器模式，但可以泛化为状态机。没有必要引用Raymond，最后一部分也链接到其他用法(但Entin博客中的例子特别好，展示了如何编写异步安全代码)。
它试图带来一些Ruby的善良:) 概念:这是一些示例Ruby代码，打印出数组的每个元素
rubyArray = [1,2,3,4,5,6,7,8,9,10]
rubyArray.each{|x|
puts x # do whatever with x
}
数组的每个方法实现将控制权移交给调用者('puts x')，数组的每个元素都整齐地表示为x。然后调用者可以对x做任何需要做的事情。
然而。net并没有完全做到这一点。c#似乎已经与IEnumerable耦合了yield，在某种程度上迫使你在调用者中写一个foreach循环，就像Mendelt的响应中看到的那样。没有那么优雅。
//calling code
foreach(int i in obCustomClass.Each())
{
Console.WriteLine(i.ToString());
}
// CustomClass implementation
private int[] data = {1,2,3,4,5,6,7,8,9,10};
public IEnumerable<int> Each()
{
for(int iLooper=0; iLooper<data.Length; ++iLooper)
yield return data[iLooper];
}
c#的yield关键字，简单地说，允许多次调用一段被称为迭代器的代码，它知道如何在完成之前返回，并且当再次调用时，继续它离开的地方——也就是说，它帮助迭代器在连续调用中返回的序列中的每一项都具有透明的状态。
在JavaScript中，同样的概念被称为生成器。
屈服有两大用处，
它有助于在不创建临时集合的情况下提供自定义迭代。 它有助于进行有状态迭代。
为了更清楚地解释以上两点，我制作了一个简单的视频，你可以在这里观看
Yield return与枚举器一起使用。在yield语句的每次调用中，控制权都返回给调用方，但它确保被调用方的状态得到维护。因此，当调用方枚举下一个元素时，它将在yield语句之后立即在被调用方方法from语句中继续执行。
让我们通过一个例子来理解这一点。在这个例子中，对应于每一行，我已经提到了执行流的顺序。
static void Main(string[] args)
{
foreach (int fib in Fibs(6))//1, 5
{
Console.WriteLine(fib + " ");//4, 10
}
}
static IEnumerable<int> Fibs(int fibCount)
{
for (int i = 0, prevFib = 0, currFib = 1; i < fibCount; i++)//2
{
yield return prevFib;//3, 9
int newFib = prevFib + currFib;//6
prevFib = currFib;//7
currFib = newFib;//8
}
}
此外，还为每个枚举维护状态。假设，我对Fibs()方法有另一个调用，那么它的状态将被重置。
乍一看，yield return是一个。net糖返回一个IEnumerable。
如果没有yield，集合中的所有项都是一次性创建的:
class SomeData
{
public SomeData() { }
static public IEnumerable<SomeData> CreateSomeDatas()
{
return new List<SomeData> {
new SomeData(),
new SomeData(),
new SomeData()
};
}
}
同样的代码使用yield，它逐项返回:
class SomeData
{
public SomeData() { }
static public IEnumerable<SomeData> CreateSomeDatas()
{
yield return new SomeData();
yield return new SomeData();
yield return new SomeData();
}
}
使用yield的优点是，如果使用数据的函数只需要集合的第一个项，则不会创建其余的项。
yield操作符允许根据需要创建项。这是一个使用它的好理由。
列表或数组实现立即加载所有项，而yield实现提供了延迟执行的解决方案。
在实践中，为了减少应用程序的资源消耗，通常需要执行所需的最小工作量。
例如，我们可能有一个处理数据库中数百万条记录的应用程序。当我们在一个基于延迟执行的拉式模型中使用IEnumerable时，可以实现以下好处:
Scalability, reliability and predictability are likely to improve since the number of records does not significantly affect the application’s resource requirements. Performance and responsiveness are likely to improve since processing can start immediately instead of waiting for the entire collection to be loaded first. Recoverability and utilisation are likely to improve since the application can be stopped, started, interrupted or fail. Only the items in progress will be lost compared to pre-fetching all of the data where only using a portion of the results was actually used. Continuous processing is possible in environments where constant workload streams are added.
这里是先构建集合(如列表)与使用yield之间的比较。
列表的例子
public class ContactListStore : IStore<ContactModel>
{
public IEnumerable<ContactModel> GetEnumerator()
{
var contacts = new List<ContactModel>();
Console.WriteLine("ContactListStore: Creating contact 1");
contacts.Add(new ContactModel() { FirstName = "Bob", LastName = "Blue" });
Console.WriteLine("ContactListStore: Creating contact 2");
contacts.Add(new ContactModel() { FirstName = "Jim", LastName = "Green" });
Console.WriteLine("ContactListStore: Creating contact 3");
contacts.Add(new ContactModel() { FirstName = "Susan", LastName = "Orange" });
return contacts;
}
}
static void Main(string[] args)
{
var store = new ContactListStore();
var contacts = store.GetEnumerator();
Console.WriteLine("Ready to iterate through the collection.");
Console.ReadLine();
}
控制台输出 ContactListStore:创建联系人 ContactListStore:创建联系人 ContactListStore:正在创建联系人 准备遍历集合。
注意:整个集合被加载到内存中，甚至没有请求列表中的任何项
收益率的例子
public class ContactYieldStore : IStore<ContactModel>
{
public IEnumerable<ContactModel> GetEnumerator()
{
Console.WriteLine("ContactYieldStore: Creating contact 1");
yield return new ContactModel() { FirstName = "Bob", LastName = "Blue" };
Console.WriteLine("ContactYieldStore: Creating contact 2");
yield return new ContactModel() { FirstName = "Jim", LastName = "Green" };
Console.WriteLine("ContactYieldStore: Creating contact 3");
yield return new ContactModel() { FirstName = "Susan", LastName = "Orange" };
}
}
static void Main(string[] args)
{
var store = new ContactYieldStore();
var contacts = store.GetEnumerator();
Console.WriteLine("Ready to iterate through the collection.");
Console.ReadLine();
}
控制台输出 准备遍历集合。
注意:收集根本没有执行。这是由于IEnumerable的“延迟执行”特性。只有在真正需要时才会构造一个项。
让我们再次调用集合，并在取回集合中的第一个联系人时反转行为。
static void Main(string[] args)
{
var store = new ContactYieldStore();
var contacts = store.GetEnumerator();
Console.WriteLine("Ready to iterate through the collection");
Console.WriteLine("Hello {0}", contacts.First().FirstName);
Console.ReadLine();
}
控制台输出 准备遍历集合 ContactYieldStore:创建联系人 你好,鲍勃
好了!当客户端从集合中“拉出”项目时，只构造了第一个联系人。
这个链接有一个简单的例子
这里还有更简单的例子
public static IEnumerable<int> testYieldb()
{
for(int i=0;i<3;i++) yield return 4;
}
注意yield return不会从方法返回。你甚至可以在收益率后面加上一个WriteLine
上面生成了一个4个整数的IEnumerable (4,4,4,4)
这里有一个WriteLine。将向列表中添加4，打印abc，然后向列表中添加4，然后完成方法，从而真正从方法中返回(一旦方法完成，就像没有返回的过程一样)。但它会有一个值，一个IEnumerable int列表，它会在补全时返回。
public static IEnumerable<int> testYieldb()
{
yield return 4;
console.WriteLine("abc");
yield return 4;
}
还要注意，当使用yield时，返回的结果与函数的类型不同。它是IEnumerable列表中的元素类型。
将yield与方法的返回类型一起使用IEnumerable。如果方法的返回类型是int或List<int>并且使用yield，那么它将不会被编译。你可以在没有yield的情况下使用IEnumerable方法返回类型，但似乎你不能在没有IEnumerable方法返回类型的情况下使用yield。
为了让它执行，你必须用特殊的方式调用它。
static void Main(string[] args)
{
testA();
Console.Write("try again. the above won't execute any of the function!\n");
foreach (var x in testA()) { }
Console.ReadLine();
}
// static List<int> testA()
static IEnumerable<int> testA()
{
Console.WriteLine("asdfa");
yield return 1;
Console.WriteLine("asdf");
}
下面是理解这个概念的简单方法: 其基本思想是，如果您想要一个可以使用“foreach”的集合，但是由于某些原因将项收集到集合中成本很高(例如从数据库中查询它们)，并且通常不需要整个集合，那么您可以创建一个函数，每次构建一个项集合并将其返回给消费者(然后消费者可以提前终止收集工作)。
Think of it this way: You go to the meat counter and want to buy a pound of sliced ham. The butcher takes a 10-pound ham to the back, puts it on the slicer machine, slices the whole thing, then brings the pile of slices back to you and measures out a pound of it. (OLD way). With yield, the butcher brings the slicer machine to the counter, and starts slicing and "yielding" each slice onto the scale until it measures 1-pound, then wraps it for you and you're done. The Old Way may be better for the butcher (lets him organize his machinery the way he likes), but the New Way is clearly more efficient in most cases for the consumer.
yield关键字允许您在迭代器块上以该形式创建一个IEnumerable<T>。这个迭代器块支持延迟执行，如果你不熟悉这个概念，它可能看起来很神奇。然而，在一天结束的时候，它只是没有任何奇怪的技巧执行的代码。
迭代器块可以被描述为语法糖，其中编译器生成一个状态机，跟踪枚举对象的枚举进行了多远。要枚举一个可枚举对象，通常使用foreach循环。然而，foreach循环也是语法糖。所以你是两个从实际代码中移除的抽象，这就是为什么最初可能很难理解它们是如何一起工作的。
假设你有一个非常简单的迭代器块:
IEnumerable<int> IteratorBlock()
{
Console.WriteLine("Begin");
yield return 1;
Console.WriteLine("After 1");
yield return 2;
Console.WriteLine("After 2");
yield return 42;
Console.WriteLine("End");
}
真正的迭代器块通常有条件和循环，但当你检查条件并展开循环时，它们仍然是yield语句与其他代码交织在一起。
要枚举迭代器块，使用foreach循环:
foreach (var i in IteratorBlock())
Console.WriteLine(i);
下面是输出(这里没有惊喜):
Begin 1 After 1 2 After 2 42 End
如上所述，foreach是语法糖:
IEnumerator<int> enumerator = null;
try
{
enumerator = IteratorBlock().GetEnumerator();
while (enumerator.MoveNext())
{
var i = enumerator.Current;
Console.WriteLine(i);
}
}
finally
{
enumerator?.Dispose();
}
为了解决这个问题，我画了一个去掉抽象的序列图:
编译器生成的状态机也实现了枚举器，但为了使图更清晰，我将它们作为单独的实例显示。(当状态机从另一个线程中枚举时，您实际上会得到单独的实例，但在这里这个细节并不重要。)
每次调用迭代器块时，都会创建一个状态机的新实例。但是，迭代器块中的任何代码都不会执行，直到enumerator.MoveNext()第一次执行。这就是延迟执行的工作方式。这里有一个(相当愚蠢的)例子:
var evenNumbers = IteratorBlock().Where(i => i%2 == 0);
此时迭代器还没有执行。Where子句创建了一个新的IEnumerable<T>，它包装了IteratorBlock返回的IEnumerable<T>，但是这个可枚举对象还没有被枚举。这发生在你执行foreach循环时:
foreach (var evenNumber in evenNumbers)
Console.WriteLine(eventNumber);
如果枚举可枚举对象两次，那么每次都会创建一个状态机的新实例，迭代器块将执行相同的代码两次。
Notice that LINQ methods like ToList(), ToArray(), First(), Count() etc. will use a foreach loop to enumerate the enumerable. For instance ToList() will enumerate all elements of the enumerable and store them in a list. You can now access the list to get all elements of the enumerable without the iterator block executing again. There is a trade-off between using CPU to produce the elements of the enumerable multiple times and memory to store the elements of the enumeration to access them multiple times when using methods like ToList().
如果我正确地理解了这一点，下面是我如何从函数实现IEnumerable的角度来表达这一点。
这是一个。 如果你需要另一个，请再打电话。 我会记得我给你的。 你下次打电话来的时候我才知道能不能再给你。
关于Yield关键字的一个主要观点是惰性执行。现在我所说的惰性执行是指在需要时执行。更好的表达方式是举个例子
示例:不使用Yield，即没有Lazy Execution。
public static IEnumerable<int> CreateCollectionWithList()
{
var list = new List<int>();
list.Add(10);
list.Add(0);
list.Add(1);
list.Add(2);
list.Add(20);
return list;
}
示例:使用Yield，即惰性执行。
public static IEnumerable<int> CreateCollectionWithYield()
{
yield return 10;
for (int i = 0; i < 3; i++)
{
yield return i;
}
yield return 20;
}
当我调用两个方法时。
var listItems = CreateCollectionWithList();
var yieldedItems = CreateCollectionWithYield();
你会注意到listItems里面有5个项目(调试时将鼠标悬停在listItems上)。 而yieldItems将只有一个对方法的引用，而不是对项目的引用。 这意味着它没有在方法中执行获取项的过程。一种只在需要时获取数据的非常有效的方法。 yield的实际实现可以在ORM中看到，如Entity Framework和NHibernate等。
简单的演示，了解产量
using System;
using System.Collections.Generic;
using System.Linq;
namespace ConsoleApp_demo_yield {
class Program
{
static void Main(string[] args)
{
var letters = new List<string>() { "a1", "b1", "c2", "d2" };
// Not yield
var test1 = GetNotYield(letters);
foreach (var t in test1)
{
Console.WriteLine(t);
}
// yield
var test2 = GetWithYield(letters).ToList();
foreach (var t in test2)
{
Console.WriteLine(t);
}
Console.ReadKey();
}
private static IList<string> GetNotYield(IList<string> list)
{
var temp = new List<string>();
foreach(var x in list)
{
if (x.Contains("2")) {
temp.Add(x);
}
}
return temp;
}
private static IEnumerable<string> GetWithYield(IList<string> list)
{
foreach (var x in list)
{
if (x.Contains("2"))
{
yield return x;
}
}
}
}
}
现在你可以在异步流中使用yield关键字。
c# 8.0引入了异步流，它对流数据源进行了建模。数据流通常异步检索或生成元素。异步流依赖于。net Standard 2.1中引入的新接口。. net Core 3.0及更高版本支持这些接口。它们为异步流数据源提供了自然的编程模型。 来源:微软文档
在下面的例子
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
public class Program
{
public static async Task Main()
{
List<int> numbers = new List<int>() { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 };
await foreach(int number in YieldReturnNumbers(numbers))
{
Console.WriteLine(number);
}
}
public static async IAsyncEnumerable<int> YieldReturnNumbers(List<int> numbers)
{
foreach (int number in numbers)
{
await Task.Delay(1000);
yield return number;
}
}
}
