C# 9.0新特性詳解系列之二：擴展方法GetEnumerator支持foreach循環

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循環，為特殊的需要提供了一種可能。

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