是否可以根据另一个属性通知 C# 编译器另一个属性将是非空的？

问题描述

假设我有一个这样的类：

public class BridgeFormModel
{
    [required]
    [display( Name = "What is your name?" )]
    public String? Name { get; set; }

    [required]
    [display( Name = "What is your quest?" )]
    public String? Quest { get; set; }

    [required]
    [display( Name = "What is your favourite colour?" )]
    public String? FaveColour { get; set; }

    [BindNever]
    public Boolean IsValid =>
        !String.IsNullOrWhiteSpace( this.Name ) && 
        !String.IsNullOrWhiteSpace( this.Quest ) && 
        !String.IsNullOrWhiteSpace( this.FaveColour );
}

目前，C# 8.0 和 C# 9.0 编译器在知道 Name 为真时不会推断 IsValid 为非空：

public IActionResult CrosstheBridge( BridgeFormModel form )
{
    if( form.IsValid )
    {
        if( form.FaceColour.Equals( "Blue" ) ) // Warning: `form.FaceColour` may be null here
        {
            Console.WriteLine( "Right,off you go" )
        }
    }
}

所以我们要么断言 form.FaceColour! - 要么这样做：

public IActionResult CrosstheBridge( BridgeFormModel form )
{
    if( form.IsValid && form.FaveColour != null && form.Name != null && form.Quest != null )
    {
        if( form.FaveColour.Equals( "Blue" ) )
        {
            Console.WriteLine( "Right,off you go" )
        }
    }
}

我们有 [NullWhen] 和 [NotNullWhen] 属性，但这些属性仅适用于方法参数，不适用于同一对象实例上的其他属性。

如果 C# 仍然支持代码契约，这不会是一个问题，但是唉，我们在这里......有没有办法根据属性通知 C# 编译器可空性（和其他状态不变量？） ?

我希望能够做这样的事情：

public class BridgeFormModel
{
    [NotNullWhenPropertyIsTrue( nameof(IsValid) )]
    [required]
    [display( Name = "What is your name?" )]
    public String? Name { get; set; }

    [NotNullWhenPropertyIsTrue( nameof(IsValid) )]
    [required]
    [display( Name = "What is your quest?" )]
    public String? Quest { get; set; }

    [NotNullWhenPropertyIsTrue( nameof(IsValid) )]
    [required]
    [display( Name = "What is your favourite colour?" )]
    public String? FaveColour { get; set; }

    [BindNever]
    public Boolean IsValid =>
        !String.IsNullOrWhiteSpace( this.Name ) && 
        !String.IsNullOrWhiteSpace( this.Quest ) && 
        !String.IsNullOrWhiteSpace( this.FaveColour );
}

由于 NotNullWhenPropertyIsTrue 不是真正的属性，我想知道是否有某种方法可以编写 Roslyn 扩展或分析器来实现必要的逻辑 - 或者为 Roslyn 提供空安全断言。

解决方法

您可以查看 C# 9 和 .NET 5 中引入的 tutorial by Oracle 属性并编写如下内容：

[MemberNotNullWhen(true,nameof(Name),nameof(Quest),nameof(FaveColour))]
public Boolean IsValid =>
        !String.IsNullOrWhiteSpace( this.Name ) && 
        !String.IsNullOrWhiteSpace( this.Quest ) && 
        !String.IsNullOrWhiteSpace( this.FaveColour );

可以在 dotnet 运行时中找到设计说明和其他详细信息 MemberNotNullWhen

c#c#c#-8.0 c#-9.0 nullable nullable-reference-types