Compartilhar via

Como lidar com o JSON de estouro ou usar JsonElement ou JsonNode

  • Artigo

Este artigo mostra como lidar com o JSON de estouro com o namespace System.Text.Json. Ele também mostra como desserializar em JsonElement ou JsonNode, como uma alternativa a outros cenários em que o tipo de destino pode não corresponder perfeitamente a todo o JSON que está sendo desserializado.

Manipular JSON de estouro

Ao desserializar, você pode receber dados no JSON que não são representados por propriedades do tipo de destino. Por exemplo, suponha que seu tipo de destino seja o seguinte:

public class WeatherForecast
{
    public DateTimeOffset Date { get; set; }
    public int TemperatureCelsius { get; set; }
    public string? Summary { get; set; }
}

Public Class WeatherForecast
    Public Property [Date] As DateTimeOffset
    Public Property TemperatureCelsius As Integer
    Public Property Summary As String
End Class

E o JSON a ser desserializado seja o seguinte:

{
  "Date": "2019-08-01T00:00:00-07:00",
  "temperatureCelsius": 25,
  "Summary": "Hot",
  "DatesAvailable": [
    "2019-08-01T00:00:00-07:00",
    "2019-08-02T00:00:00-07:00"
  ],
  "SummaryWords": [
    "Cool",
    "Windy",
    "Humid"
  ]
}

Se você desserializar o JSON mostrado no tipo mostrado, as propriedades DatesAvailable e SummaryWords não terão para onde ir e serão perdidas. Para capturar dados extras, como essas propriedades, aplique o atributo [JsonExtensionData] a uma propriedade do tipo Dictionary<string,object> ou Dictionary<string,JsonElement>:

public class WeatherForecastWithExtensionData
{
    public DateTimeOffset Date { get; set; }
    public int TemperatureCelsius { get; set; }
    public string? Summary { get; set; }
    [JsonExtensionData]
    public Dictionary<string, JsonElement>? ExtensionData { get; set; }
}

Public Class WeatherForecastWithExtensionData
    Public Property [Date] As DateTimeOffset
    Public Property TemperatureCelsius As Integer
    Public Property Summary As String

    <JsonExtensionData>
    Public Property ExtensionData As Dictionary(Of String, Object)

End Class

A tabela a seguir mostra o resultado da desserialização do JSON mostrado anteriormente neste tipo de exemplo. Os dados extras se tornam pares chave-valor da propriedade ExtensionData:

Propriedade Valor Observações
Date "8/1/2019 12:00:00 AM -07:00"
TemperatureCelsius 0 Incompatibilidade de diferenciação de maiúsculas de minúsculas (temperatureCelsius no JSON), portanto, a propriedade não é definida.
Summary "Hot"
ExtensionData "temperatureCelsius": 25,
"DatesAvailable": ["2019-08-01T00:00:00-07:00","2019-08-02T00:00:00-07:00"],
"SummaryWords": ["Cool","Windy","Humid"]		 Como as maiúsculas e minúsculas não eram iguais, temperatureCelsius é um extra e se torna um par chave-valor no dicionário.
Cada matriz extra do JSON se torna um par chave-valor, com uma matriz como o objeto de valor.

Quando o objeto de destino é serializado, os pares de valor da chave de dados de extensão se tornam propriedades JSON exatamente como estavam no JSON de entrada:

{
  "Date": "2019-08-01T00:00:00-07:00",
  "TemperatureCelsius": 0,
  "Summary": "Hot",
  "temperatureCelsius": 25,
  "DatesAvailable": [
    "2019-08-01T00:00:00-07:00",
    "2019-08-02T00:00:00-07:00"
  ],
  "SummaryWords": [
    "Cool",
    "Windy",
    "Humid"
  ]
}

Observe que o nome da propriedade ExtensionData não aparece no JSON. Esse comportamento permite que o JSON faça uma viagem de ida e volta sem perder dados extras que, de outra forma, não seriam desserializados.

O seguinte exemplo mostra uma viagem de ida e volta do JSON para um objeto desserializado e de volta para JSON:

