我应该返回一个 IEnumerable 类型还是一个列表？

Question

我已经定义了一个函数：public IEnumerable<User> GetAllUsers()

该函数的逻辑是这样的：

var userList = new List<User>
.. logic ...
return userList;

定义返回类型IEnumerable<User> 有什么好处，还是我应该简单明了地定义返回List<User> 类型？

Answer 1

这将取决于。最好尽可能返回最严格的类型，但IEnumerable 的问题在于它通常不会被多次枚举。例如，IEnumerable 可能正在从数据库中进行选择，并且每个枚举都将启动一个可能长时间运行的查询。

在您的情况下，如果您希望返回有关用户的信息，那么我会考虑使用 IReadOnlyList 或 IReadOnlyCollection

Answer 2

每个集合都可以隐式转换为 IEnumerable。确实，每次您都会将一个输入到 foreach 循环中。 foreach 仅适用于 Enumerables。对于遇到此异常情况的每个人的烦恼：Unable to remove list item from list inside a for each loop C#

由于您可能在返回之前完成了列表的填写，因此我认为 Enumerables 没有任何优势。他们真正擅长的是向消费者隐藏某种异步数据检索。 在使用 Enumerable 时发生的检索。有关实际示例，请参阅 Directory.EnumerateFiles()。

List<T> 更通用。如果有人需要IEnumerable<T>，他们可以从中制作一个，而无需大量工作。

Answer 3

As Guidelines for Collections said:

请使用ReadOnlyCollection<T>，ReadOnlyCollection<T> 的子类，或 在极少数情况下IEnumerable<T> 用于属性或返回值 表示只读集合。

一般来说，更喜欢ReadOnlyCollection<T>。如果不满足一些 要求（例如，集合不能实现IList），使用 通过实现IEnumerable<T>、ICollection<T> 或 IList<T>。如果您确实实现了自定义只读集合，请实现 ICollection<T>.IsReadOnly 返回 true。

如果您确定只有您想要的场景 支持只向前迭代，你可以简单地使用 IEnumerable<T>.

和不要在公共 API 中使用 ArrayList 或 List：

这些类型是设计用于内部的数据结构 实现，而不是在公共 API 中。列表针对 以 API 的清洁度为代价的性能和功率，以及 灵活性。例如，如果您返回 List，您将永远不会 能够在客户端代码修改时接收通知 收藏。此外，List 公开了许多成员，例如 BinarySearch、 在许多情况下没有用或不适用。以下两个 部分描述了专门为使用而设计的类型（抽象） 在公共 API 中。