什么是迭代器,创建并使用迭代器.为整数列表创建迭代器.为泛型列表创建迭代器

迭代器

导读

什么是迭代器

创建并使用迭代器

为整数列表创建迭代器

为泛型列表创建迭代器

什么是迭代器

迭代器（iterator）

迭代器是一种方法、get 访问器或运算符，它通过使用 yield 关键字对数组或集合类执行自定义迭代。yield 返回语句会导致源序列中的元素在访问源序列中的下一个元素之前立即返回给调用方。尽管您以方法的形式编写迭代器，但编译器会将其转换为一个实际上是状态机的嵌套类。只要客户端代码中的 foreach 循环继续进行，此类就会跟踪迭代器的位置。

 

注意：

若要了解编译器在后台执行了什么操作，请使用 ILDASM.exe 工具来查看为迭代器方法生成的中间语言 (IL) 代码。

 

将使用 foreach 语句从客户端代码中调用迭代器。例如，您可以为类创建一个迭代器，该迭代器将按相反顺序返回元素，或在迭代器返回元素之前对每个元素执行操作。在为类或结构创建迭代器时，您不必实现整个 IEnumerator 接口。当编译器检测到迭代器时，它将自动生成 IEnumerator 或 IEnumerator<(Of <(T>)>) 接口的 Current、MoveNext 和 Dispose 方法。

 

迭代器概述

l  迭代器是可以返回相同类型的值的有序序列的一段代码。

l  迭代器可用作方法、运算符或 get 访问器的代码体。

l  迭代器代码使用 yield return 语句依次返回每个元素。yield break 将终止迭代。

l  可以在类中实现多个迭代器。每个迭代器都必须像任何类成员一样有唯一的名称，并且可以在 foreach 语句中被客户端代码调用，如下所示：foreach(int x in SampleClass.Iterator2){}。

l  迭代器的返回类型必须为 IEnumerable、IEnumerator、IEnumerable<(Of <(T>)>) 或 IEnumerator<(Of <(T>)>)。

l  迭代器是 LINQ 查询中延迟执行行为的基础。

 

yield 关键字用于指定返回的一个或多个值。到达 yield return 语句时，会保存当前位置。下次调用迭代器时将从此位置重新开始执行。

 

迭代器对集合类特别有用，它提供一种简单的方法来迭代复杂的数据结构（如二进制树）。

示例

在本示例中，DaysOfTheWeek 类是将一周中的各天作为字符串进行存储的简单集合类。foreach 循环每迭代一次，都返回集合中的下一个字符串

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

 

//导入命名空间

using System.Collections;

namespace MvcUsedKeywords

{

    public class DaysOfTheWeek:IEnumerable

    {

        string[] m_Days = { "Sun", "Mon", "Tue", "Wed", "Thr", "Fri", "Sat" };

                   //实现接口中的方法，创建迭代器

        public IEnumerator GetEnumerator()

        {

            for (int i = 0; i < m_Days.Length; i++)

            {

                yield return m_Days[i];

            }

        }

    }

    class TestDaysOfTheWeek

    {

        static void Main(string[] args)

        {

            DaysOfTheWeek week = new DaysOfTheWeek();

 

            foreach (string day in week)

            {

                Console.Write(day + " ");

            }

            Console.WriteLine();           

        }

    }

}

         调试下发现，foreach中每调用一次week，GetEnumerator()方法中的for循环一次，感觉是在同步进行。

运行结果： Sun Mon Tue Wed Thr Fri Sat

 

 

创建并使用迭代器

       创建迭代器最常用的方法是对 IEnumerable 接口实现 GetEnumerator 方法。GetEnumerator 方法的存在使得类型成为可枚举的类型，并允许使用 foreach 语句。foreach 语句调用类中实现GetEnumerator()方法，并使用返回的枚举数来循环访问值。如下例中的创建迭代器1，创建迭代器2。

       还可以使用命名的迭代器以支持通过不同的方式循环访问同一数据集合。例如，您可以提供一个按升序返回元素的迭代器，而提供按降序返回元素的另一个迭代器。迭代器还可以带有参数，以便允许客户端控制全部或部分迭代行为。如下例中的创建迭代器3。

       可以在同一个迭代器中使用多个 yield 语句。如下例中的创建迭代器4。

       为泛型列表创建迭代器块，要实现泛型接口 IEnumerator<T>)，还要实现非泛型 GetEnumerator，因为 IEnumerable<T>) 继承自 IEnumerable。如下例中的创建迭代器5。在类名后加个类型<T>，类里声明了一个类型 T 的数组，并使用 Add 方法给数组赋值。在 GetEnumerator 方法中，使用 yield return 语句返回数组的值。

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

 

//导入命名空间

using System.Collections;

namespace MvcUsedKeywords

{

    //创建迭代器1

    class ListOne

    {

        //实现接口IEnumerable里的GetEnumerator()方法

        public IEnumerator GetEnumerator()

        {

            for (int i = 0; i < 10; i++)

            {

                yield return i;

            }

        }

    }

 

    //创建迭代器2

    class ListTwo : IEnumerable

    {

        //实现接口IEnumerable里的GetEnumerator()方法

