C#自定义CallResult<T>误报空引用警告的解决方法

问题核心 #

C# 编译器的可空引用状态分析默认只能识别内置的布尔判断逻辑，无法自动感知自定义类型通过隐式类型转换实现的校验契约：即CallResult<T>在Success == true时Data必然非空、Success == false时Error必然非空的规则，因此会在通过布尔校验后访问Data时抛出CS8604空引用警告。该警告不属于代码逻辑错误，是编译器缺少可空性元数据导致的静态分析误判。

具体修改方式 #

通过.NET提供的可空静态分析特性标注，向编译器显式声明类型的可空契约即可，无需修改原有业务判断逻辑。

• 引入可空分析特性命名空间
  项目基于.NET Core 3.0/.NET 5及以上版本时，直接引用内置命名空间即可：

  using System.Diagnostics.CodeAnalysis;
  

  如果使用.NET Framework、.NET Standard 2.0等旧版本框架，直接在代码中自行定义所需的分析特性，编译器可正常识别：

  namespace System.Diagnostics.CodeAnalysis
  {
      [AttributeUsage(AttributeTargets.Property | AttributeTargets.Parameter, AllowMultiple = true)]
      internal sealed class MemberNotNullWhenAttribute : Attribute
      {
          public MemberNotNullWhenAttribute(bool returnValue, params string[] members)
          {
              ReturnValue = returnValue;
              Members = members;
          }
          public bool ReturnValue { get; }
          public string[] Members { get; }
      }
  
      [AttributeUsage(AttributeTargets.Parameter)]
      internal sealed class NotNullWhenAttribute : Attribute
      {
          public NotNullWhenAttribute(bool returnValue) => ReturnValue = returnValue;
          public bool ReturnValue { get; }
      }
  }
  

• 给CallResult<T>添加契约标注
  给Success属性关联对应成员的非空条件，同时给隐式布尔转换方法加参数非空判定，修改后的完整定义如下：

  public record CallResult<T>(
      [property: MemberNotNullWhen(true, nameof(Data))]
      [property: MemberNotNullWhen(false, nameof(Error))]
      bool Success, 
      T? Data, 
      Error? Error
  ) where T : class
  {
      public CallResult(T data) : this(true, data, null)
      {
      }
  
      public CallResult(Error error) : this(false, null, error)
      {
      }
  
      public static implicit operator bool([NotNullWhen(true)] CallResult<T>? obj)
      {
          return obj?.Success ?? false;
      }
  }
  

生效逻辑 #

标注完成后编译器会自动识别以下契约：

• 当CallResult<T>实例隐式转换为bool返回true（即if (desResult)分支成立）时，实例本身非空，且Data属性一定不为null
• 当CallResult<T>实例隐式转换为bool返回false（即if (!desResult)分支成立）时，Error属性一定不为null

原有业务代码不需要做任何调整，CS8604警告会自动消除，同时错误分支中访问desResult.Error也不会再触发空引用警告。

内容的提问来源于stack exchange，提问作者nop