C#中foreach實現原理

本文主要記錄我在學習C#中foreach遍歷原理的心得體會。

對集合中的要素進行遍歷是所有編碼中經常涉及到的操作，因此大部分編程語言都把此過程寫進了語法中，比如C#中的foreach。經常會看到下麵的遍歷代碼：

            var lstStr = new List<string> { "a", "b" };
            foreach (var str in lstStr)
            {
                Console.WriteLine(str);
            }

實際此代碼的執行過程：

            var lstStr = new List<string> {"a", "b"};
            IEnumerator<string> enumeratorLst = lstStr.GetEnumerator();
            while (enumeratorLst.MoveNext())
            {
                Console.WriteLine(enumeratorLst.Current);
            }

會發現有GetEnumerator()方法和IEnumerator<string>類型，這就涉及到可枚舉類型和枚舉器的概念。

為了方便理解，以下為非泛型示例：

    // 摘要:
    //     公開枚舉器，該枚舉器支持在非泛型集合上進行簡單迭代。
    public interface IEnumerable
    {
        // 摘要:
        //     返回一個迴圈訪問集合的枚舉器。
        //
        // 返回結果:
        //     可用於迴圈訪問集合的 System.Collections.IEnumerator 對象。
        IEnumerator GetEnumerator();
    }

實現了此介面的類稱為可枚舉類型，是可以用foreach進行遍歷的標誌。

方法GetEnumerator()的返回值是枚舉器，可以理解為游標。

    // 摘要:
    //     支持對非泛型集合的簡單迭代。
    public interface IEnumerator
    {
        // 摘要:
        //     獲取集合中的當前元素。
        //
        // 返回結果:
        //     集合中的當前元素。
        //
        // 異常:
        //   System.InvalidOperationException:
        //     枚舉數定位在該集合的第一個元素之前或最後一個元素之後。
        object Current { get; }

        // 摘要:
        //     將枚舉數推進到集合的下一個元素。
        //
        // 返回結果:
        //     如果枚舉數成功地推進到下一個元素，則為 true；如果枚舉數越過集合的結尾，則為 false。
        //
        // 異常:
        //   System.InvalidOperationException:
        //     在創建了枚舉數後集合被修改了。
        bool MoveNext();
        //
        // 摘要:
        //     將枚舉數設置為其初始位置，該位置位於集合中第一個元素之前。
        //
        // 異常:
        //   System.InvalidOperationException:
        //     在創建了枚舉數後集合被修改了。
        void Reset();
    }

以下是自定義一個迭代器的示例（https://msdn.microsoft.com/en-us/library/system.collections.ienumerator.aspx）：

using System;
using System.Collections;

// Simple business object.
public class Person
{
    public Person(string fName, string lName)
    {
        this.firstName = fName;
        this.lastName = lName;
    }

    public string firstName;
    public string lastName;
}

// Collection of Person objects. This class
// implements IEnumerable so that it can be used
// with ForEach syntax.
public class People : IEnumerable
{
    private Person[] _people;
    public People(Person[] pArray)
    {
        _people = new Person[pArray.Length];

        for (int i = 0; i < pArray.Length; i++)
        {
            _people[i] = pArray[i];
        }
    }

// Implementation for the GetEnumerator method.
    IEnumerator IEnumerable.GetEnumerator()
    {
       return (IEnumerator) GetEnumerator();
    }

    public PeopleEnum GetEnumerator()
    {
        return new PeopleEnum(_people);
    }
}

// When you implement IEnumerable, you must also implement IEnumerator.
public class PeopleEnum : IEnumerator
{
    public Person[] _people;

    // Enumerators are positioned before the first element
    // until the first MoveNext() call.
    int position = -1;

    public PeopleEnum(Person[] list)
    {
        _people = list;
    }

    public bool MoveNext()
    {
        position++;
        return (position < _people.Length);
    }

    public void Reset()
    {
        position = -1;
    }

    object IEnumerator.Current
    {
        get
        {
            return Current;
        }
    }

    public Person Current
    {
        get
        {
            try
            {
                return _people[position];
            }
            catch (IndexOutOfRangeException)
            {
                throw new InvalidOperationException();
            }
        }
    }
}

class App
{
    static void Main()
    {
        Person[] peopleArray = new Person[3]
        {
            new Person("John", "Smith"),
            new Person("Jim", "Johnson"),
            new Person("Sue", "Rabon"),
        };

        People peopleList = new People(peopleArray);
        foreach (Person p in peopleList)
            Console.WriteLine(p.firstName + " " + p.lastName);

    }
}

/* This code produces output similar to the following:
 *
 * John Smith
 * Jim Johnson
 * Sue Rabon
 *
 */

在有了yield這個關鍵字以後，我們可以通過這樣的方式來創建枚舉器：

using System;
using System.Collections;

// Simple business object.
public class Person
{
    public Person(string fName, string lName)
    {
        this.firstName = fName;
        this.lastName = lName;
    }

    public string firstName;
    public string lastName;
}

// Collection of Person objects. This class
// implements IEnumerable so that it can be used
// with ForEach syntax.
public class People : IEnumerable
{
    private Person[] _people;

    public People(Person[] pArray)
    {
        _people = new Person[pArray.Length];

        for (int i = 0; i < pArray.Length; i++)
        {
            _people[i] = pArray[i];
        }
    }

    // Implementation for the GetEnumerator method.
    IEnumerator IEnumerable.GetEnumerator()
    {
        for (int i = 0; i < _people.Length; i++)
        {
            yield return _people[i];
        }
    }

}


class App
{
    static void Main()
    {
        Person[] peopleArray = new Person[3]
        {
            new Person("John", "Smith"),
            new Person("Jim", "Johnson"),
            new Person("Sue", "Rabon"),
        };

        People peopleList = new People(peopleArray);
        foreach (Person p in peopleList)
            Console.WriteLine(p.firstName + " " + p.lastName);
    }
}