        public IEnumerator GetEnumerator()

        {

            for (int i = 0; i < 10; i++)

            {

                yield return i;

            }

        }

    }

 

    //创建迭代器3

    class ListThree

    {

        //使用命名的迭代器来定义,返回0-9的偶数

        public IEnumerable GetEvenNumber()

        {

            for (int i = 0; i < 10; i = i + 2)

            {

                yield return i;

            }

        }

 

        //使用命名的迭代器来定义,返回指定范围里的偶数

        public IEnumerable GetEvenNumber(int start, int end)

        {

            for (int i = start; i <= end; i++)

            {

                yield return i;

            }

        }

    }

 

    //创建迭代器4

    class ListFour

    {

        //可以在同一个迭代器中使用多个 yield 语句

        public IEnumerator GetEnumerator()

        {

            yield return "我是";

            yield return "中国人,";

            yield return "我爱编程.";

            yield return "你呢？";

        }

    }

 

    class ListClass

    {

        static void Main(string[] args)

        {

            //利用实现接口IEnumerable里的GetEnumerator()方法

            Console.Write("方式一：");

            ListOne list1 = new ListOne();

            foreach (int i in list1)

            {

                Console.Write(i + " ");

            }

 

            //利用实现接口IEnumerable里的GetEnumerator()方法

            Console.Write("/n方式二：");

            ListTwo list2 = new ListTwo();

            foreach (int i in list2)

            {

                Console.Write(i + " ");

            }

 

            //调用命名的迭代器，无参数。返回0-9的偶数

            Console.Write("/n调用命名的迭代器：");

            ListThree list3 = new ListThree();

            foreach (int i in list3.GetEvenNumber())

            {

                Console.Write(i+" ");

            }

 

            //调用命名的迭代器,有参数。返回指定范围里的偶数

            Console.Write("/n调用命名的迭代器：");

            foreach (int i in list3.GetEvenNumber(10, 20))

            {

                Console.Write(i + " ");

            }

 

            //调用用多个yield语句的迭代器

            ListFour list4 = new ListFour();

            Console.Write("/n用多个yield语句：");

            foreach (string i in list4)

            {

                Console.Write(i);

            }

        }

    }

}

输出：

方式一：0 1 2 3 4 5 6 7 8 9

方式二：0 1 2 3 4 5 6 7 8 9

调用命名的迭代器：0 2 4 6 8

调用命名的迭代器：10 11 12 13 14 15 16 17 18 19 20

用多个yield语句：我是中国人,我爱编程.你呢？

 

为整数列表创建迭代器

       使用一个整数数组来构建列表。for 循环对集合进行循环访问，并返回每项的值。然后使用 foreach 循环来显示该集合的项。

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

 

//导入命名空间

using System.Collections;

 

namespace MvcUsedKeywords

{

    //为整数列表创建迭代器块

    public class ListNum

    {

        public int[] items;

        public ListNum()

        {

            items = new int[5] { 0,2,4,6,8 };

        }

 

        public IEnumerable GetEvenNumber()

        {

            for (int i = 0; i < items.Length; i++)

            {

                yield return items[i];

            }

        }

    }

    class MainClass

    {

        static void Main(string[] args)

        {

            //显示集合各项

            ListNum mylist = new ListNum();

            foreach (int i in mylist.GetEvenNumber())

            {

                Console.Write(i + " ");

            }

        }

    }

}

输出：0 2 4 6 8

 

为泛型列表创建迭代器

为泛型列表创建迭代器块，要实现泛型接口 IEnumerator<T>)，还要实现非泛型 GetEnumerator，因为 IEnumerable<T>) 继承自 IEnumerable。

在类名后加个类型<T>，类里声明了一个类型 T 的数组，并使用 Add 方法给数组赋值。在 GetEnumerator 方法中，使用 yield return 语句返回数组的值。

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

 

//导入命名空间

using System.Collections;

 

namespace MvcUsedKeywords

{

    //泛型列表创建迭代器

    class ListFive<T> : IEnumerable<T>

    {

        private T[] values = new T[100];

        private int top = 0;

 

        //往集合中添加元素

        public void Add(T t)

        {

            values[top++] = t;

        }

 

        //实现接口IEnumerable里的GetEnumerator<T>()方法

        public IEnumerator<T> GetEnumerator()

        {

            for (int i = top - 1; i >= 0; i--)

            {

                yield return values[i];

            }

        }

 

        //还实现非泛型 GetEnumerator，因为IEnumerable(T)继承自IEnumerable

        IEnumerator IEnumerable.GetEnumerator()

        {

            return GetEnumerator();

        }

    }

 

    class MainApp

    {

        static void Main(string[] args)

        {

            //调用为泛型列表创建的迭代器

            ListFive<string> list5 = new ListFive<string>();

 

            list5.Add("Red");

            list5.Add("Green");

            list5.Add("Blue");

 

            Console.Write("调用泛型列表迭代器：");

            foreach (string i in list5)

            {

                Console.Write(i + " ");

            }

            Console.WriteLine();

        }

    }

}

输出：调用泛型列表迭代器：Red Green Blue