using System.Text.Json;
using System.Text.Json.Serialization;

namespace RoundtripExtensionData
{
    public class WeatherForecast
    {
        public DateTimeOffset Date { get; set; }
        public int TemperatureCelsius { get; set; }
        public string? Summary { get; set; }
        [JsonExtensionData]
        public Dictionary<string, JsonElement>? ExtensionData { get; set; }
    }

    public class Program
    {
        public static void Main()
        {
            string jsonString =
@"{
  ""Date"": ""2019-08-01T00:00:00-07:00"",
  ""temperatureCelsius"": 25,
  ""Summary"": ""Hot"",
  ""SummaryField"": ""Hot"",
  ""DatesAvailable"": [
    ""2019-08-01T00:00:00-07:00"",
    ""2019-08-02T00:00:00-07:00""
  ],
  ""SummaryWords"": [
    ""Cool"",
    ""Windy"",
    ""Humid""
  ]
}";
            WeatherForecast weatherForecast = 
                JsonSerializer.Deserialize<WeatherForecast>(jsonString)!;

            var serializeOptions = new JsonSerializerOptions { WriteIndented = true };
            jsonString = JsonSerializer.Serialize(weatherForecast, serializeOptions);
            Console.WriteLine($"JSON output:\n{jsonString}\n");
        }
    }
}
// output:
//JSON output:
//{
//  "Date": "2019-08-01T00:00:00-07:00",
//  "TemperatureCelsius": 0,
//  "Summary": "Hot",
//  "temperatureCelsius": 25,
//  "SummaryField": "Hot",
//  "DatesAvailable": [
//    "2019-08-01T00:00:00-07:00",
//    "2019-08-02T00:00:00-07:00"
//  ],
//  "SummaryWords": [
//    "Cool",
//    "Windy",
//    "Humid"
//  ]
//}

Desserializar em JsonElement ou JsonNode

Se você quiser apenas ser flexível sobre qual JSON é aceitável para uma propriedade específica, uma alternativa é desserializar em JsonElement ou JsonNode. Qualquer propriedade JSON válida pode ser desserializada em JsonElement ou JsonNode. Escolha JsonElement para criar um objeto imutável, ou JsonNode para criar um objeto mutável.

O exemplo a seguir mostra uma viagem de ida e volta do JSON e de volta para JSON para uma classe que inclui propriedades do tipo JsonElement e JsonNode.

using System.Text.Json;
using System.Text.Json.Nodes;

namespace RoundtripJsonElementAndNode
{
    public class WeatherForecast
    {
        public DateTimeOffset Date { get; set; }
        public int TemperatureCelsius { get; set; }
        public string? Summary { get; set; }
        public JsonElement DatesAvailable { get; set; }
        public JsonNode? SummaryWords { get; set; }
    }
        public class Program
    {
        public static void Main()
        {
            string jsonString =
@"{
  ""Date"": ""2019-08-01T00:00:00-07:00"",
  ""TemperatureCelsius"": 25,
  ""Summary"": ""Hot"",
  ""DatesAvailable"": [
    ""2019-08-01T00:00:00-07:00"",
    ""2019-08-02T00:00:00-07:00""
  ],
  ""SummaryWords"": [
    ""Cool"",
    ""Windy"",
    ""Humid""
  ]
}";
            WeatherForecast? weatherForecast = 
                JsonSerializer.Deserialize<WeatherForecast>(jsonString);

            var serializeOptions = new JsonSerializerOptions { WriteIndented = true };
            jsonString = JsonSerializer.Serialize(weatherForecast, serializeOptions);
            Console.WriteLine(jsonString);
        }
    }
}
// output:
//{
//  "Date": "2019-08-01T00:00:00-07:00",
//  "TemperatureCelsius": 25,
//  "Summary": "Hot",
//  "DatesAvailable": [
//    "2019-08-01T00:00:00-07:00",
//    "2019-08-02T00:00:00-07:00"
//  ],
//  "SummaryWords": [
//    "Cool",
//    "Windy",
//    "Humid"
//  ]
//}

Confira também