迭代器

迭代器也是C# 2.0的产物。

    1.1 迭代器的简介

         迭代器记录了集合中的某个位置，它使程序只能向前移动。C# 1.0中使用foreach语句来实现访问迭代器的内置支持，foreach使遍历集合变得简单，它比for语句更方便，也更容易理解。foreach被编译器编译后，会调用GetEnumerator来返回一个迭代器，也就是一个集合中的初始位置。

    1.2 C# 1.0中如何实现迭代器

         一个类型想要使用foreach关键字进行遍历，它必须实现IEnumerable或IEnumerable<T>接口。IEnumerable接口中定义了一个GetEnumerator方法用来返回迭代器，类型如果实现了IEnumerable接口，则也必须实现GetEnumerator方法。

        

namespace 迭代器
{
    class Program
    {
        static void Main(string[] args)
        {
            Friends friendcollection=new Friends();
            foreach (Friend friend in friendcollection)
            {
                Console.WriteLine(friend.Name);
            }
            Console.ReadKey();
        }
    }

    public class Friend
    {
        private string name;
        public string Name
        {
            get { return name; }
            set { name = value; }
        }

        public Friend(string name)
        {
            this.name = name;
        }
    }

    public class Friends : IEnumerable
    {
        private Friend[] friendarray;

        public Friends()
        {
            friendarray=new Friend[]
            {
                new Friend("张三"),
                new Friend("李四"),
                new Friend("王五"),   
            };
        }

        //索引器
        public Friend this[int index] => friendarray[index];

        public int Count => friendarray.Length;
        
        //实现IEnumerable<T>接口的方法
        public IEnumerator GetEnumerator()
        {
            return new FriendIterator(this);
        }
    }

    public class FriendIterator : IEnumerator
    {
        private readonly Friends friends;
        private int index;
        private Friend current;
        internal FriendIterator(Friends friendcollection)
        {
            this.friends = friendcollection;
            index = 0;
        }
        
        public bool MoveNext()
        {
            if (index + 1 > friends.Count)
            {
                return false;
            }
            else
            {
                this.current = friends[index];
                index++;
                return true;
            }
        }

        public void Reset()
        {
            index = 0;
        }
        //实现IEnumerator接口中的方法
        public object Current => this.current;

    }
}

    从以上的代码可以看出，在C# 1.0中，要使用某个类型可以迭代是需要写大量代码的。

    1.3 C# 2.0简化了迭代器的实现

          不说这么多，直接上代码：

          

namespace 迭代器
{
    class Program
    {
        static void Main(string[] args)
        {
            Friends friendcollection=new Friends();
            foreach (Friend friend in friendcollection)
            {
                Console.WriteLine(friend.Name);
            }
            Console.ReadKey();
        }
    }

    public class Friend
    {
        private string name;
        public string Name
        {
            get { return name; }
            set { name = value; }
        }

        public Friend(string name)
        {
            this.name = name;
        }
    }

    public class Friends : IEnumerable
    {
        private Friend[] friendarray;

        public Friends()
        {
            friendarray=new Friend[]
            {
                new Friend("张三"),
                new Friend("李四"),
                new Friend("王五"),   
            };
        }

        //索引器
        public Friend this[int index] => friendarray[index];

        public int Count => friendarray.Length;
        
        //实现IEnumerable<T>接口的方法
        public IEnumerator GetEnumerator()
        {
            for (int index = 0; index < friendarray.Length; index++)
            {
                //在C# 2.0中，只需要使用下面的语句就可以实现一个迭代器
                yield return friendarray[index];
            }
        }
    }
}

    这段代码只用了一个yield return就完成了迭代器的实现，它作用就是在告诉编译器，GetEnumerator方法不是一个普通的方法，而是实现迭代器的方法。当编译器看到yield return 语句时，会在中间代码中为我们生成了一个IEnumerator接口的对象。可以使用反射工具Reflector看一下。

     

由上图可以看出，yield return语句其实是C#中提供的另一个语法糖（语法糖可以理解为C#提供的一种方便形式），它简化了我们的迭代器源代码，把具体而复杂的实现过程留给了编译器去完成。