如何创建不可变类？

Question

我正在创建一个不可变类。
我已将所有属性标记为只读。

我有一个班级项目列表。
虽然如果属性是只读的，则可以修改列表。

公开列表的 IEnumerable 使其不可变。
我想知道使类不可变必须遵循的基本规则是什么？

Answer 1

您只需要 L...Ehm record 和 C# 9.0 或更新版本。

public record Customer(string FirstName, string LastName, IEnumerable<string> Items);

//...

var person = new Customer("Test", "test", new List<string>() { "Test1", "Test2", "Test3" });
// you can't change anything within person variable
// person.FirstName = "NewName";

这将被转换为名为 Customer 的不可变类，具有三个属性 FirstName、LastName 和 Items。

如果您需要一个不可变（只读）集合作为类的属性，最好将其公开为IEnumerable<T> 或ReadOnlyCollection<T>，而不是来自System.Collections.Immutable 的内容

Answer 2

最初的问答日期是 2008 年底，现在有一个 System.Collections.Immutable 命名空间，我相信它可以追溯到最早的 .NET Core (1.0) 。命名空间在 .NET Standard（当前版本 2.1）和 .NET Framework（当前版本 4.8）中仍然不可用。这个命名空间有很多不可变的集合，包括 ImmutableList，这是在原始问题中提出的。但是，我相信 System.Collections.Immutable 命名空间可能会出现在 .NET 5 中，目前处于候选版本 2 中。

此外，从 C# 6 开始，您可以仅使用 { get; 来获得不可变的自动实现属性。 } .

Answer 3

使用ReadOnlyCollection 将限制客户端对其进行修改。

Answer 4

使用ReadOnlyCollection 类。它位于System.Collections.ObjectModel 命名空间中。

在任何返回列表（或在构造函数中）的地方，将列表设置为只读集合。

using System.Collections.ObjectModel;

...

public MyClass(..., List<ListItemType> theList, ...)
{
    ...
    this.myListItemCollection= theList.AsReadOnly();
    ...
}

public ReadOnlyCollection<ListItemType> ListItems
{
     get { return this.myListItemCollection; }
}

Answer 5

另一种选择是使用访问者模式，而不是公开任何内部集合。

Answer 6

我认为你在正确的轨道上 -

• 注入类的所有信息都应在构造函数中提供
• 所有属性都只能是 getter
• 如果将集合（或数组）传递给构造函数，则应将其复制以防止调用者稍后对其进行修改
• 如果您要退回您的收藏，请退回副本或只读版本（例如，使用 ArrayList.ReadOnly 或类似的 - 您可以将其与上一点结合起来并存储 调用者访问时返回的只读副本）、返回枚举器或使用其他允许对集合进行只读访问的方法/属性
• 请记住，如果您的任何成员是可变的，您仍然可能具有可变类的外观 - 如果是这种情况，您应该复制您想要保留的任何状态并避免返回整个可变对象，除非在将它们返回给调用者之前复制它们 - 另一种选择是只返回可变对象的不可变“部分” - 感谢@Brian Rasmussen 鼓励我扩展这一点

Answer 7

另外，请记住：

public readonly object[] MyObjects;

即使用 readonly 关键字标记，它也不是不可变的。您仍然可以通过索引访问器更改单个数组引用/值。

Answer 8

为了不可变，您的所有属性和字段都应该是只读的。并且任何列表中的项目本身都应该是不可变的。

您可以按如下方式制作只读列表属性：

public class MyClass
{
    public MyClass(..., IList<MyType> items)
    {
        ...
        _myReadOnlyList = new List<MyType>(items).AsReadOnly();
    }

    public IList<MyType> MyReadOnlyList
    {
        get { return _myReadOnlyList; }
    }
    private IList<MyType> _myReadOnlyList

}