C# 14 field keyword

Intro

field 关键字在 .NET 9 里已经作为 C# 13 的一个预览版本可用 C# 13 Preview 的 field keyword

在 C# 14 中将正式推出，这一特性可以帮助我们简化很多属性的使用，尤其 C# 13 支持推出的比较晚，可能很多人都不知道，所以再介绍一下

Sample

field keyword 特性是指在属性（Property）的上下文中支持使用 field 关键词来引用属性背后的字段

我们来看下自动属性的示例：

public string Name { get; set; }

这等同于

private string _name;
public string Name
{
 get => _name;
 set => _name = value;
}

使用 field 关键字改一下如下：

public string Name
{
 get => field;
 set => field = value;
}

当我们需要修改部分逻辑时，使用 field 就可以很大的简化了

public string Name
{
 get;
 set => field = value.Trim();
}

没有 field 的时候我们就不得不使用一个字段了，使用如下：

private string _name;
public string Name
{
 get => _name;
 set => _name = value.Trim();
}

可以看到即使我们只自定义了 set 的 逻辑，get 的方法还是需要做改动，使用 field 的话 get 就无需改动了，之前 field 关键字特性也曾被称为半自动属性，相应地自动属性也可以称之为完全自动属性。

我们也可以在返回和操作前后增加一些自定义的操作

public staticstring Name
{
 get;
 set => field = value?.Trim() ?? string.Empty;
 //set;
} = string.Empty;

publicstaticstring Description
{
 get => field ?? string.Empty;
 set
 {
 Console.Write(">>>");
 Console.WriteLine(field);
 Console.WriteLine($"Before set description, {nameof(value)}: {value}");
 field = value?.Trim()!;
 Console.WriteLine($"After set description, {field}");
 Console.WriteLine("After set description");
 Console.Write(">>>");
 Console.WriteLine(field);
 }
} = default!;

public static void Run()
{
 Name = " Hello ";
 Console.WriteLine(Name);
 Console.WriteLine(Name.Length);

 Console.WriteLine(Description is not );
 Description = " World ";
 Console.WriteLine(Description);
 Console.WriteLine(Description.Length);
}

输出结果如下：

反编译一下结果如下：

之前 .NET 9 正式版有的问题现在也已经修复

Breaking Change

看到前面的代码，大家或许能够想到这会是一个破坏性的变更，如果我们原本有了一个名为 field 的关键词，就会引发冲突，在属性范围内引用到的就未必是期望的 field 了，例如下面的这个示例：

private string? field;
public string? Field
{
 get => this.field;
 set => field = value;
}

如果直接用 field 在升级了之后引用到的是 field keyword，虽然在这里例子是效果是一样的

如果要引用对应的字段需要使用 this.field 或者使用 @field

private string? field;
public string? Field
{
 get => this.field;
 set => @field = value;
}

另外我们也不能在 get/set 访问器里声明 field 关键字作为局部变量，不然也会报错，报错信息如下

 error CS9273: In language version preview, 'field' is a keyword within a property accessor. Rename the variable or use the identifier '@field' instead.

public string? Description
{
 get => field;
 set
 {
 var @field = 123;
 Console.WriteLine(field);
 Console.WriteLine(@field);
 field = value;
 }
}

More

需要注意，C# 14 还在 preview，想要体验这个特性的话需要将 LangVersion 设置为 preview 才可以，由于有 breaking change， 大家有潜在的冲突的话可以提前修改下，dotnet 10 正式发布之后也就可以无痛升级了

注意之前发布的文章介绍的话会发现当在插值字符串中使用 field 关键词的时候之前会报错，现在已经修复

另外建议私有字段名称使用下划线 _ 开头，这样有新的 keyword 引入时不容易发生冲突，可以一定程度上避免一些 breaking change 导致的变动

dotnet-exec 的最新版本中也支持了 net10.0，使用下面这个命令来安装 dotnet-exec tool 来体验，因为还是预览版特性，需要使用 --preview option 来使用这个特性

dotnet tool update -g dotnet-execute

References

• https://github.com/dotnet/csharplang/blob/main/proposals/field-keyword.md
• https://github.com/dotnet/csharplang/issues/140
• https://github.com/dotnet/csharplang/discussions/8634
• https://github.com/dotnet/roslyn/pull/75566
• https://github.com/WeihanLi/SamplesInPractice/blob/main/net9sample/CSharp13Samples/FieldKeywordSample.cs
• https://github.com/WeihanLi/SamplesInPractice/blob/main/net10sample/CSharp14Samples/FieldKeywordSamples.cs
• C# 13 Preview 的 field keyword