System.Text.Json匿名对象反序列化

以前就是一直使用 Newtonsoft.Json 用起来还是挺舒服的。由于 JSON 的应用越来越广，现在. NET Core 都内置了 System.Text.Json 可以直接对 JSON 进行操作，不过两个东西的体验依然有点区别。

有时候我们会遇到的从第三方传递过来的 json string 对象，对其进行解析并不需要所有的字段，只需要一个目标的字段时，可以考虑使用匿名对象/动态对象对其反序列化。

之前的 Newtonsoft.Json 好像直接使用 dynamic，运用 JObject 进行处理，现在的不是那么容易。下文代码基于. NET 6，为了代码整洁，实际配置了 PropertyNameCaseInsensitive = true，但是下面代码中并没有体现。

数据

我们定义了如下的类型，并从 OData 获得了 str 字符串型数据。

	public readonly static string str = """

        {"@odata.context":"http://localhost:9000/api/v1/$metadata#DataDto","value":[{"id":"0b734ed7-2955-4af4-a902-35dc17871094","timestamp":1684839865920},{"id":"7e285d08-cdb3-4209-8335-0ff9b20d39ef","timestamp":1684836312421}]}

        """;

    public class DataDto

    {

        public string? Id { get; set; }

        public long Timestamp { get; set; }

    }

由于有元数据，我们无法直接将上面的字符串反序列化为 DataDto 的列表对象。

自定义类

最简单的方式，是对应此类对象，设计一个只用于反序列化的新类。

    public class ODataEnumerableResultWrapper<T>

        where T : class

    {

        public IEnumerable<T> Value { get; set; }

    }

	var meta = JsonSerializer.Deserialize<ODataEnumerableResultWrapper<DataDto>>(str);

	var target = meta.Value;

匿名方式

可以使用 JsonNode 来直接反序列化，并使用类似键值对的形式访问。

    public static void Main() {

        JsonNode? meta = JsonSerializer.Deserialize<JsonNode>(str);

        //如果直接是简单的对象，而不是数组，可以使用GetValue<T>这种形式。

        var count = meta?["value"]?.Deserialize<IEnumerable<DataDto>>().Count();

        Console.WriteLine(count);

    }

}

注意，这样的操作和你反序列化为 JsonDocument/JsonElement 并没有什么本质的区别。

动态方式

由于设计区别，直接使用 dynamic 进行反序列化，得到的对象并不具有一般 dynamic 的性质(实际上是 System.Text.Json.JsonElement 对象)。因此，我们无法通过的 dynamic 访问成员的形式进行操作。

dynamic meta = JsonSerializer.Deserialize<dynamic>(str);

Console.WriteLine(meta.GetType());

//OUTPUT: System.Text.Json.JsonElement

有文章说可以使用 ExpandoOject 实现，但是实际上无法对子级对象进行类似的访问，因为获取的子级对象，实际上是 JsonElement。

        dynamic meta = JsonSerializer.Deserialize<System.Dynamic.ExpandoObject>(str);

        Console.WriteLine(meta.GetType());

        //System.Dynamic.ExpandoObject

        Console.WriteLine(meta.value);

        //[{"id":"0b734ed7-2955-4af4-a902-35dc17871094","timestamp":1684839865920},{"id":"7e285d08-cdb3-4209-8335-0ff9b20d39ef","timestamp":1684836312421}]

        Console.WriteLine(meta.value.GetType());

        //System.Text.Json.JsonElement

当然可以通过自定义序列化的方式操作（见参考），但是这个办法与我们的不写额外代码的初衷相冲突，因此不考虑了。

参考

c# - Is it possible to deserialize json string into dynamic object using System.Text.Json? - Stack Overflow