在.NET 8中编写C#代码以处理JsonNode对象，避免编译器关于可能的空引用警告的最佳实践是始终检查节点是否为null。

Question

我正在努力掌握最新的C#语言特性和.NET 8。我了解到，从C# 8.0及更高版本开始，如果将可能为null的值赋给引用类型变量，而该变量没有声明为可空引用类型，编译器将会生成警告。

例如，我有一个这样的函数：

void ManipulateJson(string jsonString)
{
    JsonNode node = JsonNode.Parse(jsonString); // 编译器警告
    string determinant = node["determinant"].GetValue(); // 编译器警告
    string id = GenerateNewId(determinant);
    node["id"] = id;
}

第一行和第二行会引发编译器警告，因为JsonNode.Parse(jsonString)和node["determinant"]可能为null。

如果我没理解错，我可以这样写以避免警告：

void ManipulateJson(string jsonString)
{
    JsonNode? nodeNullable = JsonNode.Parse(jsonString);
    JsonNode node = nodeNullable ?? throw new Exception("JSON值为空");
    JsonNode? determinantNodeNullable = node["determinant"];
    JsonNode determinantNode = determinantNodeNullable ?? throw new Exception("JSON中缺少'determinant'");
    string determinant = determinantNode.GetValue(); // 仍可能有编译器警告
    string id = GenerateNewId(determinant);
    node["id"] = id;
}

我本可以使用null原谅操作符来减少一些代码的繁琐，但这似乎违背了引入可空引用类型的目的。

请问，在保持代码可读性和可维护性的同时，特别是在处理多个JSON属性时，有哪些相关最佳实践可以帮助我以良好的形式编写这样的代码呢？

diegoveloper · Answer

听起来你已经很好地掌握了处理这类问题的一些常规做法：

如果你非常确定输入不会含有null或缺失的属性，你可以使用null原谅操作符、为这部分代码完全禁用null检查，或者直接跳过JsonNode，将字符串解析为强类型。
如果你对此不太确定，最好的做法可能是使用?? throw语法，并附上描述性的异常信息，以便于追踪缺失的内容。

当然，你还可以充分利用C#的所有特性来自定义解决方案。例如，你可以创建自定义扩展方法来尝试获取属性，并在属性不存在时抛出带有有用上下文信息的异常。

public static class JsonNodeExtensions
{
    public static JsonNode GetRequiredProperty(this JsonNode node, string propertyName) =>
        node is not JsonObject obj 
            ? throw new InvalidOperationException($"无法访问属性 {propertyName}：JSON路径 {node.GetPath()} 不是一个对象")
            : obj[propertyName] ?? throw new InvalidOperationException($"JSON路径 {node.GetPath()}.{propertyName} 是null或未定义");
}

John La Rooy · Answer

首先，你可能需要了解System.Text.Json中一个特别的设计：JSON中的null在运行时会被表示为.NET的null。

例如：

var json = "null";
var node = JsonNode.Parse(json);
Console.WriteLine(node is null); // 输出 True

明白了这一点，编译器的警告就会更加合理，同时帮助你决定何时使用null原谅操作符。

现在看看你的代码：

JsonNode node = nodeNullable ?? throw new Exception("null JSON value");

虽然这解决了编译器警告，但在运行时可能合理也可能不合理。如果输入像上面的例子那样是null怎么办？因此，你可以相应地调整这行代码：

如果你的代码绝不期望node为null，你可以抛出异常
如果你的输入绝不会是null，你可以使用!来原谅它

例如：

JsonNode node = JsonNode.Parse(jsonString)!;

记住，可空引用只是一个编译时的概念，在运行时没有意义。作为代码编写者，你比静态代码分析工具更了解输入情况。话虽如此，如果你决定原谅编译器的警告，而在运行时确实遇到了null，将会抛出NullReferenceException。

同样的理论也适用于你的另一行代码：

JsonNode? determinantNodeNullable = node["determinant"];

假设在这个上下文中，node是一个JsonObject（由Parse方法返回）。JsonObject本质上是Dictionary的一种变体。当你执行node["determinant"]时，它会在内部存储中查找属性节点，如果找不到或者节点值为null，node["determinant"]将返回null。

var json = "{\"prop\": null}";
var node = JsonNode.Parse(json)!;

var prop1 = node["foo"];
var prop2 = node["prop"];

// 两者都输出 True
Console.WriteLine(prop1 is null);
Console.WriteLine(prop2 is null);