foreach原理分析

　　我們知道通常foreach可以實現對類型的遍歷，但是foreach並不是針對所有類型都可以實現遍歷的功能，那么我們可以思考這樣的一個問題：foreach對類型實施遍歷的依據條件是什么？它是通過什么方式來實現遍歷的？

　　下面我們自定義一個類型來嘗試使用foreach進行遍歷，看會發生什么樣的現象，並且以此作為出發點來一點點分析foreach的原理。

1.自定義類型並使用foreach遍歷

 運行VS后編譯器提示了錯誤，根據錯誤描述可以推斷出foreach需要調用Person類型中的”GetEnumerator”方法。

 

2.在自定義類型中添加”GetEnumerator”方法

下一步我們根據編譯器的要求在Person類型中添加”GetEnumerator”方法，添加該方法后又出現如下的錯誤提示：

 根據編譯器的錯誤提示，可以推斷出Person類的GetEnumerator方法的返回值類型必須要有MoveNext方法和Current屬性，示例中的object類型並沒有MoveNext方法和Current屬性。

 

3.添加MoveNext方法和Current屬性

　　編譯器的錯誤提示要有MoveNext方法和Current屬性，但是我們無法搞清楚這兩個東西的具體實現形式，比如說MoveNext方法的返回值是什么樣的？Current屬性是只讀還是可讀可寫的？

　　此時我們可以去已經支持foreach的類型中查找GetEnumerator方法返回值類型，並對該類型的實現進行仿寫並用於我們自定義類型當中。string類型作為常用類型並支持foreach遍歷，下面我們查看該string的GetEnumerator方法返回值類型進行仿寫。

仿寫后編譯通過：

---

 以“數數”的思想來真正實現foreach遍歷的功能

　　在生活中小朋友們往往通過數數的形式來完成對數學的啟蒙，foreach遍歷的思想就類似於“數數”。小朋友數數往往需要通過雙手來對事物進行數數，這就相當於GetEnumerator方法：其作用實際上是需要foreach當前遍歷的類型調用該方法提供一個用於遍歷當前的類型的“迭代計數器對象”，GetEnumerator方法的返回值類型：該類型其實就是用於foreach遍歷當前類型的“迭代計數器對象”，類似於計數的雙手(工具)；Current屬性：就相當於當前數到的對象(foreach遍歷到的當前元素);MoveNext方法：就相當於“數數”中對元素不斷的移動的動作，促使讓“迭代計數器對象”的計數移至到下一位。

　　到目前為止已經提供了編譯器錯誤提示的所有成員，但實際運行是毫無意義的，因為通常編程中實現遍歷的對象都是一個序列，但是目前示例中Person類型並不是且成員未包含序列。我們將為示例中Person類型添加一個序列，作為foreach“遍歷的對象”。

---

 實現“數數的功能”

1.遍歷的數據對象

　　添加foreach“遍歷的數據對象”后又有問題來了，foreach如何訪問到這個數據呢。我們可以將數據作為“迭代計數器對象”構造函數的參數在GetEnumerator方法中傳遞過去，然后“迭代計數器對象”中提供一個字段進行存儲。

 

2.設置foreach遍歷到的當前元素(Current屬性)

　　目前我們遍歷的“對象”是一個string數組，所以要讀取這個數組里的元素，我們需要一個下標索引來讀取遍歷到的當前元素，並作為Current屬性值。下面我們將設置一個int類型值為-1的字段作為“讀取下標”，然后在Current屬性的get方法中通過下標索引器讀取“當前遍歷到的數據對象”。

 

3.MoveNext方法

　　因為我們是通過下標去訪問元素的，所以需要對下標進行遞增進行變化，從而不斷指向下一個元素從而到達累計。MoveNext方法是一個布爾的返回值類型，其主要目的是告知foreach當前遍歷的數據對象是否還存在沒有遍歷到的元素，如果存在元素則不斷遞增下標索引並反會true，反之返回false並結束遍歷，MoveNext方法的返回值相當於foreach遍歷的前提條件。

　　下面我們通過代碼來實現MoveNext方法：

 

到目前為止我們已經將一個不具備foreach條件的自定義類型，通過自編碼實現了foreach的基本要求。下面我們通過代碼運行看看執行結果：

結果運行成功，並打印輸出遍歷的數據對象(Person中的數組)。

注意：遍歷該數組我們並沒有通過foreach直接對其進行的遍歷，而是結合foreach的流程本質和基本要求來實現的遍歷功能。

---

 通過調試來分析foreach的遍歷的原理

 通過調試結果我們可以總結下foreach遍歷主要依靠三個流程：

1. foreach調用當前遍歷類型的GetEnumerator方法創建一個“迭代計數器對象”，並將遍歷的數據作為參數傳遞到對象構造函數中。（獲取迭代計數器對象）
2. “迭代計數器對象”調用MoveNext方法將索引下標遞增(第一次遞增為0)，如果遞增下標大於數組長度則代表已經遍歷完。（調用MoveNext方法）
3. MoveNext方法返回true，代表還有元素需要遍歷，使用當前下標在數據中獲取元素並設置為Current屬性值。（獲取Current屬性）

 基於foreach的原理思想，我們還可以將遍歷寫成如下形式：

foreach的寫法其實就是調用上面的代碼片段，從而實現的一種“語法糖”。

---

C#中基於原理的實現方式

　　在上文中我們借鑒string類型中的GetEnumerator方法來參照實現“迭代計數器對象”當中的MoveNext方法和Current屬性。

 

　　在.net中看某個類型是否支持使用foreach進行遍歷，其實接可以看該類型和該類型的“迭代計數器”是否都實現了IEnumerable接口。IEnumerable接口中的成員就包含了foreach實現的原理和需要調用的成員。

圖一：

 圖二：

 

---

 

示例源碼

  class Program
    {
        static void Main(string[] args)
        {
          
            Person person = new Person();
            foreach (var item in person)
            {
                Console.WriteLine(item);
            }

            var Enumerator = person.GetEnumerator();
            while (Enumerator.MoveNext())
            {
                Console.WriteLine(Enumerator.Current);
            }

        }  // END Main（）

    }

 

   class Person
    {
        string[] Datas = new string[] { "張三","李四","王五"};

        public PersonEnumerator GetEnumerator()
        {
            return new PersonEnumerator(Datas);
        }
    }

    /// <summary>
    /// 迭代計數器
    /// </summary>
    class PersonEnumerator
    {
        public PersonEnumerator(string[] datas) { this.Datas = datas; }

        /// <summary>
        /// 遍歷的數據對象
        /// </summary>
        private string[] Datas;

        private int index = -1;

        /// <summary>
        /// 當前遍歷到的元素
        /// </summary>
        public string Current {
            get { return Datas[index]; }
        }

        /// <summary>
        /// 將記錄指針移至下一條
        /// </summary>
        /// <returns>是否存在尚未遍歷的元素</returns>
        public bool MoveNext()
        {
            index++;
            return index < Datas.Length;
        }

    }