.net 集合分成幾個等數量集合_[C#.NET 拾遺補漏]07：疊代器和列舉器

大家好，這是 [C#.NET 拾遺補漏] 系列的第 07 篇文章。

在 C# 中，大多數方法都是通過 return 語句立即把程式的控制權交回給調用者，同時也會把方法内的本地資源釋放掉。而包含 yield 語句的方法則允許在依次傳回多個值給調用者的期間保留本地資源，等所有值都傳回結束時再釋放掉本來資源，這些傳回的值形成一組序列被調用者使用。在 C# 中，這種包含 yield 語句的方法、屬性或索引器就是疊代器。

疊代器中的 yield 語句分為兩種：

• yeild return

  ，把程式控制權交回調用者并保留本地狀态，調用者拿到傳回的值繼續往後執行。

• yeild break

  ，用于告訴程式目前序列已經結束，相當于正常代碼塊的 return 語句（疊代器中直接使用 return 是非法的）。

下面是一個用來生成斐波納契序列的疊代器示例：

IEnumerable<int> Fibonacci(int count)
{
  int prev = 1;
  int curr = 1;
  for (int i = 0; i < count; i++)
  {
    yield return prev;
    int temp = prev + curr;
    prev = curr;
    curr = temp;
  }
}

void Main()
{
  foreach (int term in Fibonacci(10))
  {
    Console.WriteLine(term);
  }
}
           

輸出：

1
1
2
3
5
8
13
21
34
55
           

實際場景中，我們一般很少直接寫疊代器，因為大部分需要疊代的場景都是數組、集合和清單，而這些類型内部已經封裝好了所需的疊代器。比如 C# 中的數組之是以可以被周遊是因為它實作了

IEnumerable

接口，通過

GetEnumerator()

方法可以獲得數組的

列舉器 Enumerator

，而該列舉器就是通過疊代器來實作的。比如最常見的一種使用場景就是周遊數組中的每一個元素，如下面逐個列印數組元素的示例。

int[] numbers = { 1, 2, 3, 4, 5 };
IEnumerator enumerator = numbers.GetEnumerator();
while (enumerator.MoveNext())
{
  Console.WriteLine(enumerator.Current);
}
           

其實這就是 foreach 的工作原理，上面代碼可以用 foreach 改寫如下：

int[] numbers = { 1, 2, 3, 4, 5 };
foreach (int number in numbers)
{
  Console.WriteLine(number);
}
           

當然，列舉器不一定非要通過疊代器實作，例如下面這個自定義的列舉器 CoffeeEnumerator。

public class CoffeeCollection : IEnumerable
{
  private CoffeeEnumerator enumerator;
  public CoffeeCollection()
  {
    enumerator = new CoffeeEnumerator();
  }

  public IEnumerator GetEnumerator()
  {
    return enumerator;
  }

  public class CoffeeEnumerator : IEnumerator
  {
    string[] items = new string[3] { "espresso", "macchiato", "latte" };
    int currentIndex = -1;
    public object Current
    {
      get
      {
        return items[currentIndex];
      }
    }
    public bool MoveNext()
    {
      currentIndex++;
      if (currentIndex < items.Length)
      {
        return true;
      }
      return false;
    }
    public void Reset()
    {
      currentIndex = 0;
    }
  }
}
           

使用：

public static void Main(string[] args)
{
  foreach (var coffee in new CoffeeCollection())
  {
    Console.WriteLine(coffee);
  }
}
           

了解疊代器和列舉器可以幫助我們寫出更高效的代碼。比如判斷一個

IEnumerable<T>

對象是否包含元素，經常看到有些人這麼寫：

if(enumerable.Count() > 0)
{
  // 集合中有元素
}
           

但如果用列舉器的思維稍微思考一下就知道，

Count()

為了獲得集合元素數量必然要疊代完所有元素，時間複雜度為 O(n)。而僅僅是要知道集合中是否包含元素，其實疊代一次就可以了。是以效率更好的做法是：

if(enumerable.GetEnumerator().MoveNext())
{
  // 集合中有元素
}
           

這樣寫時間複雜度是 O(1)，效率顯然更高。為了書寫友善，C# 提供了擴充方法

Any()

。

if(enumerable.Any())
{
  // 集合中有元素
}
           

是以如有需要，應盡可能使用 Any 方法，效率更高。

再比如在 EF Core 中，需要執行

IQueryable<T>

查詢時，有時候使用

AsEnumerable()

比使用 ToList、ToArray 等更高效，因為 ToList、ToArray 等會立即執行列舉操作，而

AsEnumerable()

可以把列舉操作延遲到真正被需要的時候再執行。當然也要考慮實際應用場景，Array、List 等更友善調用者使用，特别是要擷取元素總數量、增删元素等這種操作。