C#中使用NotNullWhen属性时，能否延迟返回值检查？如何解决编译警告？

在C#可空引用类型上下文里，NotNullWhen属性用于告知编译器：当方法返回指定值时，对应的out参数不会为null。微软文档的示例是直接在if语句中使用方法返回值，此时编译器能正确识别out参数的非空性：

private bool outputIfInputValid(string input, [NotNullWhen(returnValue: true)] out string? output) {
    output = null;
    if (input == "valid") {
        output = "set";
        return true;
    }
    return false;
}

public void testMethod() {
    if (outputIfInputValid("valid", out string? output)) {
        string nonNullString = output;
        // 无警告：编译器知道output不为null
    }
}

但如果需要先执行其他逻辑，延迟对返回值的检查（比如在闭包中使用output），编译器无法识别返回值变量（如wasSet）和out参数的关联关系，会抛出“output可能为null”的警告：

private bool outputIfInputValid(string input, [NotNullWhen(returnValue: true)] out string? output) {
    output = null;
    if (input == "valid") {
        output = "set";
        return true;
    }
    return false;
}

public void testMethod() {
    bool wasSet = outputIfInputValid("valid", out string? output);

    // 执行其他代码...

    using (getLock()) {
        if (wasSet) {
            string nonNullString = output;
            // 出现警告：output可能为null
        }
    }
}

以下是几种可行的解决办法：

1. 用自定义记录/类封装状态与输出值 #

将方法的返回值和out参数合并为一个带NotNullWhen属性的自定义类型，让编译器能跟踪状态与值的关联关系：

// 定义带NotNullWhen属性的记录类型
public record ValidationResult(bool IsValid, [NotNullWhen(true)] string? Value);

// 修改原方法返回该记录
private ValidationResult outputIfInputValid(string input) {
    if (input == "valid") {
        return new ValidationResult(true, "set");
    }
    return new ValidationResult(false, null);
}

public void testMethod() {
    var result = outputIfInputValid("valid");

    // 执行其他代码...

    using (getLock()) {
        if (result.IsValid) {
            string nonNullString = result.Value;
            // 无警告：编译器识别IsValid为true时Value非空
        }
    }
}

这种方法从根源上绑定了状态和输出值的关系，是最安全的方案，推荐优先使用。

2. 使用空抑制运算符! #

如果你能确保逻辑上wasSet为true时output一定非空，可以直接用!告诉编译器忽略空警告：

public void testMethod() {
    bool wasSet = outputIfInputValid("valid", out string? output);

    // 执行其他代码...

    using (getLock()) {
        if (wasSet) {
            string nonNullString = output!;
            // 无警告：手动告知编译器output不为null
        }
    }
}

注意：这种方法需要你自己保证逻辑正确性，否则可能导致运行时NullReferenceException，适合快速解决且逻辑明确的场景。

3. 调整代码结构，将检查与使用放在同一作用域 #

如果允许修改方法设计，可以将需要延迟执行的逻辑作为委托传入方法，在方法内部的有效分支中执行：

private bool outputIfInputValid(string input, [NotNullWhen(true)] out string? output, Action? onValid = null) {
    output = null;
    if (input == "valid") {
        output = "set";
        onValid?.Invoke();
        return true;
    }
    return false;
}

public void testMethod() {
    outputIfInputValid("valid", out string? output, () => {
        // 执行其他代码...

        using (getLock()) {
            string nonNullString = output;
            // 无警告：处于方法返回true的分支作用域内
        }
    });
}

这种方法不需要额外的类型定义，但会改变原有的代码调用结构，适合可以调整方法接口的场景。

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