服务接口中使用 IList、ICollection 还是 IEnumerable？

Question

服务接口中使用 IList、ICollection 还是 IEnumerable？

c#asp.net-mvc

6

我正在构建一个与Entity Framework在ASP.NET MVC 5中访问我的数据库的服务。因此，我首先编写了一个带有接口的基础服务。但是我担心一个小事情。

通常我在我的接口中返回一个IEnumerable<T>，但这经常导致代码中的ToList()调用。

所以我想知道在这样的接口中返回什么最好。我可以只返回IList，但我担心它可能太多，而且我不需要IList提供的所有方法。

以下是我的代码：

public interface IBaseService<T>
{
    T Add(T obj);
    T Update(T obj);
    T Remove(string id);
    T Get(string id);

    ICollection<T> Find(Expression<Func<bool, T>> func);
    ICollection<T> GetAll();
}

- Antoine Thiry

5

这取决于你希望如何使用这个集合！如果只想让人们能够迭代它，那么请使用 IEnumerable；如果想让人们能够添加或删除集合中的项目，则应使用 IList 或 ICollection。 - Callum Linington

1

IReadOnlyList<T> 可能是什么？ - Marc Gravell

我唯一不会使用的是IEnumerable，因为它可能会导致未计算的查询残留问题，或者调用者几乎总是调用ToList()或ToArray()来处理结果。 - Martin Costello

3个回答

2

这取决于你的意图。在大多数情况下，你的返回类型应该是IReadOnlyCollection<T>。在极少数情况下，如果你希望调用者能够修改集合，则可以返回ICollection<T>。仅在确定调用者仅需要正向迭代时才使用IEnumerable<T>。

- Erik Molekamp

1

我猜最纯粹的解决方案是使用 IEnumerable<T>，但这取决于在你的解决方案中设定一个约定。如果你负责架构，你可能会决定返回 List<T>，以便拥有更广泛的方法集的舒适感。

- borkovski

始终从公共方法返回接口或抽象类型，而不是具体实现。 - Fred

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Evk · Accepted Answer

你说过：

通常我在接口中返回一个IEnumerable，但这经常导致代码中出现ToList()调用。

你需要找出为什么要在结果上调用ToList()。可能性很小，但有可能你想修改结果（添加/删除项）。从类似于Find或GetAll的方法中返回可修改的集合通常不是一个好习惯，但你可以返回ICollection<T>或IList<T>（如果你还需要通过索引器快速访问或插入/删除特定位置）。

然而，更有可能的是你调用ToList来确定有多少元素和/或访问特定元素。如果只需要Count，则返回IReadOnlyCollection<T>，它扩展了IEnumerable<T>，只包含Count属性。如果还需要通过索引器快速访问，则返回IReadOnlyList<T>，它扩展了IReadOnlyCollection<T>，并包含索引器。

Array和List<T>都实现了所有这些接口，因此你可以直接返回这些类：

 static IReadOnlyList<string> Test() {
      return new string[0]; // fine
 }

然而，以这种方式返回 List 时 - 调用者可能会将其强制转换回 IList<T> 并进行修改。通常情况下这不是问题，但如果你想要防止这种情况发生，请在列表上使用 AsReadOnly（它不会将任何内容复制到新列表中，所以不必担心性能）：

static IReadOnlyList<string> Test() {
      return new List<string>().AsReadOnly(); // not required but good practice
 }