时间戳

首页 > 解决方案 > 仅实现单个枚举的最佳方式 Moq IEnumerable

c# - 仅实现单个枚举的最佳方式 Moq IEnumerable

问题描述

在重构项目时，我遇到了一个问题，即IEnumerable<T>方法的使用者假设返回的枚举可以被枚举多次。这不再正确，应用程序抛出NotSupportedException：“此 IEnumerable 仅支持单个枚举。 ”）。有许多单元测试（使用 XUnit 和 Moq），但他们没有抓住这一点，因为它们将List<T>用作 IEnumerable 实现。现在我想让单元测试暴露这个错误。

我想出了以下实现，它似乎按我想要的方式工作。

我的问题：

  1. 一般来说，有没有更简单的方法（c#，不管起订量）？
  2. 有没有一些更简单的内置方法可以专门在 Moq 中执行此操作？
public class DataTransferObject
{
    public string Title { get; set; }
}

public interface IDemoClient
{
    IEnumerable<DataTransferObject> GetData();
}

public class OnceEnumerator<T> : IEnumerator<T>
{
    private IList<T> _data;
    private int position = -1;

    internal OnceEnumerator(IList<T> data)
    {
        _data = data;
    }

    public T Current => _data[position];

    object IEnumerator.Current => _data[position];

    public void Dispose()
    {
    }

    public bool MoveNext()
    {
        position++;
        return (position < _data.Count);
    }

    public void Reset()
    {
        throw new NotSupportedException("Reset(): Only a single enumeration is supported by this IEnumerable.");
    }
}

public class OnceEnumerable<T> : IEnumerable<T>
{
    private OnceEnumerator<T> _enum;
    private bool _enumReturned = false;

    public OnceEnumerable(IList<T> data)
    {
        _enum = new OnceEnumerator<T>(data);
    }

    public IEnumerator<T> GetEnumerator()
    {
        if (_enumReturned)
        {
            throw new NotSupportedException("GetEnumerator(): Only a single enumeration is supported by this IEnumerable.");
        }
        else
        {
            _enumReturned = true;
            return _enum;
        }
    }

    IEnumerator IEnumerable.GetEnumerator()
    {
        return (IEnumerator)GetEnumerator();
    }
}

public class UnitTest1
{
    [Fact]
    public void Test1()
    {
        var client = new Mock<IDemoClient>();
        client.Setup(c => c.GetData()).Returns(new OnceEnumerable<DataTransferObject>(
            new List<DataTransferObject> {
                new DataTransferObject { Title = "foo" },
                new DataTransferObject { Title = "bar" }
            }));

        var data = client.Object.GetData();

        // enumerate once...
        if (data.Any(x => x.Title == "biff"))
        {
            Console.WriteLine("found biff");
        }

        // I get the behaviour I want:
        // System.NotSupportedException : GetEnumerator(): Only a single enumeration is supported by this IEnumerable.
        if (data.Any(x => x.Title == "boff"))
        {
            Console.WriteLine("found boff");
        }
    }
}

标签： c#unit-testingmoqienumerable

解决方案

没有内置这样的功能。但是，如果您使用自动生成的迭代器不支持该IEnumerator.Reset方法的事实，则可以简化您的代码：

public class OnceEnumerable<T> : IEnumerable<T>
{
    private readonly IEnumerable<T> source;
    private bool isEnumeratorRequested;

    public OnceEnumerable(IEnumerable<T> source)
    {
        this.source = source;
    }

    public IEnumerator<T> GetEnumerator()
    {
        if (isEnumeratorRequested)
            throw new NotSupportedException();

        isEnumeratorRequested = true;
        return EnumerateSource().GetEnumerator();

        IEnumerable<T> EnumerateSource() // You cannot reset this
        {
            foreach (var item in source)
                yield return item;
        }
    }
    IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
}

我还将创建一个扩展方法来轻松地将任何可枚举转换为一次可枚举：

public static IEnumerable<T> AsOnceEnumerable<T>(this IEnumerable<T> source) =>
     new OnceEnumerable<T>(source);

用法：

dtos.AsOnceEnumerable()

推荐阅读