如何实现只读属性

一尘不染

我需要在我的类型上实现一个只读
属性。而且，此属性的值将在构造函数中设置，并且不会被更改（我正在编写一个类，该类公开用于WPF的自定义路由UI命令，但这无关紧要）。

我看到两种方法：

class MyClass
{
public readonly object MyProperty = new object();
}
class MyClass
{
private readonly object my_property = new object();
public object MyProperty { get { return my_property; } }
}

由于所有这些FxCop错误都表明我不应该拥有公共成员变量，因此第二个似乎是正确的方法。正确？

在这种情况下，仅获取属性和只读成员之间有什么区别吗？

我将不胜感激任何意见/建议/等。

阅读 281

2020-05-19

共1个答案

一尘不染

版本控制：
如果您仅对源代码兼容性感兴趣，我认为这没有多大区别。
使用属性更好地实现二进制兼容性，因为您可以将其替换为具有setter的属性，而不必破坏所编译库的代码，具体取决于您的库。

约定：
您正在遵循约定。在这种情况下，按照惯例，两种可能性之间的差异相对较小。基于反射的代码可能会再次咬住您。它可能仅接受属性，而不接受字段，例如属性编辑器/查看器。

序列化
从字段更改为属性可能会破坏许多序列化程序。而且AFAIK XmlSerializer只会序列化公共属性，而不会序列化公共字段。

使用自动财产
另一个常见的变化是使用带有私有设置程序 的自动财产 。虽然这是一个简短的属性，但它不强制执行只读性。所以我更喜欢其他的。

只读字段是自记录
的，但是该字段有一个优点：
一眼就能看出公共接口实际上是不可变的（禁止反射）。而对于属性，您只能看到您无法更改它，因此您必须参考文档或实现。

但老实说，由于我很懒，我在应用程序代码中经常使用第一个。在图书馆中，我通常会更全面，并遵循惯例。

C＃6.0添加了只读自动属性

public object MyProperty { get; }

因此，当您不需要支持较早的编译器时，您可以拥有一个真正的只读属性，其代码与只读字段一样简洁。

2020-05-19