C# field 半自动实现属性

现在还用不了^_^

原计划 C#11 可用，后来跳票到 C#12，不确定何时可用。

在C#3中我们拥有了自动实现属性，编译器自动生成一个匿名、私有的字段来保存值，仅访问器可使用。

public string Prop { get; set; }

// in the background...
[CompilerGenerated]
private string <Prop>k__BackingField;

但我们有时候要给Getter和Setter添加自定义逻辑，例如

验证输入值是否合法
通知值已更新（…INotifyPropertyChanged.PropertyChanged）

这时自动实现属性便无法胜任，只能使用传统写法，自己创建一个字段：

private string _prop;
public string Prop
{
    get => _prop;
    set
    {
        ArgumentException.ThrowIfNullOrEmpty(value, nameof(Prop));
        _prop = value;
    }
}

这样做后有这样几个问题：

_prop 可以被类中其他部分访问，有潜在隐患。
增加了代码量，可读性下降。

在即将到来的 C# 12 中，我们可以使用 field 关键字，来实现半自动属性。半自动属性与全自动属性类似，编译器都会生成辅助字段，但该字段可以在访问器块中使用 field 来访问。因此，我们的代码可以简化成：

public string Prop
{
    // No more _prop, compiler generates it automatically accessed by the `field` keyword.
    get => field; 
    set
    {
        ArgumentException.ThrowIfNullOrEmpty(value, nameof(Prop));
        field = value;
    }
}

SharpLab.io C# and decompiled c# code of field keyword

完整代码：

namespace SemiAutoProperty;
 
using System;
public class User
{
    // Use of field: semi-auto property.
    // In this case, a constraint is applied to setter.
    public required string Name
    {
        get => field;
        set
        {
            ArgumentException.ThrowIfNullOrEmpty(value, nameof(Prop));
            field = value;
        }
    }
    
    // No accessor body: auto property. 
    public string Nickname {get; set;} = String.Empty;
 
    public User() {}
 
    [System.Diagnostics.CodeAnalysis.SetsRequiredMembers]
    public User(string name):this() => Name = name;
}
 
internal static class Program{
    private static void Main()
    {
        var f = new User()
        {
           Name="John",
        };
        Console.WriteLine(f.Name);
 
        try
        {
            f.Name = "";
        }
        catch (ArgumentException)
        {
            Console.WriteLine("ArgumentException Thrown");
        }
    }
}

P.S.

这段代码还用到了一个required关键字，搜索一下就知道怎么用啦。

本文采用署名-非商业性使用-相同方式共享 4.0 国际许可协议，转载请注明出处。