更新:2007 年 11 月

下面的代码示例阐释如何编写可与 foreach 一起使用的非泛型集合类。该类是字符串标记化拆分器,类似于 C 运行时函数 strtok_s

说明:

此示例描述的是仅当您无法使用泛型集合类时才采用的推荐做法。C# 语言和 .NET Framework 的 2.0 版和更高版本支持泛型。有关如何实现支持 IEnumerable<(Of <(T>)>) 的类型安全泛型集合类并因而避免本主题中稍后讨论的问题的示例,请参见如何:为泛型列表创建迭代器块(C# 编程指南)

在下面的示例中,Tokens 使用“ ”和“-”作为分隔符将句子“This is a sample sentence.”拆分为标记,并使用 foreach 语句枚举这些标记:

C# 复制代码
Tokens f = new Tokens("This is a sample sentence.", new char[] {' ','-'});

foreach (string item in f)
{
    System.Console.WriteLine(item);
}

Tokens 在内部使用一个数组,该数组自行实现 IEnumeratorIEnumerable。该代码示例本可以利用数组本身的枚举方法,但那样会使本示例的用意无法体现出来。

在 C# 中,集合类不一定要从 IEnumerableIEnumerator 继承以便与 foreach 兼容。只要此类具有必需的 GetEnumeratorMoveNextResetCurrent 成员,就可 foreach 与一起使用。省略接口有一个好处:您可以将 Current 的返回类型定义得比 Object 更为明确,从而提供类型安全。

例如,从本主题中先前的示例代码开始,更改以下几行:

 复制代码
// No longer inherits from IEnumerable:
public class Tokens  
// Doesn't return an IEnumerator:
public TokenEnumerator GetEnumerator()  
// No longer inherits from IEnumerator:
public class TokenEnumerator  
// Type-safe: returns string, not object:
public string Current  

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

 复制代码
// Error: cannot convert string to int:
foreach (int item in f)  

省略 IEnumerableIEnumerator 的缺点是,集合类不再能够与其他公共语言运行时兼容语言的 foreach 语句或等效项交互操作。

您可以同时拥有两者的优点,即 C# 中的类型安全以及与其他公共语言运行时兼容语言的互操作性,方法是从 IEnumerableIEnumerator 继承并使用显式接口实现,如下面的示例所示。

示例

C# 复制代码
using System.Collections;

// Declare the Tokens class:
public class Tokens : IEnumerable
{
    private string[] elements;

    Tokens(string source, char[] delimiters)
    {
        // Parse the string into tokens:
        elements = source.Split(delimiters);
    }

    // IEnumerable Interface Implementation:
    //   Declaration of the GetEnumerator() method 
    //   required by IEnumerable
    public IEnumerator GetEnumerator()
    {
        return new TokenEnumerator(this);
    }


    // Inner class implements IEnumerator interface:
    private class TokenEnumerator : IEnumerator
    {
        private int position = -1;
        private Tokens t;

        public TokenEnumerator(Tokens t)
        {
            this.t = t;
        }

        // Declare the MoveNext method required by IEnumerator:
        public bool MoveNext()
        {
            if (position < t.elements.Length - 1)
            {
                position++;
                return true;
            }
            else
            {
                return false;
            }
        }

        // Declare the Reset method required by IEnumerator:
        public void Reset()
        {
            position = -1;
        }

        // Declare the Current property required by IEnumerator:
        public object Current
        {
            get
            {
                return t.elements[position];
            }
        }
    }


    // Test Tokens, TokenEnumerator
    static void Main()
    {
        // Testing Tokens by breaking the string into tokens:
        Tokens f = new Tokens("This is a sample sentence.", new char[] {' ','-'});

        foreach (string item in f)
        {
            System.Console.WriteLine(item);
        }
    }
}
/* Output:
    This
    is
    a
    sample
    sentence.  
*/

请参见