可与 foreach 语句一起使用的集合类

foreach 语句是循环访问数组元素的方便方法。如果集合类已实现 System.Collections.IEnumerator 和 System.Collections.IEnumerable 接口，它还可以枚举该集合的元素。

 1//版权所有 (C) 2000 Microsoft Corporation。保留所有权利。
 2
 3// tokens.cs
 4using System;
 5// System.Collections 命名空间已经可用:
 6using System.Collections;
 7
 8// 声明 Tokens 类:
 9public class Tokens : IEnumerable
10{
11   private string[] elements;
12
13   Tokens(string source, char[] delimiters)
14   {
15      // 将字符串分析为标记:
16      elements = source.Split(delimiters);
17   }
18
19   // IEnumerable 接口实现: 
20   //  IEnumerable 所需的
21   //    GetEnumerator() 方法的声明
22   public IEnumerator GetEnumerator()
23   {
24      return new TokenEnumerator(this);
25   }
26
27   // 内部类实现 IEnumerator 接口:
28   private class TokenEnumerator : IEnumerator
29   {
30      private int position = -1;
31      private Tokens t;
32
33      public TokenEnumerator(Tokens t)
34      {
35         this.t = t;
36      }
37
38      // 声明 IEnumerator 所需的 MoveNext 方法:
39      public bool MoveNext()
40      {
41         if (position < t.elements.Length - 1)
42         {
43            position++;
44            return true;
45         }
46         else
47         {
48            return false;
49         }
50      }
51
52      // 声明 IEnumerator 所需的 Reset 方法:
53      public void Reset()
54      {
55         position = -1;
56      }
57
58      // 声明 IEnumerator 所需的 Current 属性:
59      public object Current
60      {
61         get
62         {
63            return t.elements[position];
64         }
65      }
66   }
67
68   // 测试标记，TokenEnumerator
69
70   static void Main()
71   {
72      // 通过将字符串分解为标记来测试标记:
73      Tokens f = new Tokens("This is a well-done program.", 
74         new char[] {' ','-'});
75      foreach (string item in f)
76      {
77         Console.WriteLine(item);
78      }
79   }
80}
81

输出

This
is
a
well
done
program.

代码讨论

在前面的示例中，下列代码用于 Tokens 化，方法是将“This is a well-done program.”拆分为标记（使用“”和“-”作为分隔符），并用 foreach 语句枚举这些标记：

Tokens f = new Tokens("This is a well-done program.", 
   new char[] {' ','-'});
foreach (string item in f)
{
   Console.WriteLine(item);
}

请注意，Tokens 在内部使用一个数组，自行实现 IEnumerator 和 IEnumerable。该代码示例本可以利用数组本身的枚举方法，但那会使本示例的目的失效。

在 C# 中，集合类并非必须严格从 IEnumerable 和 IEnumerator 继承才能与 foreach 兼容；只要类有所需的 GetEnumerator、MoveNext、Reset 和 Current 成员，便可以与 foreach 一起使用。省略接口的好处为，使您可以将 Current 的返回类型定义得比 object 更明确，从而提供了类型安全。

例如，从上面的示例代码开始，更改以下几行：

public class Tokens  // no longer inherits from IEnumerable
public TokenEnumerator GetEnumerator()  // doesn't return an IEnumerator
public class TokenEnumerator  // no longer inherits from IEnumerator
public string Current  // type-safe: returns string, not object

现在，由于 Current 返回字符串，当 foreach 语句中使用了不兼容的类型时，编译器便能够检测到：

foreach (int item in f)  // Error: cannot convert string to int

省略 IEnumerable 和 IEnumerator 的缺点是，集合类不再能够与其他公共语言运行库兼容的语言的 foreach 语句（或等效项）交互操作。

您可以同时拥有二者的优点（C# 内的类型安全以及与兼容其他公共语言运行库的语言的互操作性），方法是从 IEnumerable 和 IEnumerator 继承，并使用显式接口实现.