C# 9.0新特性——擴(kuò)展方法GetEnumerator支持foreach循環(huán)

更新時(shí)間：2020年11月23日 17:10:18 作者：markkang

這篇文章主要介紹了C# 9.0新特性——擴(kuò)展方法GetEnumerator支持foreach循環(huán)的相關(guān)資料,幫助大家更好的理解和學(xué)習(xí)c# 9.0，感興趣的朋友可以了解下

1.介紹

我們知道，我們要使一個(gè)類型支持foreach循環(huán)，就需要這個(gè)類型滿足下面條件之一：

該類型實(shí)例如果實(shí)現(xiàn)了下列接口中的其中之一：

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

該類型中有公開的無參GetEnumerator()方法，且其返回值類型必須是類，結(jié)構(gòu)或者接口，同時(shí)返回值類型具有公共 Current 屬性和公共無參數(shù)且返回類型為 Boolean的MoveNext 方法。

上面的第一個(gè)條件，歸根結(jié)底還是第二個(gè)條件的要求，因?yàn)檫@幾個(gè)接口，里面要求實(shí)現(xiàn)的還是GetEnumerator方法，同時(shí)，接口中GetEnumerator的返回值類型IEnumerator接口中要實(shí)現(xiàn)的成員和第二條中返回值類型的成員相同。

C#9.0之前，是不支持采取擴(kuò)展方法的方式給類型注入GetEnumerator方法，以支持foreach循環(huán)的。從C#9.0之后，這種情況得到了支持。

2. 應(yīng)用與示例

在這里，我們定義一個(gè)People類，它可以枚舉其所有組員Person，并且在其中定義了MoveNext方法和Current屬性。同時(shí)，我們也通過擴(kuò)展方法給People注入了GetEnumerator方法。這樣，我們就可以使用foreach來枚舉People對象了。

首先，我們來定義一個(gè)Person記錄:

public record Person(string FirstName, string LastName);

下來，我們來創(chuàng)建People類型,用來描述多個(gè)Person對象，并提供GetEnumerator返回值類型中所需的Current屬性和MoveNext方法。在此，我們沒有實(shí)現(xiàn)任何接口:

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中，由于沒有通過使用前面的接口來實(shí)現(xiàn)支持foreach功能，這樣就存在一個(gè)問題，就是第一次foreach循環(huán)完成后，狀態(tài)還沒有恢復(fù)到初始狀態(tài)，第二次使用foreach進(jìn)行枚舉就沒有可用項(xiàng)。因此我們添加了Reset方法用于手工恢復(fù)回初始狀態(tài)，如果想讓foreach能自動(dòng)恢復(fù)狀態(tài)，就讓People實(shí)現(xiàn)接口IDisposable，并在其實(shí)現(xiàn)中，調(diào)用Reset方法。

然后，我們定義擴(kuò)展方法，給People注入GetEnumerator方法

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

最后，只要引用了擴(kuò)展方法所在的命名空間，foreach循環(huán)就可以使用了。

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);
}

到這里，我們就完成了利用擴(kuò)展方法來實(shí)現(xiàn)foreach循環(huán)的示例，為了方便拷貝測試，我們所有的代碼放在一起就如下所示：

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;
}

結(jié)束語

解除原有的限制，擴(kuò)展方法GetEnumerator支持foreach循環(huán)，為特殊的需要提供了一種可能。