C# 9.0新特性詳解系列之二：擴充套件方法GetEnumerator支援foreach迴圈

markkang發表於2020-11-22
C#套件

1.介紹

我們知道，我們要使一個型別支援foreach迴圈，就需要這個型別滿足下面條件之一：

  • 該型別例項如果實現了下列介面中的其中之一：

    • System.Collections.IEnumerable
    • System.Collections.Generic.IEnumerable<T>
    • System.Collections.Generic.IAsyncEnumerable<T>

  • 該型別中有公開的無參GetEnumerator()方法，且其返回值型別必須是類，結構或者介面，同時返回值型別具有公共 Current 屬性和公共無引數且返回型別為 Boolean的MoveNext 方法。

上面的第一個條件，歸根結底還是第二個條件的要求，因為這幾個介面，裡面要求實現的還是GetEnumerator方法，同時，介面中GetEnumerator的返回值型別IEnumerator介面中要實現的成員和第二條中返回值型別的成員相同。

C#9.0之前，是不支援採取擴充套件方法的方式給型別注入GetEnumerator方法，以支援foreach迴圈的。從C#9.0之後，這種情況得到了支援。

2. 應用與示例

在這裡，我們定義一個People類，它可以列舉其所有組員Person，並且在其中定義了MoveNext方法和Current屬性。同時，我們也通過擴充套件方法給People注入了GetEnumerator方法。這樣，我們就可以使用foreach來列舉People物件了。

首先，我們來定義一個Person記錄:

public record Person(string FirstName, string LastName);

下來，我們來建立People型別,用來描述多個Person物件，並提供GetEnumerator返回值型別中所需的Current屬性和MoveNext方法。在此，我們沒有實現任何介面:

public class People：IDisposable//: IEnumerator<Person>
{
    int position = -1;

    private Person[] _people { get; init; }
    public People(Person[] people)
    {
        _people = people;
    }

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

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

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

    public void Dispose()
    {
        Reset();
    }
}

需要注意的是People中，由於沒有通過使用前面的介面來實現支援foreach功能，這樣就存在一個問題，就是第一次foreach迴圈完成後，狀態還沒有恢復到初始狀態，第二次使用foreach進行列舉就沒有可用項。因此我們新增了Reset方法用於手工恢復回初始狀態，如果想讓foreach能自動恢復狀態，就讓People實現介面IDisposable，並在其實現中，呼叫Reset方法。

然後，我們定義擴充套件方法，給People注入GetEnumerator方法

static class PeopleExtensions
{
    //public static IEnumerator<T> GetEnumerator<T>(this IEnumerator<T> people) => people;
    public static People GetEnumerator(this People people) => people;
}

最後，只要引用了擴充套件方法所在的名稱空間，foreach迴圈就可以使用了。

var PersonList = new Person[3]
{
    new ("John", "Smith"),
    new ("Jim", "Johnson"),
    new ("Sue", "Rabon"),
};

var people = new People(PersonList);
foreach (var person in people)
{
    Console.WriteLine(person);
}

到這裡，我們就完成了利用擴充套件方法來實現foreach迴圈的示例，為了方便拷貝測試，我們所有的程式碼放在一起就如下所示：

var PersonList = new Person[3]
{
    new ("John", "Smith"),
    new ("Jim", "Johnson"),
    new ("Sue", "Rabon"),
};

var people = new People(PersonList);
foreach (var person in people)
{
    Console.WriteLine(person);
}

public record Person(string FirstName, string LastName);

public class People：IDisposable//: IEnumerator<Person>
{
    int position = -1;

    private Person[] _people { get; init; }
    public People(Person[] people)
    {
        _people = people;
    }

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

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

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

    public void Dispose()
    {
        Reset();
    }
}

static class PeopleExtensions
{
    //public static IEnumerator<T> GetEnumerator<T>(this IEnumerator<T> people) => people;
    public static People GetEnumerator(this People people) => people;
}

結束語

解除原有的限制，擴充套件方法GetEnumerator支援foreach迴圈，為特殊的需要提供了一種可能。

如對您有價值，請推薦，您的鼓勵是我繼續的動力，在此萬分感謝。關注本人公眾號“碼客風雲”，享第一時間閱讀最新文章。

碼客風雲

相關文章