C# 中的记录类型简介

项目
06/01/2023

C# 中的记录是一个类或结构，它为使用数据模型提供特定的语法和行为。 record 修饰符指示编译器合成对主要角色存储数据的类型有用的成员。这些成员包括支持值相等的 ToString() 和成员的重载。

何时使用记录

在下列情况下，请考虑使用记录而不是类或结构：

你想要定义依赖值相等性的数据模型。
你想要定义对象不可变的类型。

值相等性

对记录来说，值相等性表示当类型匹配且所有属性和字段值都匹配时，记录类型的两个变量相等。对于其他引用类型（例如类），相等性是指引用相等性。也就是说，如果类的两个变量引用同一个对象，则这两个变量是相等的。确定两个记录实例的相等性的方法和运算符使用值相等性。

并非所有数据模型都适合使用值相等性。例如，Entity Framework Core 依赖引用相等性，来确保它对概念上是一个实体的实体类型只使用一个实例。因此，记录类型不适合用作 Entity Framework Core 中的实体类型。

不可变性

不可变类型会阻止你在对象实例化后更改该对象的任何属性或字段值。如果你需要一个类型是线程安全的，或者需要哈希代码在哈希表中能保持不变，那么不可变性很有用。记录为创建和使用不可变类型提供了简洁的语法。

不可变性并不适用于所有数据方案。例如，Entity Framework Core 不支持通过不可变实体类型进行更新。

记录与类和结构的区别

声明和实例化类或结构时使用的语法与操作记录时的相同。只是将 class 关键字替换为 record，或者使用 record struct 而不是 struct。同样地，记录类支持相同的表示继承关系的语法。记录与类的区别如下所示：

可在主构造函数中使用位置参数来创建和实例化具有不可变属性的类型。
在类中指示引用相等性或不相等的方法和运算符（例如 Object.Equals(Object) 和 ==）在记录中指示值相等性或不相等。
可使用 with 表达式对不可变对象创建在所选属性中具有新值的副本。
记录的 ToString 方法会创建一个格式字符串，它显示对象的类型名称及其所有公共属性的名称和值。
记录可从另一个记录继承。但记录不可从类继承，类也不可从记录继承。

记录结构与结构的不同之处是，编译器合成了方法来确定相等性和 ToString。编译器为位置记录结构合成 Deconstruct 方法。

编译器为 record class 中的每个主构造函数参数合成一个公共仅初始化属性。在 record struct 中，编译器合成公共读写属性。编译器不会在不包含 record 修饰符的 class 和 struct 类型中创建主构造函数参数的属性。

示例

下面的示例定义了一个公共记录，它使用位置参数来声明和实例化记录。然后，它会输出类型名称和属性值：


public record Person(string FirstName, string LastName);

public static class Program
{
    public static void Main()
    {
        Person person = new("Nancy", "Davolio");
        Console.WriteLine(person);
        // output: Person { FirstName = Nancy, LastName = Davolio }
    }

}

下面的示例演示了记录中的值相等性：

public record Person(string FirstName, string LastName, string[] PhoneNumbers);
public static class Program
{
    public static void Main()
    {
        var phoneNumbers = new string[2];
        Person person1 = new("Nancy", "Davolio", phoneNumbers);
        Person person2 = new("Nancy", "Davolio", phoneNumbers);
        Console.WriteLine(person1 == person2); // output: True

        person1.PhoneNumbers[0] = "555-1234";
        Console.WriteLine(person1 == person2); // output: True

        Console.WriteLine(ReferenceEquals(person1, person2)); // output: False
    }
}

下面的示例演示如何使用 with 表达式来复制不可变对象和更改其中的一个属性：

public record Person(string FirstName, string LastName)
{
    public required string[] PhoneNumbers { get; init; }
}

public class Program
{
    public static void Main()
    {
        Person person1 = new("Nancy", "Davolio") { PhoneNumbers = new string[1] };
        Console.WriteLine(person1);
        // output: Person { FirstName = Nancy, LastName = Davolio, PhoneNumbers = System.String[] }

        Person person2 = person1 with { FirstName = "John" };
        Console.WriteLine(person2);
        // output: Person { FirstName = John, LastName = Davolio, PhoneNumbers = System.String[] }
        Console.WriteLine(person1 == person2); // output: False

        person2 = person1 with { PhoneNumbers = new string[1] };
        Console.WriteLine(person2);
        // output: Person { FirstName = Nancy, LastName = Davolio, PhoneNumbers = System.String[] }
        Console.WriteLine(person1 == person2); // output: False

        person2 = person1 with { };
        Console.WriteLine(person1 == person2); // output: True
    }
}

有关详细信息，请查看记录（C# 参考）。

C# 语言规范

有关详细信息，请参阅 C# 语言规范。该语言规范是 C# 语法和用法的权威资料。