在我的代码中,我需要使用IEnumerable<>几次,导致ReSharper错误“可能的IEnumerable多重枚举”。

示例代码:

public List<object> Foo(IEnumerable<object> objects)
{
    if (objects == null || !objects.Any())
        throw new ArgumentException();
        
    var firstObject = objects.First();
    var list = DoSomeThing(firstObject);        
    var secondList = DoSomeThingElse(objects);
    list.AddRange(secondList);
    
    return list;
}

我可以将对象参数改为List,然后避免可能的多重枚举,但这样我就得不到我能处理的最高的对象。 我能做的另一件事是在方法的开头将IEnumerable转换为List:


 public List<object> Foo(IEnumerable<object> objects)
 {
    var objectList = objects.ToList();
    // ...
 }

但这太尴尬了。

在这种情况下你会怎么做?


当前回答

将IEnumerable作为参数的问题是,它告诉调用者“我希望枚举这个”。它不会告诉他们你希望列举多少次。

我可以将对象参数改为List,然后避免可能的多重枚举,但这样我就得不到我能处理的最高的对象。

夺取最高目标的目标是高尚的,但它给太多假设留下了空间。你真的希望有人将一个LINQ to SQL查询传递给这个方法,只是为了让你枚举它两次(每次可能得到不同的结果?)

这里语义缺失的是,调用者可能不会花时间阅读方法的细节,可能会假设您只迭代一次——因此他们会传递给您一个昂贵的对象。你的方法签名没有指明任何一种方法。

通过将方法签名更改为IList/ICollection,您至少可以让调用者更清楚地了解您的期望是什么,并且可以避免代价高昂的错误。

否则,大多数查看该方法的开发人员可能会认为您只迭代一次。如果获取IEnumerable是如此重要,您应该考虑在方法的开头执行. tolist()。

遗憾的是。net没有IEnumerable + Count + Indexer的接口,没有Add/Remove等方法,这是我认为可以解决这个问题的方法。

其他回答

在这种情况下,我通常用IEnumerable和IList重载我的方法。

public static IEnumerable<T> Method<T>( this IList<T> source ){... }

public static IEnumerable<T> Method<T>( this IEnumerable<T> source )
{
    /*input checks on source parameter here*/
    return Method( source.ToList() );
}

我注意在方法的摘要注释中解释了调用IEnumerable将执行. tolist()。

如果多个操作被连接在一起,程序员可以在更高的级别上选择. tolist(),然后调用IList重载或让IEnumerable重载来处理。

首先,这种警告并不总是意义重大。我通常在确定它不是性能瓶颈后禁用它。它只是意味着IEnumerable被求值两次,这通常不是问题,除非求值本身需要很长时间。即使它确实需要很长时间,在这种情况下,您第一次只使用一个元素。

在这种情况下,您还可以更多地利用强大的linq扩展方法。

var firstObject = objects.First();
return DoSomeThing(firstObject).Concat(DoSomeThingElse(objects).ToList();

在这种情况下,可能只计算IEnumerable一次,但会有一些麻烦,但先进行概要分析,看看这是否真的是个问题。

如果您的数据总是可重复的,也许就不用担心了。但是,你也可以展开它——如果传入的数据可能很大(例如,从磁盘/网络读取),这特别有用:

if(objects == null) throw new ArgumentException();
using(var iter = objects.GetEnumerator()) {
    if(!iter.MoveNext()) throw new ArgumentException();

    var firstObject = iter.Current;
    var list = DoSomeThing(firstObject);  

    while(iter.MoveNext()) {
        list.Add(DoSomeThingElse(iter.Current));
    }
    return list;
}

注意,我稍微改变了DoSomethingElse的语义,但这主要是为了显示展开的用法。例如,您可以重新包装迭代器。你也可以把它变成一个迭代器块,这样很好;然后就没有列表了——你会在得到它们的时候就返回它们,而不是添加到要返回的列表中。

如果你只需要检查第一个元素,你可以在不迭代整个集合的情况下查看它:

public List<object> Foo(IEnumerable<object> objects)
{
    object firstObject;
    if (objects == null || !TryPeek(ref objects, out firstObject))
        throw new ArgumentException();

    var list = DoSomeThing(firstObject);
    var secondList = DoSomeThingElse(objects);
    list.AddRange(secondList);

    return list;
}

public static bool TryPeek<T>(ref IEnumerable<T> source, out T first)
{
    if (source == null)
        throw new ArgumentNullException(nameof(source));

    IEnumerator<T> enumerator = source.GetEnumerator();
    if (!enumerator.MoveNext())
    {
        first = default(T);
        source = Enumerable.Empty<T>();
        return false;
    }

    first = enumerator.Current;
    T firstElement = first;
    source = Iterate();
    return true;

    IEnumerable<T> Iterate()
    {
        yield return firstElement;
        using (enumerator)
        {
            while (enumerator.MoveNext())
            {
                yield return enumerator.Current;
            }
        }
    }
}

如果需要多次枚举某个对象,我喜欢使用IReadOnlyCollection方法。我想提供一个实用工具方法,可以在任何时候调用它来将IEnumerable转换为IReadOnlyCollection。与ToArray()或ToList()不同,它可以避免改变底层集合类型的额外分配成本:

    public static class EnumerableUtils
    {
        /* Ensures an IEnumerable is only enumerated once  */
        public static IReadOnlyCollection<T> AsEnumerated<T>(this IEnumerable<T> original)
        {
            if (original is IReadOnlyCollection<T> originalCollection)
            {
                return originalCollection;
            }

            return ImmutableArray.CreateRange(original);
        }
    }