快捷導(dǎo)航

C#中System.Text.Json匿名對(duì)象反序列化

更新時(shí)間：2023年05月25日 08:22:14 作者：波多爾斯基

這篇文章主要介紹了System.Text.Json匿名對(duì)象反序列化,下文代碼基于. NET 6，為了代碼整潔，實(shí)際配置了PropertyNameCaseInsensitive = true，本文結(jié)合實(shí)例代碼介紹的非常詳細(xì)，需要的朋友可以參考下

有時(shí)候我們會(huì)遇到的從第三方傳遞過來的 json string 對(duì)象，對(duì)其進(jìn)行解析并不需要所有的字段，只需要一個(gè)目標(biāo)的字段時(shí)，可以考慮使用匿名對(duì)象/動(dòng)態(tài)對(duì)象對(duì)其反序列化。

之前的 Newtonsoft.Json 好像直接使用 dynamic，運(yùn)用 JObject 進(jìn)行處理，現(xiàn)在的不是那么容易。下文代碼基于. NET 6，為了代碼整潔，實(shí)際配置了 PropertyNameCaseInsensitive = true，但是下面代碼中并沒有體現(xiàn)。

數(shù)據(jù)

我們定義了如下的類型，并從 OData 獲得了 str 字符串型數(shù)據(jù)。

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; }
    }

由于有元數(shù)據(jù)，我們無法直接將上面的字符串反序列化為 DataDto 的列表對(duì)象。

自定義類

最簡單的方式，是對(duì)應(yīng)此類對(duì)象，設(shè)計(jì)一個(gè)只用于反序列化的新類。

    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 來直接反序列化，并使用類似鍵值對(duì)的形式訪問。

    public static void Main() {
        JsonNode? meta = JsonSerializer.Deserialize<JsonNode>(str);
        //如果直接是簡單的對(duì)象，而不是數(shù)組，可以使用GetValue<T>這種形式。
        var count = meta?["value"]?.Deserialize<IEnumerable<DataDto>>().Count();
        Console.WriteLine(count);
    }
}

注意，這樣的操作和你反序列化為 JsonDocument/JsonElement 并沒有什么本質(zhì)的區(qū)別。

動(dòng)態(tài)方式

由于設(shè)計(jì)區(qū)別，直接使用 dynamic 進(jìn)行反序列化，得到的對(duì)象并不具有一般 dynamic 的性質(zhì)(實(shí)際上是 System.Text.Json.JsonElement 對(duì)象)。因此，我們無法通過的 dynamic 訪問成員的形式進(jìn)行操作。

dynamic meta = JsonSerializer.Deserialize<dynamic>(str);
Console.WriteLine(meta.GetType());
//OUTPUT: System.Text.Json.JsonElement

有文章說可以使用 ExpandoOject 實(shí)現(xiàn)，但是實(shí)際上無法對(duì)子級(jí)對(duì)象進(jìn)行類似的訪問，因?yàn)楂@取的子級(jí)對(duì)象，實(shí)際上是 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