如何实现只读属性

Question

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

我看到了两种方法：

1. class MyClass
   {
       public readonly object MyProperty = new object();
   }
   

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

所有这些 FxCop 错误都说我不应该有公共成员变量，看来第二个是正确的方法。对吗？

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

如果有任何 cmets/建议/等，我将不胜感激。

Answer 1

在 C# 9 中，Microsoft 将引入一种新方法，仅在初始化时使用 init; 方法设置属性，如下所示：

public class Person
{
  public string FirstName { get; init; }
  public string LastName { get; init; }
}

这样，您可以在初始化新对象时赋值：

var person = new Person
{
  Firstname = "John",
  LastName = "Doe"
}

但是以后，你不能改变它：

person.LastName = "Denver"; // throws a compiler error

Answer 2

C# 6.0 添加只读自动属性

public object MyProperty { get; }

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

---

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

约定：
您正在遵守约定。在这种情况下，两种可能性之间的差异相对较小，遵循惯例会更好。它可能会回来咬你的一种情况是基于反射的代码。它可能只接受属性而不接受字段，例如属性编辑器/查看器。

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

使用自动属性
另一个常见的变体是使用带有私有设置器的自动属性。虽然这很短并且是一个属性，但它并不强制只读。所以我更喜欢其他的。

只读字段是自记录的
不过，该领域有一个优势：
一眼看去公共接口就清楚地表明它实际上是不可变的（除非反射）。而对于属性，您只能看到 您 无法更改它，因此您必须参考文档或实现。

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

Answer 3

另一种方式（我最喜欢的），从 C# 6 开始

private readonly int MyVal = 5;

public int MyProp => MyVal;

https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/properties#expression-body-definitions

Answer 4

随着 C# 6（在 VS 2015 中）的引入，您现在可以拥有 get-only 自动属性，其中隐式支持字段是 readonly（即可以在构造函数中分配值，但不能在其他地方分配值） ：

public string Name { get; }

public Customer(string name)  // Constructor
{
    Name = name;
}

private void SomeFunction()
{
    Name = "Something Else";  // Compile-time error
}

您现在还可以内联初始化属性（带或不带 setter）：

public string Name { get; } = "Boris";

回到这个问题，这为您提供了选项 2 的优点（公共成员是一个属性，而不是一个字段）以及选项 1 的简洁性。

不幸的是，它没有提供公共接口级别的不变性保证（如@CodesInChaos 关于自我文档的观点），因为对于该类的消费者而言，没有设置器与拥有私有接口没有区别二传手。

Answer 5

你可以这样做：

public int Property { get { ... } private set { ... } }

Answer 6

我同意第二种方式更可取。这种偏好的唯一真正原因是 .NET 类没有公共字段的普遍偏好。但是，如果该字段是只读的，除了与其他属性缺乏一致性之外，我看不出会有任何真正的反对意见。 readonly 字段和 get-only 属性之间的真正区别在于，readonly 字段保证其值在对象的生命周期内不会改变，而 get-only 属性则不会。

Answer 7

由于封装的原因，首选第二种方法。您当然可以将 readonly 字段设为公共，但这与 C# 习惯用法相悖，在这种习惯用法中您可以通过属性而不是字段进行数据访问。

这背后的原因是该属性定义了一个公共接口，如果该属性的支持实现发生更改，您最终不会破坏其余代码，因为该实现隐藏在接口后面。

Answer 8

第二种方式是首选。

private readonly int MyVal = 5;

public int MyProp { get { return MyVal;}  }

这将确保MyVal只能在初始化时赋值（也可以在构造函数中设置）。

正如您所指出的 - 这样您就不会暴露内部成员，从而允许您在将来更改内部实现。