詳解C#迭代器

Minotauros發表於2019-02-26
C#

　　一、迭代器（Iterator）通過持有迭代狀態可以獲取當前迭代元素並且識別下一個需要迭代的元素，從而可以遍歷集合中每一個元素而不用瞭解集合的具體實現方式；

　　實現迭代器功能的方法被稱為迭代器方法，迭代器方法的返回值型別可以是以下4種介面型別中任意一種：位於名稱空間System.Collections中的IEnumerable、IEnumerator和位於名稱空間System.Collections.Generic中的IEnumerable<T>、IEnumerator<T>，其中介面IEnumerable和IEnumerator程式碼：

public interface IEnumerable
{
    IEnumerator GetEnumerator();
}
public interface IEnumerator
{
    object Current { get; }

    bool MoveNext();
    void Reset();
}

　　※對應泛型介面IEnumerable<T>和IEnumerator<T>程式碼：

public interface IEnumerable<out T> : IEnumerable
{
    IEnumerator<T> GetEnumerator();
}
public interface IEnumerator<out T> : IDisposable, IEnumerator
{
    T Current { get; }
}

　　※介面IEnumerable中宣告瞭獲取IEnumerator型別物件的方法GetEnumerator()，介面IEnumerator中通過屬性Current和方法MoveNext()實現迭代器功能；自定義型別可以通過繼承介面IEnumerable擁有迭代器功能，而介面IEnumerator為迭代器功能提供具體實現，設計二者符合單一職責原則，也因此可以對同一個物件同時進行多次迭代；

　　※get訪問器也可以宣告為迭代器方法，但事件、建構函式和解構函式不可以宣告為迭代器方法；迭代器方法不能包含引用引數；

　　二、迭代器方法的內部使用狀態機實現，但可以使用yield關鍵字快速實現迭代器方法，使用yield return語句新增需要迭代的元素，在首次迭代時，會一直執行到第一個yield return語句並儲存當前迭代狀態，在接下來的每次迭代過程中都會從暫停的位置繼續執行到下一個yield return語句並儲存迭代狀態（MoveNext()方法返回true並將當前迭代的值賦值給Current），直到到達迭代器的結尾（MoveNext()方法返回false）完成本次迭代；也可以在迭代過程中使用yield break語句立刻結束本次迭代：

IEnumerable<int> MyIterator()
{
    yield return 10;
    yield return 20;
}

　　※其中yield return語句的返回值需要可以隱式轉換為迭代器方法返回值IEnumerable<T>中型別引數的型別；

　　※這是編譯器為我們準備的一種語法糖，編譯器會將其轉換為使用狀態機實現的實現了介面IEnumerable<T>的巢狀類，檢視迭代器方法的IL程式碼，可以看到編譯器生成的狀態機巢狀類：

　　三、對於實現了介面IEnumerable或IEnumerable<T>的型別的物件，可以使用foreach對其進行遍歷：

foreach (int item in MyIterator())
{
    //do…其中item為int型別，值分別為10和20
}

　　※其中item實際上是型別中GetEnumerator()方法返回值型別中的Current屬性，因此其型別即該屬性的型別，通常可以使用var表示，由編譯器進行推斷，例如對雜湊表進行遍歷時：

foreach (var item in myHashTable)
{
    //do…其中item為DictionaryEntry型別，item.Key and item.Value
}

　　※由於屬性Current只有get訪問器，因此不能在foreach迴圈中對item進行賦值（=運算子操作）操作，但可以對其物件中的成員進行修改和呼叫，詳見；

　　※在遍歷內建集合的物件時，如果集合長度發生改變，則極有可能紊亂迭代過程，因此在迭代這些集合物件時不能進行任何修改集合長度的操作，否則會丟擲異常InvalidOperationException；

　　四、除使用foreach外，還可以手動進行迭代，對於實現了泛型介面的型別的物件在手動迭代時還需要使用using語句以在其迭代完成後呼叫Dispose()方法：

using (IEnumerator<int> enumerator = MyIterator().GetEnumerator())

{
    //此時myEnmerator.Current為其型別的預設值
    while (enumerator.MoveNext())
    {
        //do…其中可以通過enumerator.Current訪問迭代器的值
    }
}

　　1.對於只實現了介面IEnumerator或IEnumerator<T>的型別的物件，只能手動進行迭代：

IEnumerator<int> MyIterator()
{
    yield return 1;
    yield return 2;
}
using (IEnumerator<int> enumerator = MyIterator())
{
    while (enumerator.MoveNext())
    {
        //do…
    }
}

　　2.可以通過實現介面IEnumerable或IEnumerable<T>來自定義迭代器型別，此時不必手動實現IEnumerator或IEnumerator<T>介面，編譯器會自動實現該介面中的Current屬性、MoveNext()、Reset()和Dispose()方法：

public class MyIterator : IEnumerable<int>
{
    public IEnumerator<int> GetEnumerator()
    {
        yield return 10;
        yield return 20;
    }

    IEnumerator IEnumerable.GetEnumerator()
    {
        Console.WriteLine("Non-Generic GetEnumerator");
        return GetEnumerator(); //注意這裡不是yield return
        //或者手動進行迭代：
        //using (IEnumerator<int> iterator = this.GetEnumerator())
        //{
        //while (iterator.MoveNext())
        //{
        //yield return iterator.Current;
        //}
        //}
    }
}

　　※此時，在使用foreach遍歷時，如果使用var，會由編譯器自動推斷item為int型別，並呼叫泛型介面的實現，如果將item的型別指定為object型別，則依然會呼叫泛型介面的實現，但會產生裝箱操作：

foreach (var item in new MyIterator()) //或顯式指定為int：int item
{
    Console.WriteLine(item); //10 20
}

　　※此時，在使用foreach遍歷時，如果將其轉換為IEnumerable型別的物件，則會呼叫非泛型介面的實現，編譯器將自動推斷item為object型別，併產生裝箱操作：

foreach (var item in (IEnumerable)new MyIterator()) //或顯式指定為object：object item
{
    Console.WriteLine(item); //Non-Generic GetEnumerator 10 20
}

　　3.直接呼叫迭代器方法或迭代器型別中自動生成的Reset()方法時會丟擲異常NotSupportedException，若要從頭開始重新迭代，必須獲取新的迭代器，或在迭代器型別中手動實現Reset()方法；

 

如果您覺得閱讀本文對您有幫助，請點一下“推薦”按鈕，您的認可是我寫作的最大動力！

作者：Minotauros
出處：https://www.cnblogs.com/minotauros/

本文版權歸作者和部落格園共有，歡迎轉載，但未經作者同意必須保留此段宣告，且在文章頁面明顯位置給出原文連線，否則保留追究法律責任的權利。

相關文章