C#关键字之yield(迭代器)

今天讲到迭代器，对迭代器中yield关键字做了研究。

 

说起yield，不得不先说说迭代器。
迭代器是C# 2.0中的新功能，有了它，我们就可以在自己的类或者结构中支持foreach迭代而不必实现整个IEnumerable接口，我们只需要提供一个迭代器，即可遍历类中的数据结构。当编译器检测到迭代器时，它将自动生成IEnumerable接口的Current、MoveNext和Dispose方法。
而迭代器代码使用yield return语句依次返回每个元素。yield break将中止迭代。到达yield return语句时，会保存当前迭代的位置，下次调用迭代器时将从此位置开始执行。

在下面的示例中，迭代器块（这里是方法 Power(int number, int power)）中使用了 yield 语句。当调用 Power 方法时，它返回一个包含数字幂的可枚举对象。注意 Power 方法的返回类型是 IEnumerable（一种迭代器接口类型）。

1. // yield-example.cs
2. using System;
3. using System.Collections;
4. public class List
5. {
6.     public static IEnumerable Power(int number, int exponent)
7.      {
8.         int counter = 0;
9.         int result = 1;
10.         while (counter++ < exponent)
11.          {
12.              result = result * number;
13.              yield return result;
14.          }
15.      }
16.     static void Main()
17.      {
18.         // Display powers of 2 up to the exponent 8:
19.         foreach (int i in Power(2, 8))
20.          {
21.              Console.Write("{0} ", i);
22.          }
23.      }
24. }

 yield
    关键字yield：在迭代器块中用于向枚举数对象提供值或发出迭代结束信号。迭代器块有两个特殊语句：
          ●yield return <expression_r_r_r_r>;
          ●yield break;

迭代器块
    迭代器块是有一个或多个yield语句的代码块。下面三种类型的代码块中的任意一种都可以是迭代器块:
          ■方法主体
          ■访问器主体
          ■运算符主体

    yield语句只能出现在迭代器块中，该块可用作方法、运算符或访问器的体。这类方法、运算符或访问器的体受以下约束的控制：
        ■不允许不安全块。
        ■方法、运算符或访问器的参数不能是 ref 或 out。
        ■yield语句不能出现在匿名方法中。
        ■yield return语句不能出现在catch 块中或含有一个或多个catch子句的try块中。

    yield语句的迭代块可以产生IEnumerator和IEnumerable两种对象：
    ★IEnumerable对象：
        public IEnumerable<int> GetInts()
        {
            yield return 0;
            yield return 1;
            yield return 2;
            yield return 3;
        }
    使用示例：直接作用在foreach语句中
        foreach (int i in GetInts())
        {
            Console.WriteLine(i.ToString());
        }
    ★IEnumerator对象：
        public IEnumerator<int> GetEnumerator()//注意方法名
        {
            yield return 0;
            yield return 1;
            yield return 2;
            yield return 3;
        }
    使用示例1：无法直接用于foreach语句，获取迭代器的方法名可任意选择，如MyEnumerator().
        Integers ints = new Integers();//Integers是GetEnumerator()方法所在的类。
        IEnumerator<int> enumerator = ints.GetEnumerators();
        while (enumerator.MoveNext())
        {
            Console.WriteLine(enumerator.Current.ToString());
        }
    使用示例2：可以作用于foreach语句，但是是方法所在的类用在foreach语句中，并且必须使用GetEnumerator作为获取迭代器的方法名。
        Integers ints = new Integers();//Integers是GetEnumerator()方法所在的类。
        foreach (int i in ints)
        {
            Console.WriteLine(i.ToString());
        }

PS：几乎所有的对yield return和直接return list的测试结果都会告诉你，yield return更慢。但是当你真正了解yield之后，相信多数情况下都会选择yield return的。