是否可以在 System.Text.Json 中找到未映射的属性？

Question

是否可以使用 System.Text.Json.JsonSerializer 找到未映射的属性？

我正在访问一个 API，其中 returns 一组文档。我想知道是否有办法知道是否 json 文档中有一个属性未被我的 C# 类型映射。充其量是一种 returns 未映射属性列表的方法。

例子

JSON 文档

{
    "docs": [
        {
            "foo": "a",
            "bar": "b",
            "baz": "c",
        }
    ]
}

C# 类型

public class Wrapper 
{
    [JsonPropertyName("docs")]
    public List<MyDocument> Documents { get; set; }
}

public class MyDocument 
{
    [JsonPropertyName("foo")]
    public string Foo { get; set; }

    [JsonPropertyName("baz")]
    public string Baz { get; set; }
}

解析器

using System.Text.Json;

var body = "{ ... }";
var documents = JsonSerializer.Deserialize<Documents>(body);

List<JsonElement> unmappedProperties 
    = JsonSerializer.FindUnmappedProperties<Document>(body);

Answer 1

您可以使用 [JsonExtensionData]，例如：

public class MyDocument 
{
    [JsonPropertyName("foo")]
    public string Foo { get; set; }

    [JsonPropertyName("baz")]
    public string Baz { get; set; }

    [JsonExtensionData]
    public Dictionary<string, object> ExtensionData { get; set; }
}

属性“bar”将序列化为ExtensionData属性。

您需要 .NET Core 3+ 或 .NET 5+（或 .NET framework 4.6.1 / NET Standard 2.0，见几米评论）

见How to handle overflow JSON with System.Text.Json

要查找所有未映射的属性，您需要将属性和 [JsonExtensionData] 添加到所有已序列化的类。您还需要遍历它（可能需要反射）。有点麻烦，但是很管用

是否可以在 System.Text.Json 中找到未映射的属性？

Is it possible to find unmapped properties in System.Text.Json?

c#

jsonserializer

system.text.json

例子