Tipos com suporte no System.Text.Json

Este artigo fornece uma visão geral de quais tipos têm suporte para serialização e desserialização.

Tipos que serializam como objetos JSON

Os seguintes tipos são serializados como objetos JSON:

• Classes^*
• Structs
• Interfaces
• Registros e registros de struct

* Tipos que não são de dicionário que implementam IEnumerable<T> serializar como matrizes JSON. Tipos de dicionário, que implementam IEnumerable<T>, serializam como objetos JSON.

O snippet de código a seguir mostra a serialização de um struct simples.

public static void Main()
{
    var coordinates = new Coords(1.0, 2.0);
    string json = JsonSerializer.Serialize(coordinates);
    Console.WriteLine(json);

    // Output:
    // {"X":1,"Y":2}
}

public readonly struct Coords
{
    public Coords(double x, double y)
    {
        X = x;
        Y = y;
    }

    public double X { get; }
    public double Y { get; }
}

Tipos que serializam como matrizes JSON

Os tipos de coleção .NET são serializados como matrizes JSON. System.Text.Json.JsonSerializer dá suporte a um tipo de coleção para serialização se ele:

• Deriva de IEnumerable ou IAsyncEnumerable<T>.
• Contém elementos serializáveis.

O serializador chama o método GetEnumerator() e grava os elementos.

A desserialização é mais complicada e não tem suporte para alguns tipos de coleção.

As seções a seguir são organizadas por namespace e mostram quais tipos têm suporte para serialização e desserialização.

• do namespace System.Array
• do namespace System.Collections
• namespace System.Collections.Generic
• namespace System.Collections.Immutable
• de namespace System.Collections.Specialized
• namespace System.Collections.Concurrent
• namespace System.Collections.ObjectModel
• coleções personalizadas

Namespace System.Array

Namespace System.Collections

* Consulte suporte de ida e volta para tipos de Stack.

Namespace System.Collections.Generic

* Consulte tipos de chave com suporte.

† Consulte a seção a seguir no IAsyncEnumerable<T>.

‡ Consulte Suporte de ida e volta para tipos de Stack.

IAsyncEnumerable<T>

Os exemplos a seguir usam fluxos como uma representação de qualquer fonte assíncrona de dados. A origem pode ser arquivos em um computador local ou resultados de uma consulta de banco de dados ou chamada à API do serviço Web.

Serialização de fluxo

System.Text.Json dá suporte à serialização de valores IAsyncEnumerable<T> como matrizes JSON, conforme mostrado no exemplo a seguir:

using System.Text.Json;

namespace IAsyncEnumerableSerialize;

public class Program
{
    public static async Task Main()
    {
        using Stream stream = Console.OpenStandardOutput();
        var data = new { Data = PrintNumbers(3) };
        await JsonSerializer.SerializeAsync(stream, data);
    }

    static async IAsyncEnumerable<int> PrintNumbers(int n)
    {
        for (int i = 0; i < n; i++)
        {
            await Task.Delay(1000);
            yield return i;
        }
    }
}
// output:
//  {"Data":[0,1,2]}

IAsyncEnumerable<T> valores têm suporte apenas pelos métodos de serialização assíncronos, como JsonSerializer.SerializeAsync.

Desserialização de fluxo

O método DeserializeAsyncEnumerable dá suporte à desserialização de streaming, conforme mostrado no exemplo a seguir:

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

namespace IAsyncEnumerableDeserialize;

public class Program
{
    public static async Task Main()
    {
        using var stream = new MemoryStream(Encoding.UTF8.GetBytes("[0,1,2,3,4]"));
        await foreach (int item in JsonSerializer.DeserializeAsyncEnumerable<int>(stream))
        {
            Console.WriteLine(item);
        }
    }
}
// output:
//0
//1
//2
//3
//4

O método DeserializeAsyncEnumerable dá suporte apenas à leitura de matrizes JSON de nível raiz.

O método DeserializeAsync dá suporte a IAsyncEnumerable<T>, mas sua assinatura não permite streaming. Ele retorna o resultado final como um único valor, conforme mostrado no exemplo a seguir.

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

namespace IAsyncEnumerableDeserializeNonStreaming;

public class MyPoco
{
    public IAsyncEnumerable<int>? Data { get; set; }
}

