C#中使用 record 的好处因为好用所以推荐~-摩杜云开发者社区

一晃距C# 9发布已经4年了,对于record关键字想必大家都不陌生了,不过呢发现还是有很多同学不屑于使用这个语法糖,确实,本质上 record 就是 class 的封装,能用 record 书写的类,那100%都是可以自己手撸出来的,但是呢有没有考虑别人可能一分钟写好的代码你可能会需要数分钟才能完成.因此为了能有更多时间摸鱼 ,强烈推荐不屑一顾的同学也能用起来!

下面我简略聊一聊 record 的好处和最佳场景:

简化语法

我们只需要一行代码就可以定义完成,这个是最直观节省编码的方式,我们不需要编写一堆枯燥的get;set; 也不需要编写构造函数等样板代码:

public record Person(string FirstName, string LastName);

那么有同学会有疑问,如果Person有很多的属性咋整,不就意味着主构造函数会很冗长,其实呢,这个和封装传参的方式是一样的,我们可以把同质的属性封装成其他的record或者class,比如:

public record ExtraInfomation(string Address,string Email,int Age);
public record Person(string FirstName, string LastName, ExtraInfomation ExtraInfo);

自动生成一些对我们有用的成员函数.

构造函数：根据定义的属性自动生成构造函数。
属性：自动生成只读属性。
Deconstruct 方法：用于解构记录对象,对于习惯写TS的小伙伴相当友好。
Equals 和 GetHashCode 方法：基于属性值的相等性比较。
ToString 方法：提供友好的字符串表示,对于调试输出特别友好。

基于值的相等性语法.

我们很多时候有这种需求就是比较一个类的所有属性来判断逻辑.如果使用 record 的话我们只需要==或者Equals就能判断,

非破坏性复制值

对于一个 class 的浅表复制,我们可能需要实现ICloneable,亦或者 new 一个对象逐个属性赋值,当然还有其他的方法,但是呢肯定是没有 record 来的这么简单直接.我们仅需要一个with关键字就干完了

public record Person(string FirstName, string LastName, int Age);
var person1 = new Person("vip", "wan", 18);
var person2 = person1 with { Age = 30 };
Console.WriteLine(person1); // 输出: Person { FirstName = vip, LastName = wan, Age = 18 }
Console.WriteLine(person2); // 输出: Person { FirstName = vip, LastName = wan, Age = 30 }

在单元测试中的场景:

public readonly record struct RegexMatch(string Raw, string Act);

[Theory]
[ClassData(typeof(AHrefTestData))]
public void Test_Regex_A_Href(RegexMatch rm)
{
    //获取a标签的href属性的表达式
    var regex = new Regex(@"<a[^>]+href=(['""])(?<href>.*?)\1[^>]*>", RegexOptions.IgnoreCase);
    var match = regex.Match(rm.Raw);
    Assert.True(match.Success);
    Assert.Equal(rm.Act, match.Groups["href"].Value);
}

public class AHrefTestData : TheoryData<RegexMatch>
{
    public AHrefTestData()
    {
        var rm = new RegexMatch("<a href='http://www.baidu.com'></a>", "http://www.baidu.com");
        Add(rm);
        //因为期待的结果都是一样的，所以可以直接使用with语法节省编码量
        Add(rm with { Raw = "<a href=\"http://www.baidu.com\"></a>" });
        Add(rm with { Raw = "<a href='http://www.baidu.com'>" });
        Add(rm with { Raw = "<a Href=\"http://www.baidu.com\">" });
    }
}

解构的支持

record 类型自动生成 Deconstruct 方法，允许你轻松地解构 record 对象,对于全栈的同学书写就是手到擒来!

var person = new Person("vip", "wan", 18);
var (firstName, lastName, age) = person;
Console.WriteLine(firstName); // 输出: vip
Console.WriteLine(lastName);  // 输出: wan
Console.WriteLine(age);       // 输出: 18

结合模式匹配

record 类型与模式匹配功能很好地集成在一起，使得在模式匹配中使用 record 对象更加方便。

public record Person(string UserName, int Age);
public string GetPersonInfo(Person person) => person switch
{
    { Age: < 18 } => "Minor",
    { Age: >= 18 } => "Adult",
    _ => "Unknown"
};

填充既有类

嗯当前 C# 语言是真的突飞猛进,年底就要发布C# 13了,小伙伴们都~~直呼学不动了~~!,当然也有同学肯定也尝鲜了主构造函数了吧, 如果想要对主构造函数进一步了解可以点击链接对于注入的服务又能少撸不少的代码!

那么既然 class 都有了主构造函数,是不是意味着 record 就失去意义了呢?!,嗯?!你忘了上面的那些糖的甜度了吗?

因此我们如果需要对既有的 class 支持到 record 的特性我们只需要在class前加上 record 即可.

public record class User {
  public string UserName{ get; set;}
  public int Age { get; set;}
}
var user1 = new User { UserName = "vipwan" , Age = 18};
var user2 = user1 with { };
var user3 = user1 with { Age = 30 };
user1 == user2 // true;
user3.ToString() // "User { Name = vipwan, Age = 30 }"

C# 10 提供的record struct,readonly record struct支持:

默认情况下编译器将record等价于record class,record class由于是基于class的封装因此完整的继承了class的多态性等特征,两者复制比较 编译器内部实现代码是不同的,struct 的性能会稍好(值类型和引用类型的主要区别),因此MS在 C# 10中带来了(readonly) record struct的支持;

对于readonly record struct和record struct的区别:

record struct：默认不可变，但可以包含可变字段和属性，适用于需要一定可变性的值类型数据结构。
readonly record struct：由于其完全不可变性，编译器可以进行更多的优化，例如避免不必要的复制，从而提高性能。

对于代码的区别请看:

//本身是class所以完整的支持继承和多态
public abstract record PersonBase(string FirstName, string LastName);

public record Person(string FirstName, string LastName, string Address) : PersonBase(FirstName, LastName)
{
    public int? Age { get; set; }
}
//由于PersonStruct本身是struct因此不能被继承
public record struct PersonStruct(string FirstName, string LastName)
{
    public int? Age { get; set; }
}
//Age只能只读或者init;因此不能设置为:public int? Age { get; set; }
public readonly record struct PersonReadonlyStruct(string FirstName, string LastName)
{
    public int? Age { get; init; }
}

对于如何选择总结一句:

struct 极致性能, class 包容性强,对于大多数情况下 (readonly) record struct 够用;对于包容免除后顾之忧,优先选择 record class !

总结

使用 record 类型的主要好处包括简洁的语法、自动生成的成员、基于值的相等性、非破坏性复制、解构支持、继承支持和与模式匹配的良好集成。这些特性使得 record 类型非常适合用于不可变数据对象(DTO,VO等)，提高了代码的可读性、可维护性和开发效率。