Liam W
封面

C# 中的解构

作者
王亮·发表于 11 个月前

解构是将一个对象分割成若干部分并将其存储到新的变量中。在 C# 中,解构可以方便地一次性将一个对象的多个成员的值存储到多个变量中。

解构元组

元组为方法返回多个值提供了便捷,无需创建额外的类型来承载返回的值。例如,下面这个方法使用元组返回两个值:

public static (string, string, int) GetPerson()
{
    var firstName = "Liam";
    var lastName = "Wang";
    var age = 18;
    return (firstName, lastName, age);
}

对于检索这个方法返回元组的各成员,如果不使用解构,我们可能需要这样写:

var person = GetPerson();

var firstName = person.Item1;
var lastName = person.Item2;
var age = person.Item3;

使用解构,则可以一次性将元组的各成员分别赋值给不同的变量,可以这样写:

(string firstName, string lastName, int age) = GetPerson();

// firstName = "Liam"
// lastName = "Wang"
// age = 18

也可以使用 var 自动推断各个变量的类型:

var (firstName, lastName, age) = GetPerson();

// firstName = "Liam"
// lastName = "Wang"
// age = 18

元组的解构是基于成员的位置顺序来的,即将 Item1 赋给第一上变量,将 Item2 赋给第二个变量……。

但是,一旦你使用解构检索元组,你就必须处理它的各个成员。我们可以使用 弃元_)来处理我们不关心的成员,只获取元组中的我们需要的部分成员。例如:

var (firstName, _, _) = GetPerson();

// firstName = "Liam"

解构类

我们也可以对类进行解构,并像对元组那样访问特定的字段。但为了实现这个目的,我们需要给类添加一个 Deconstruct() 方法,例如:

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int Age { get; set; }

    public void Deconstruct(out string firstName, out string lastName, out int age)
    {
        firstName = FirstName;
        lastName = LastName;
        age = Age;
    }
}

然后可以和元组对象一样使用解构:

var person = new Person { FirstName = "Liam", LastName = "Liam", Age = 18 };

var (firstName, lastName, age) = person;

或只关心部分成员:

...

var (firstName, _, _) = person;

Deconstruct() 方法允许重载,比如:

...

public void Deconstruct(out string firstName, out string lastName) =>
    (firstName, lastName) = (FirstName, LastName);

public void Deconstruct(out string firstName, out string lastName, out int age) =>
    (firstName, lastName, age) = (FirstName, LastName, Age);

它会根据解构时的声明的变量数调用对应的 Deconstruct() 方法。

...

var (firstName, lastName) = person;

var (firstName, lastName, age) = person;

也可以通过静态扩展方法的方式给类的实例添加 Deconstruct() 方法,比如:

public static class PersonExtensions
{
    public static void Deconstruct(this Person person,
      out string firstName, out string lastName, out int age)
    {
        firstName = person.FirstName;
        lastName = person.LastName;
        age = person.Age;
    }
}

解构记录

C# 9 的记录(Record)类型和元组一样,可以根据成员顺序直接解构。例如:

record Person(string FirstName, string LastName, int age);

static void Main(string[] args)
{
    var person = new Person("Liam", "Wang", 18);

    var (firstName, lastName, age) = person;
}

// firstName = "Liam"
// lastName = "Wang"
// age = 18

记录类型既可以和类一样有具名成员,也可以和元组一样有基于成员顺序的可解构特性,不需要单独定义 Deconstruct() 方法。