public class Program
{
    public static async Task Main()
    {
        using var stream = new MemoryStream(Encoding.UTF8.GetBytes(@"{""Data"":[0,1,2,3,4]}"));
        MyPoco? result = await JsonSerializer.DeserializeAsync<MyPoco>(stream)!;
        await foreach (int item in result!.Data!)
        {
            Console.WriteLine(item);
        }
    }
}
// output:
//0
//1
//2
//3
//4

Neste exemplo, o desserializador armazena todos os buffers IAsyncEnumerable<T> conteúdo na memória antes de retornar o objeto desserializado. Esse comportamento é necessário porque o desserializador precisa ler todo o conteúdo JSON antes de retornar um resultado.

Namespace System.Collections.Immutable

* Consulte suporte de ida e volta para tipos de Stack.

† Consulte tipos de chave com suporte.

Namespace System.Collections.Specialized

* Quando BitVector32 é desserializada, a propriedade Data é ignorada porque não tem um setter público. Nenhuma exceção é gerada.

Namespace System.Collections.Concurrent

* Consulte suporte de ida e volta para tipos de Stack.

† Consulte tipos de chave com suporte.

Namespace System.Collections.ObjectModel

* Não há suporte para chaves nãostring.

Coleções personalizadas

Qualquer tipo de coleção que não esteja em um dos namespaces anteriores é considerado uma coleção personalizada. Esses tipos incluem tipos e tipos definidos pelo usuário definidos pelo ASP.NET Core. Por exemplo, Microsoft.Extensions.Primitives está nesse grupo.

Todas as coleções personalizadas (tudo o que deriva de IEnumerable) têm suporte para serialização, desde que haja suporte para seus tipos de elementos.

Suporte à desserialização

Uma coleção personalizada terá suporte para desserialização se ela:

• Não é uma interface ou abstrata.

• Tem um construtor sem parâmetros.

• Contém tipos de elementos compatíveis com JsonSerializer.

• Implementa ou herda uma ou mais das seguintes interfaces ou classes:

  • ConcurrentQueue<T>
  • ConcurrentStack<T> *
  • ICollection<T>
  • IDictionary
  • IDictionary<TKey,TValue> †
  • IList
  • IList<T>
  • Queue
  • Queue<T>
  • Stack *
  • Stack<T> *

  * Consulte suporte de ida e volta para tipos de Stack.

  † Consulte tipos de chave com suporte.

Problemas conhecidos

Há problemas conhecidos com as seguintes coleções personalizadas:

• ExpandoObject: consulte dotnet/runtime#29690.
• DynamicObject: consulte dotnet/runtime#1808.
• DataTable: consulte dotnet/docs#21366.
• Microsoft.AspNetCore.Http.FormFile: consulte dotnet/runtime#1559.
• Microsoft.AspNetCore.Http.IFormCollection: consulte dotnet/runtime#1559.

Para obter mais informações sobre problemas conhecidos, consulte o problemas abertos no System.Text.Json.

Tipos de chave com suporte

Quando usadas como chaves de tipos Dictionary e SortedList, os seguintes tipos têm suporte interno:

• Boolean
• Byte
• DateTime
• DateTimeOffset
• Decimal
• Double
• Enum
• Guid
• Int16
• Int32
• Int64
• Object (somente na serialização e se o tipo de runtime for um dos tipos com suporte nesta lista).)
• SByte
• Single
• String
• TimeSpan
• UInt16
• UInt32
• UInt64
• Uri
• Version

Além disso, os métodos JsonConverter<T>.WriteAsPropertyName(Utf8JsonWriter, T, JsonSerializerOptions) e JsonConverter<T>.ReadAsPropertyName(Utf8JsonReader, Type, JsonSerializerOptions) permitem adicionar suporte à chave de dicionário para qualquer tipo de sua escolha.

Tipos sem suporte

Não há suporte para os seguintes tipos para serialização:

• System.Type e System.Reflection.MemberInfo
• ReadOnlySpan<T>, Span<T>e estruturas ref em geral
• Tipos de delegado
• IntPtr e UIntPtr

Namespace System.Data

Não há conversores internos para DataSet, DataTablee tipos relacionados no namespace System.Data. Desserializar esses tipos de entrada não confiável não é seguro, conforme explicado em as diretrizes de segurança. No entanto, você pode escrever um conversor personalizado para dar suporte a esses tipos. Para obter um código de conversor personalizado de exemplo que serializa e desserializa um DataTable, consulte RoundtripDataTable.cs.

Consulte também

• Preencher propriedades inicializadas
• visão geral System.Text.Json
• System.Text.Json de referência da API
• System.Text.Json. Referência da API de serialização