返回一个空的 IEnumerator

Question

我有一个接口，除其他外，它实现了“public IEnumerator GetEnumerator()”方法，因此我可以在 foreach 语句中使用该接口。

我在几个类中实现了这个接口，在其中一个类中，我想返回一个空的 IEnumerator。现在我按以下方式执行此操作：

public IEnumerator GetEnumerator()
{
    ArrayList arr = new ArrayList();
    return arr.GetEnumerator();
}

但是我认为这是一个丑陋的黑客，并且我忍不住认为有更好的方法来返回空的 IEnumerator。有没有？

Answer 1

这在 C# 2 中很简单：

public IEnumerator GetEnumerator()
{
    yield break;
}

您需要使用 yield break 语句来强制编译器将其视为迭代器块。

这将比“自定义”空迭代器效率低，但它的代码更简单......

Answer 2

框架中有一个额外的函数：

public static class Enumerable
{
    public static IEnumerable<TResult> Empty<TResult>();
}

使用它你可以编写：

var emptyEnumerable = Enumerable.Empty<int>();
var emptyEnumerator = Enumerable.Empty<int>().GetEnumerator();

Answer 3

您可以实现一个实现 IEnumerator 的虚拟类，并返回它的一个实例：

class DummyEnumerator : IEnumerator
{
    public object Current
    {
        get
        {
            throw new InvalidOperationException();
        }
    }

    public bool MoveNext()
    {
        return false;
    }

    public void Reset()
    {
    }
}

Answer 4

我很好奇，又走得更远。我做了一个测试，检查这些方法比较 yield break、Enumerable.Emtpy 和自定义类的效率。

您可以在 dotnetfiddle https://dotnetfiddle.net/p5ZkUN 上查看或使用下面的代码。

使用 190 000 次迭代进行的众多 dotnetfiddle 运行之一的结果是：

产量中断：00:00:00.0012208

Enumerable.Empty(): 00:00:00.0007815

EmptyEnumerator 实例：00:00:00.0010226

using System;
using System.Diagnostics;
using System.Collections;
using System.Linq;
                    
public class Program
{
    private const int Iterations = 190000;
    public static void Main()
    {
        var sw = new Stopwatch();
        
        IEnumerator enumerator1 = YieldBreak();
        sw.Start();
        for (int i = 0; i < Iterations; i++)
        {
            while(enumerator1.MoveNext())
            {
                throw new InvalidOperationException("Should not occur");
            }           
        }
        sw.Stop();
        
        Console.WriteLine("Yield break: {0}", sw.Elapsed);
        
        GC.Collect();
        
        IEnumerator enumerator2 = Enumerable.Empty<object>().GetEnumerator();
        sw.Restart();
        for (int i = 0; i < Iterations; i++)
        {
            while(enumerator2.MoveNext())
            {
                throw new InvalidOperationException("Should not occur");
            }           
        }
        sw.Stop();
        
        Console.WriteLine("Enumerable.Empty<T>(): {0}", sw.Elapsed);
        
        GC.Collect();
        
        var enumerator3 = new EmptyEnumerator();
        sw.Restart();
        for (int i = 0; i < Iterations; i++)
        {
            while(enumerator3.MoveNext())
            {
                throw new InvalidOperationException("Should not occur");
            }           
        }
        sw.Stop();
        
        Console.WriteLine("EmptyEnumerator instance: {0}", sw.Elapsed);
    }
    
    public static IEnumerator YieldBreak()
    {
        yield break;
    }
    
    private class EmptyEnumerator : IEnumerator
    {
        //public static readonly EmptyEnumerator Instance = new EmptyEnumerator();
        
        public bool MoveNext()
        {
            return false;
        }
        
        public void Reset()
        {
        }
        
        public object Current { get { return null; } }
    }
}

Answer 5

我使用的方式是使用空数组的枚举器：

public IEnumerator GetEnumerator() {
    return new object[0].GetEnumerator();
}

它也可以用于通用 IEnumerator 或 IEnumerable （使用适当类型的数组）

Answer 6

您可以实现 IEnumerator 接口和 IEnumerable，并从 IEnumerable 接口的 MoveNext 函数返回 false

private class EmptyEnumerator : IEnumerator
{


    public EmptyEnumerator()
    {
    }

    #region IEnumerator Members

    public void Reset() { }

    public object Current
    {
        get
        {
            throw new InvalidOperationException();
        }
    }
    public bool MoveNext()
    { return false; }
}


public class EmptyEnumerable : IEnumerable
{

    public IEnumerator GetEnumerator()
    {
        return new EmptyEnumerator();
    }
}

Answer 7

我是这样写的：

public IEnumerator<T> GetEnumerator()
{
    return this.source?.GetEnumerator() ??
            Enumerable.Empty<T>().GetEnumerator();
}

Answer 8

您可以创建一个实现 IEnumerator 接口的 NullEnumerator。您可以仅从 NullEnumerator 传递一个实例。

这里是一个 EmptyEnumerator 的示例

Answer 9

发现这个问题正在寻找获取空枚举器的最简单方法。在看到比较性能的答案后，我决定使用空枚举器类解决方案，但我的解决方案比其他示例更紧凑，并且是通用类型，并且还提供了默认实例，因此您不必在所有情况下创建新实例时间，这应该会进一步提高性能。

class EmptyEnumerator<T> : IEnumerator<T>
{
   public readonly static EmptyEnumerator<T> value = new EmptyEnumerator<T>();
   public T Current => throw new InvalidOperationException();
   object IEnumerator.Current => throw new InvalidOperationException();
   public void Dispose() { }
   public bool MoveNext() => false;
   public void Reset() { }
}