可将任何专门设计用于操作一组具有一些共同特征的对象的类型视为一个集合。 这些类型几乎总适合用于实现 xref:System.Collections.IEnumerable 或 xref:System.Collections.Generic.IEnumerable`1,因此在本节中,我们只将实现其中一个或两个接口的类型视为集合。
X 请勿在公共 API 中使用弱类型集合。
表示集合项的所有返回值和参数的类型应该是确切的项类型,而不是其任何基类型(这仅适用于集合的公共成员)。
X 请勿在公共 API 中使用 xref:System.Collections.ArrayList 或 xref:System.Collections.Generic.List`1。
这些类型是设计用于内部实现而非公共 API 的数据结构。 List<T> 以 API 的清洁度和灵活性为代价,针对性能和功耗进行了优化。 例如,如果你返回 List<T>,则在客户端代码修改集合时,你无法接收通知。 此外,List<T> 公开了许多在许多情况下无用或不适用的成员(比如 xref:System.Collections.Generic.List`1.BinarySearch*)。 以下两节介绍了专门设计用于公共 API 的类型(抽象)。
X 请勿在公共 API 中使用 Hashtable 或 Dictionary<TKey,TValue>。
这些类型是设计用于内部实现的数据结构。 公共 API 应该使用 xref:System.Collections.IDictionary、IDictionary <TKey, TValue> 或实现两个接口其中之一或两者的自定义类型。
X 除非 作为,GetEnumerator 方法的返回类型,否则请勿使用xref:System.Collections.Generic.IEnumerator`1,xref:System.Collections.IEnumerator 或实现这些接口之一的任何其他类型。
从 GetEnumerator 以外的方法返回枚举器的类型不能用于 foreach 语句。
X 请勿 对同一类型同时实现IEnumerator<T>和IEnumerable<T>。 这同样适用于非通用接口IEnumerator和IEnumerable。
集合参数
✓ 请尽可能使用专用性最低的类型作为参数类型。 将集合作为参数的大多数成员使用 IEnumerable<T> 接口。
X 避免仅为了访问 Count 属性而将 xref:System.Collections.Generic.ICollection`1 或 xref:System.Collections.ICollection 用作参数。
而可考虑使用 IEnumerable<T> 或 IEnumerable,并动态地检查对象是实现了 ICollection<T> 还是 ICollection。
集合属性和返回值
X 请勿 提供可设置的集合属性。
用户可以先清除集合,然后添加新的内容,从而替换集合的内容。 如果替换整个集合是一种常见的情况,请考虑对该集合提供 AddRange 方法。
✓ 请对 表示读/写集合的属性或返回值使用 Collection<T> 或 Collection<T> 的子类。
如果 Collection<T> 不符合某些要求(例如,集合不得实现 xref:System.Collections.IList),请通过实现 IEnumerable<T>、ICollection<T> 或 xref:System.Collections.Generic.IList`1 来使用自定义集合。
✓ 请对 表示只读集合的属性或返回值使用xref:System.Collections.ObjectModel.ReadOnlyCollection`1的子类或ReadOnlyCollection<T>,或在极少数情况下IEnumerable<T>为属性或返回值表示的只读集合。
一般情况下,更倾向于使用 ReadOnlyCollection<T>。 如果它不符合某些要求(例如,集合不得实现 IList),请实现 IEnumerable<T>、ICollection<T> 或 IList<T> 来使用自定义集合。 如果实现了自定义只读集合,请实现 ICollection<T>.IsReadOnly 以返回 true。
如果你确定唯一需提供支持的情况是仅正向迭代,则只需使用 IEnumerable<T> 即可。
✓ 请考 虑使用通用基本集合的子类,而不是直接使用集合。
通过此操作,可使用更好的名称并添加基本集合类型中不存在的辅助成员。 这尤其适用于高级 API。
✓ 请考 虑从非常常用的方法和属性返回 Collection<T>或ReadOnlyCollection<T>的子类。
通过此操作,可在将来添加辅助方法或更改集合实现。
✓ 如果 存储在集合中的项目具有唯一的键(名称、ID 等),请考虑使用键控集合。 键控集合是可以由整数和键索引的集合,通常通过继承自KeyedCollection<TKey,TItem> 进行实现。
键控集合的内存占用通常较大,并且如果内存开销超过了使用键的益处,则不应使用键控集合。
X 请勿 从集合属性或从返回集合的方法返回 null 值。 而应返回空集合或空数组。
原则上,应将 null 和空(0 项)集合或数组视为相同。
快照集合与实时集合
表示某个时间点的状态的集合称为快照集合。 例如,包含从数据库查询返回的行的集合是快照集合。 始终表示当前状态的集合称为实时集合。 例如,ComboBox 项的集合就是一个实时集合。
X 请勿 从属性中返回快照集合。 属性应返回实时集合。
属性 getter 应该是非常轻量级的操作。 返回快照需要在 O(n) 操作中创建内部集合的副本。
✓ 请使 用快照集合或实时IEnumerable<T>(或其子类型)表示易失集合(即,可以在未显式修改集合的情况下进行更改的集合)。
一般情况下,表示共享资源(例如,目录中的文件)的所有集合都是易失集合。 此类集合很难或不可能作为实时集合实现,除非该实现只是一个仅正向枚举器。
在数组和集合之间进行选择
✓ 更倾 向于使用集合,而不是数组。
集合提供了对内容的更多控制,可以随着时间的推移而发展,并且可用性更好。 此外,不鼓励将数组用于只读场景,因为克隆数组的成本过高。 可用性研究表明,一些开发人员更习惯使用基于集合的 API。
但是,如果你正在开发低级 API,则对读写场景使用数组可能会更好。 数组的内存占用较小,这有助于减少工作集,并且对数组中元素的访问速度更快,因为它通过运行时进行了优化。
✓ 请考 虑在低级 API 中使用数组,从而最大程度地减少内存消耗并最大程度地提高性能。
✓ 请使 用字节数组而非字节集合。
X 切忌使用数组作为属性,如果属性在每次调用属性 getter 时都必须返回一个新数组(例如,内部数组的副本)。
实现自定义集合
✓ 考虑在设计新集合时,从 Collection<T>、ReadOnlyCollection<T> 或 KeyedCollection<TKey,TItem> 继承。
✓ 务必在设计新集合时,实现 IEnumerable<T>。 当有需要时,考虑实现 ICollection<T> 甚至 IList<T>。
在实现此类自定义集合时,请尽可能遵循 Collection<T> 和 ReadOnlyCollection<T> 建立的 API 模式。 也就是说,显式实现相同的成员,以及命名参数(与这两个集合命名它们的方式类似)等。
✓ 考虑实现非泛型集合接口(IList 和 ICollection),如果该集合经常被传递给以这些接口为输入的 API。
X 避免 在具有与集合概念无关的复杂 API 的类型上实现集合接口。
X 切忌从非泛型基本集合继承,如 CollectionBase。 相反,使用 Collection<T>、ReadOnlyCollection<T> 和 KeyedCollection<TKey,TItem>。
命名自定义集合
集合 (类型实现IEnumerable) 创建主要有两个原因:(1) 若要创建新的数据结构与特定于结构的操作,通常不同的性能特征与现有数据结构 (例如, xref:System.Collections.Generic.List`1, xref:System.Collections.Generic.LinkedList`1, xref:System.Collections.Generic.Stack`1),和 (2) 若要创建的专用的集合包含一组特定的项 (例如, xref:System.Collections.Specialized.StringCollection)。 数据结构最常用于应用程序和库的内部实现。 专用集合主要在 API 中公开(作为属性和参数类型)。
✓ 务必在实现 IDictionary 或 IDictionary<TKey,TValue> 的抽象名称中使用“Dictionary”后缀。
✓ 务必在实现 IEnumerable(或其任意后代)并表示项列表的类型名称中使用“Collection”后缀。
✓ 务必为自定义数据结构使用适当的数据结构名称。
X 避免在集合抽象名称中使用任何暗示特定实现的后缀,例如“LinkedList”或“Hashtable”。
✓ 考虑在集合名称前加上项类型的名称。 例如,存储类型为 Address 的项的集合(实现 IEnumerable<Address>)应该命名为 AddressCollection。 如果项类型是接口,则可以省略项类型的 “I” 前缀。 因此,xref:System.IDisposable 项的集合可以称为 DisposableCollection。
✓ 考虑如果框架中可能已添加或已存在相应的可写集合,则在只读集合的名称中使用“ReadOnly”前缀。
例如,只读字符串集合应称为 ReadOnlyStringCollection。
部分版权 © 2005, 2009 Microsoft Corporation。保留所有权利。
经 Pearson Education, Inc 授权,转载自框架设计准则:可重用的 .NET 库的约定、习惯用语和模式,第 2 版 作者:Krzysztof Cwalina 和 Brad Abrams,由 Addison Wesley Professional 于 2008 年 10 月 22 日印发,作为 Microsoft Windows 开发系列的一部分。
请参阅
历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 KrzysztofCwalina)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
