虽然属性在技术上与方法非常相似,但它们的使用场景却截然不同。 属性应被视为聪明的字段。 它们兼具字段的调用语法和方法的灵活性。
✓ 务必创建 get-only 属性,如果调用方不能更改属性值的话。
请记住,如果属性的类型是可变的引用类型,则即使属性为 get-only,也可以更改属性值。
X 切忌提供 set-only 属性,或其 setter 的可访问性比 getter 更广泛的属性。
例如,不要使用具有公共 setter 和受保护的 getter 的属性。
如果无法提供属性 getter,请将该功能实现为方法。 考虑将方法名称以 Set 开始,在后面添加你对该属性的命名。 如,xref:System.AppDomain 有一个名为 SetCachePath 的方法,而不是一个名为 CachePath 的 set-only 属性。
✓ 务必为所有属性提供合理的默认值,确保默认值不会导致安全漏洞或严重低效的代码。
✓ 务必允许将属性按任何顺序设置,即使这会导致对象的临时无效状态。
在给定同一对象上的其他属性的值的情况下,一个属性的某些值可能是无效的,这是导致两个或多个属性相关联的一种常见况。 在这种情况下,无效状态导致的异常应该会推迟,直到对象实际将这些相关属性一起使用。
✓ 务必在属性 setter 引发异常时保留以前的值。
X 避免从属性 getter 引发异常。
属性 getter 应该是简单的操作,不应该有任何前置条件。 如果某个 getter 可能会引发异常,则应该将其重新设计为方法。 请注意,此规则不适用于索引器,因为我们确实会因验证参数而导致异常。
索引属性设计
索引属性是一个特殊属性,可以具有参数,并且可以使用与数组索引类似的特殊语法进行调用。
索引属性通常称为索引器。 索引器应仅用于提供对逻辑集合中项目的访问的 API。 例如,字符串是字符的集合,在索引器上添加了 xref:System.String?displayProperty=nameWithType 即可访问其字符。
✓ 考虑使用索引器以提供对存储在内部数组中的数据访问。
✓ 考虑 提供索引器上表示的项的集合的类型。
X 避免 使用索引与多个参数的属性。
如果设计需要多个参数,请重新考虑该属性是否真正代表逻辑集合的访问者。 如果不是,请改用方法。 考虑使用 Get 或 Set 开头的方法名称。
X 避免 具有以外的其他参数类型的索引器xref:System.Int32?displayProperty=nameWithType, xref:System.Int64?displayProperty=nameWithType, xref:System.String?displayProperty=nameWithType, xref:System.Object?displayProperty=nameWithType,或枚举。
如果设计需要其他类型的参数,请仔细重新评估 API 是否真正代表逻辑集合的访问者。 如果不是,请使用方法。 考虑使用 Get 或 Set 开头的方法名称
✓ 务必使用名称 Item 的索引属性,除非有明显更好的名称(例如,请参阅 xref:System.String.Chars*属性System.String)。
在 C# 中,索引器默认名称为 Item。 xref:System.Runtime.CompilerServices.IndexerNameAttribute 可用于自定义此名称。
X 切忌提供索引器和在语义上等效的方法。
X 切忌 提供多个系列中一种类型的重载索引器。
此准则由 C# 编译器强制执行。
X 切忌使用非默认索引属性。
此准则由 C# 编译器强制执行。
属性更改通知事件
有时,提供用于通知用户属性值更改的事件是很有用的。 例如,System.Windows.Forms.Control 在其 Text 属性的值发生变化后引发 TextChanged 事件。
✓ 考虑在修改高级API(通常是设计器组件)中的属性值时引发更改知事件。
如果具备可让用户知道对象的属性何时发生变化的有效方案,则该对象应该该属性引发更改通知事件。
但是,可能并不值得为基础类型或集合等低级 API 引发此类事件。 例如,向列表添加新项且 Count 属性更改时,xref:System.Collections.Generic.List`1 不会引发此类事件。
✓ 考虑当属性值因外力而变化时,引发更改通知事件。
如果属性值通过某种外力(通过调用对象上的方法以外的方式)发生更改。则引发事件向开发人员指示值正在更改并已更改。 一个典型示例是文本框控件的 Text 属性。 当用户在 TextBox 中键入文本时,属性值会自动更改。
部分版权 © 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,规范化链接,移除外部媒体和导航标记。
