如何将C#的「可能的空引用」警告转嫁给方法调用方？

你想要的效果可以通过.NET 6及以上版本提供的[RequiresMemberNotNull]特性实现，它专门用于指定方法要求某个实例成员必须非空，从而把成员的空引用检查责任转嫁给调用方，同时保留对未满足前置条件场景的警告。

修改后的代码示例 #

using System.Diagnostics.CodeAnalysis;

internal class Class1
{
    string? member;

    [MemberNotNull(nameof(member))]
    private void SetupMembers() => member = "some value";

    [RequiresMemberNotNull(nameof(member))]
    private int DoCalculation() => member.Length; // 不再触发空引用警告

    public int ExternalMethod()
    {
        SetupMembers();
        return DoCalculation(); // 编译器确认member已被初始化，无警告
    }

    // 示例：未调用SetupMembers时会触发警告
    public int BadMethod()
    {
        return DoCalculation(); // 编译器警告："成员'member'必须在调用方法'DoCalculation'之前被赋值为非null"
    }
}

特性说明 #

• [RequiresMemberNotNull(nameof(member))]标记在DoCalculation上，告诉编译器：任何调用该方法的代码，必须确保member已被初始化为非空值。
• 结合SetupMembers上的[MemberNotNull(nameof(member))]，编译器可以跟踪到ExternalMethod中调用SetupMembers后member已非空，因此调用DoCalculation时不会触发警告。
• 如果调用方未满足前置条件（比如BadMethod直接调用DoCalculation），编译器会直接抛出对应的空引用警告，完全符合你想要的保留必要警告的需求。

替代方案（若无法使用.NET 6+） #

如果你的项目基于更早的.NET版本，暂时无法使用[RequiresMemberNotNull]，可以通过以下方式近似实现：

• 给DoCalculation添加显式的空检查并抛出异常，同时保留!抑制编译器警告（仅在确认调用方会保证非空的场景下使用）：

  private int DoCalculation()
  {
      if (member is null)
          throw new InvalidOperationException("member未初始化");
      return member!.Length;
  }
  

  这种方式虽然能在运行时捕获问题，但无法在编译时触发警告，因此推荐优先使用[RequiresMemberNotNull]特性。

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