处理 .NET 8.0 中 JSON 解析时的尾部逗号问题

在 .NET 8.0 中使用 System.Text.Json 解析 JSON 数据时，开发者可能会遇到一个常见问题：当 JSON 对象中包含尾部逗号时，默认配置下解析会失败并抛出 JsonException 异常。这个问题在实际开发中经常出现，因为许多开发者习惯在 JSON 的最后一项后面添加逗号以提高代码的可维护性。

问题现象

当尝试解析包含尾部逗号的 JSON 字符串时，例如：

{
    "name": "John",
    "age": 30,
}

System.Text.Json 会抛出以下异常：

System.Text.Json.JsonException: The JSON object contains a trailing comma at the end which is not supported in this mode. Change the reader options.

解决方案

方法一：移除尾部逗号

最简单的解决方案是确保 JSON 字符串中没有尾部逗号。修改后的 JSON 应该是：

{
    "name": "John",
    "age": 30
}

方法二：配置 JsonSerializerOptions 允许尾部逗号

如果无法控制 JSON 数据的来源，或者希望保持更宽松的解析策略，可以配置 JsonSerializerOptions 来允许尾部逗号：

var options = new JsonSerializerOptions
{
    AllowTrailingCommas = true
};

var person = JsonSerializer.Deserialize<Person>(jsonString, options);

技术背景

System.Text.Json 默认严格遵循 JSON 规范，而 JSON 规范(RFC 8259)确实不允许对象或数组中的尾部逗号。这种严格性有助于确保数据的准确性和一致性，但有时也会带来不便。

允许尾部逗号的配置选项 AllowTrailingCommas 是在 .NET Core 3.0 中引入的，它为开发者提供了更灵活的 JSON 处理方式。这个选项不仅影响对象中的尾部逗号，也影响数组中的尾部逗号。

最佳实践

1. 数据生成端：尽量生成严格符合规范的 JSON，避免使用尾部逗号
2. 数据消费端：对于不可控的数据源，考虑启用 AllowTrailingCommas 选项
3. API 设计：在公共 API 中保持一致性，要么始终允许尾部逗号，要么始终禁止

性能考虑

启用 AllowTrailingCommas 选项会带来极小的性能开销，因为解析器需要额外检查可能的尾部逗号。对于大多数应用场景，这种开销可以忽略不计。

兼容性说明

AllowTrailingCommas 选项在以下版本中可用：

• .NET Core 3.0 及以上
• .NET 5 及以上
• .NET Standard 2.1

对于更早版本的 .NET，需要使用第三方 JSON 库如 Newtonsoft.Json 来处理尾部逗号问题。