C# 迭代器

1、迭代器

迭代器是程序设计的软件设计模式，提供了一个方法顺序访问一个聚合对象中的各个元素，而又不暴露其内部的标识

从表现效果上来看，是可以在容器对象（例如链表或数组）上遍历访问的接口，设计人员无需关心容器对象的内存分配的实现细节，可以用foreach遍历的类，都是实现了迭代器

2、标准迭代器的实现方法

命名空间：using System.Collections;

关键接口：IEnumerable，IEnumerator

可以通过同时继承IEnumerable和IEnumerator实现其中的方法 

class CustomList : IEnumerable, IEnumerator {
    private int[] list;

    // 从-1开始的光标用于表示数据得到了哪个位置
    private int position = -1;  

    public CustomList() {
        list = new int[] { 1, 2, 3, 4, 5, 6, 7, 8, 9 };
    }

        

    #region IEnumerable
    public IEnumerator GetEnumerator() {
        Reset();
        return this;
    }
    #endregion

    #region IEnumerator
    public object Current {
        get {
            return list[position];
        }
    }

    public bool MoveNext() {
        // 移动光标判断是否是否溢出，溢出则不合法
        return ++position < list.Length;
    }

    // reset是重置光标位置，一般写在获取 IEnumerator 对象的函数中
    // 用于第一次重置光标位置
    public void Reset() {
        position = -1;            
    }
    #endregion
}

CustomList list = new CustomList();

// foreach执行过程：
// 1、先获取 in 后面这个对象的 IEnumerator
//    会调用对象其中的 GetEnumerator 方法来获取
//   （只要有这个方法就可以，即使没有继承IEnumerable接口）
// 2、执行得到的这个 IEnumerator 对象中的 MoveNext 方法
// 3、只要这个 MoveNext 方法的返回值是true，就会去得到 Current
//    然后赋值给 item 
foreach (int item in list) {
    Console.WriteLine(item);
}

3、用yield return语法糖实现迭代器

yield return 是C#提供的语法糖

语法糖也就是糖衣语法，主要作用就是将复杂逻辑简单化，可以增加程序的可读性，从而减少程序代码出错的机会

关键接口：IEnumerable

让想通过 foreach 遍历的自定义类实现接口中的方法 GetEnumerator 即可 

class CustomList2 : IEnumerable {
    private int[] list;

    public CustomList2() {
        list = new int[] { 1, 2, 3, 4, 5, 6, 7, 8, 9 };
    }

    public IEnumerator GetEnumerator() {
        for(int i = 0; i < list.Length; ++i) {
            // yield 关键字配合迭代器使用
            // 可以理解为暂时返回，保持当前的状态
            yield return list[i];
        }
    }
}

4、用yield return语法糖为泛型实现迭代器

class CustomList3 : IEnumerable {
    private T[] list;

    public CustomList3(params T[] list) {
        this.list = list;
    }

    public IEnumerator GetEnumerator() {
        for(int i = 0; i < list.Length; ++i) {
            yield return list[i];
        }
    }
}