关键字yield

yield 关键字在迭代器块中用于向枚举器对象提供值或发出迭代结束信号。

先看一下下面的例子：

using System;
using System.Collections;

namespace yieldTest
{
    class Program
    {
        static void Main(string[] args)
        {
            StringCollection sc = new StringCollection();
            foreach (string str in sc)
            {
                Console.WriteLine(str);
            }
            Console.ReadLine();
        }
    }

    //public class StringCollection : IEnumerable
    //{
    //    public IEnumerator GetEnumerator()
    //    {
    //        yield return "aaa";
    //        yield return "bbb";
    //        yield return "ccc";
    //        yield return "ddd";
    //    }
    //}

    public class StringCollection : IEnumerable
    {
        public IEnumerator GetEnumerator()
        {
            return new Enumerator();
        }

        class Enumerator : IEnumerator, IDisposable
        {
            private string current;

            public object Current
            {
                get { return current; }
            }

            public bool MoveNext()
            {
                switch (current)
                {
                    case "aaa":
                        current = "bbb";
                        return true;
                    case "bbb":
                        current = "ccc";
                        return true;
                    case "ccc":
                        current = "ddd";
                        return true;
                    case "ddd":
                        return false;
                    default:
                        current = "aaa";
                        return true;
                }
            }

            public void Reset()
            {
                throw new NotImplementedException();
            }

            public void Dispose()
            {
               
            }
        }
    }
}

在这个例子中，注释掉的内容引用了“yield return”， 其功能完全等同于下面那么大段代码。在我们编写某个支持遍历的类型时就必须实现接口IEnumerable，这个接口后续实现比较繁琐要写一大堆代码才能支持真正的遍历功能。yield简化了遍历操作的实现语法。它的形式为下列之一：

  yield return <expression>;
  yield break;

yield 关键字与 return 关键字结合使用，向枚举器对象提供值。这是一个返回值，例如，在上面的例子中 foreach 语句的每一次循环中返回的值。这种取得返回值的方式有所不同，即取到一个数据后马上返回该数据，不需要全部数据装入数列完毕，这样有效提高了遍历效率。例如：

using System;
using System.Collections;
using System.Threading;

namespace yieldTest
{
    public class NumberCollection : System.Collections.IEnumerable
    {
        public System.Collections.IEnumerator GetEnumerator()
        {
            yield return "1";
            Thread.Sleep(5000);
            yield return "2";
            Thread.Sleep(5000);
            yield return "3";
            Thread.Sleep(5000);
            yield return "4";
            Thread.Sleep(5000);
            yield return "5";
            Thread.Sleep(5000);
            yield return "6";
        }
    }

    class program
    {
        static void Main(string[] args)
        {
            NumberCollection arrPersons = new NumberCollection();
            foreach (string s in arrPersons)
            {
                System.Console.WriteLine(s);
            }

            System.Console.ReadLine();
        }
    }
}

yield 关键字也可与  break 结合使用，表示迭代结束。例如：

class program
    {
        public static IEnumerable Power(int number, int exponent)
        {
            int counter = 0;
            int result = 1;
            while (true)
            {
                if (counter > exponent)
                    yield break;
                counter++;
                result = result * number;
                yield return result;
            }
            yield return 999;
        }
        static void Main(string[] args)
        {
            foreach (int i in Power(2, 8))
            {
                Console.Write("{0} ", i);
            }
            Console.ReadLine();
        }
    }

其中  yield return 999; 这段代码是为了测试 yield break 与普通的break的区别，普通的break只是跳出while循环，这时它还停留在迭代器中；在 yield break 语句中，控制权将无条件地返回给迭代器的调用方，该调用方为枚举器对象的 IEnumerator.MoveNext 方法（或其对应的泛型 System.Collections.Generic.IEnumerable<T>）或 Dispose 方法。

其他：

yield return <expression>; //在 yield return 语句中，将计算 expression 并将结果以值的形式返回给枚举器对象；expression 必须可以隐式转换为 yield 类型的迭代器。

yield 语句只能出现在 iterator 块中，这种块可作为方法、运算符或访问器的主体实现。这类方法、运算符或访问器的体受以下约束的控制：

不允许不安全块。

方法、运算符或访问器的参数不能是 ref 或 out。

yield return 语句不能放在 try-catch 块中的任何位置。该语句可放在后跟 finally 块的 try 块中。

yield break 语句可放在 try 块或 catch 块中，但不能放在 finally 块中。

yield 语句不能出现在匿名方法中。

有关更多信息，请参见匿名方法（C# 编程指南）。