Share via

Samlingstyper som stöds i System.Text.Json

  • Artikel

Den här artikeln ger en översikt över vilka samlingar som stöds för serialisering och deserialisering. System.Text.Json.JsonSerializer stöder en samlingstyp för serialisering om den:

Serialiseraren GetEnumerator() anropar metoden och skriver elementen.

Deserialisering är mer komplicerat och stöds inte för vissa samlingstyper.

Följande avsnitt ordnas efter namnområde och visar vilka typer som stöds för serialisering och deserialisering.

System.Array-namnområde

Typ Serialization Deserialisering
Endimensionella matriser ✔️ ✔️
Flerdimensionella matriser ❌ ❌
Ojämna matriser ✔️ ✔️

System.Collections-namnområde

Typ Serialization Deserialisering
ArrayList ✔️ ✔️
BitArray ✔️ ❌
DictionaryEntry ✔️ ✔️
Hashtable ✔️ ✔️
ICollection ✔️ ✔️
IDictionary ✔️ ✔️
IEnumerable ✔️ ✔️
IList ✔️ ✔️
Queue ✔️ ✔️
SortedList ✔️ ✔️
Stack * ✔️ ✔️

* Se Support tur och retur för Stack typer.

System.Collections.Generic-namnområde

Typ Serialization Deserialisering
Dictionary<TKey,TValue> * ✔️ ✔️
HashSet<T> ✔️ ✔️
IAsyncEnumerable<T> † ✔️ ✔️
ICollection<T> ✔️ ✔️
IDictionary<TKey,TValue> * ✔️ ✔️
IEnumerable<T> ✔️ ✔️
IList<T> ✔️ ✔️
IReadOnlyCollection<T> ✔️ ✔️
IReadOnlyDictionary<TKey,TValue> * ✔️ ✔️
IReadOnlyList<T> ✔️ ✔️
ISet<T> ✔️ ✔️
KeyValuePair<TKey,TValue> ✔️ ✔️
LinkedList<T> ✔️ ✔️
LinkedListNode<T> ✔️ ❌
List<T> ✔️ ✔️
Queue<T> ✔️ ✔️
SortedDictionary<TKey,TValue> * ✔️ ✔️
SortedList<TKey,TValue> * ✔️ ✔️
SortedSet<T> ✔️ ✔️
Stack<T> ‡ ✔️ ✔️

* Se Nyckeltyper som stöds.

† Se följande avsnitt på IAsyncEnumerable<T>.

‡ Se Support tur och retur för Stack typer.

IAsyncEnumerable<T>

I följande exempel används strömmar som en representation av alla asynkrona datakällor. Källan kan vara filer på en lokal dator eller resultat från en databasfråga eller ett API-anrop för webbtjänsten.

Stream-serialisering

System.Text.Json stöder serialiseringsvärden IAsyncEnumerable<T> som JSON-matriser, enligt följande exempel:

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> -värden stöds endast av asynkrona serialiseringsmetoder, till exempel JsonSerializer.SerializeAsync.

Stream-deserialisering

Metoden DeserializeAsyncEnumerable stöder strömmande deserialisering, som du ser i följande exempel:

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

Metoden DeserializeAsyncEnumerable stöder endast läsning från JSON-matriser på rotnivå.

Metoden DeserializeAsync stöder IAsyncEnumerable<T>, men signaturen tillåter inte strömning. Det returnerar slutresultatet som ett enda värde, som du ser i följande exempel.

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

I det här exemplet buffrar deserialiseraren allt IAsyncEnumerable<T> innehåll i minnet innan det deserialiserade objektet returneras. Det här beteendet är nödvändigt eftersom deserialiseraren måste läsa hela JSON-nyttolasten innan resultatet returneras.

System.Collections.Oföränderligt namnområde

Typ Serialization Deserialisering
IImmutableDictionary<TKey,TValue> † ✔️ ✔️
IImmutableList<T> ✔️ ✔️
IImmutableQueue<T> ✔️ ✔️
IImmutableSet<T> ✔️ ✔️
IImmutableStack<T> * ✔️ ✔️
ImmutableArray<T> ✔️ ✔️
ImmutableDictionary<TKey,TValue> † ✔️ ✔️
ImmutableHashSet<T> ✔️ ✔️
ImmutableQueue<T> ✔️ ✔️
ImmutableSortedDictionary<TKey,TValue> † ✔️ ✔️
ImmutableSortedSet<T> ✔️ ✔️
ImmutableStack<T> * ✔️ ✔️

* Se Support tur och retur för Stack typer.

† Se nyckeltyper som stöds.

System.Collections.Specialized namespace

Typ Serialization Deserialisering
BitVector32 ✔️ ❌*
HybridDictionary ✔️ ✔️
IOrderedDictionary ✔️ ❌
ListDictionary ✔️ ✔️
NameValueCollection ✔️ ❌
StringCollection ✔️ ❌
StringDictionary ✔️ ❌

* När BitVector32 är deserialiserad Data hoppas egenskapen över eftersom den inte har någon offentlig setter. Det utlöses inget undantag.

System.Collections.Concurrent-namnområde

Typ Serialization Deserialisering
BlockingCollection<T> ✔️ ❌
ConcurrentBag<T> ✔️ ❌
ConcurrentDictionary<TKey,TValue> † ✔️ ✔️
ConcurrentQueue<T> ✔️ ✔️
ConcurrentStack<T> * ✔️ ✔️

* Se Support tur och retur för Stack typer.

† Se nyckeltyper som stöds.

System.Collections.ObjectModel-namnrymd

Typ Serialization Deserialisering
Collection<T> ✔️ ✔️
KeyedCollection-sträng<, TValue> * ✔️ ❌
ObservableCollection<T> ✔️ ✔️
ReadOnlyCollection<T> ✔️ ❌
ReadOnlyDictionary<TKey,TValue> ✔️ ❌
ReadOnlyObservableCollection<T> ✔️ ❌

* Icke-nycklarstring stöds inte.

Anpassade samlingar

Alla samlingstyper som inte finns i någon av de föregående namnrymderna anses vara en anpassad samling. Sådana typer omfattar användardefinierade typer och typer som definieras av ASP.NET Core. Till exempel Microsoft.Extensions.Primitives finns i den här gruppen.

Alla anpassade samlingar (allt som härleds från IEnumerable) stöds för serialisering, så länge deras elementtyper stöds.

Anpassade samlingar med stöd för deserialisering

En anpassad samling stöds för deserialisering om den:

Anpassade samlingar med kända problem

Det finns kända problem med följande anpassade samlingar:

Mer information om kända problem finns i öppna problem i System.Text.Json.

Nyckeltyper som stöds

Följande typer stöds Dictionary för nycklar och SortedList typer:

  • Boolean
  • Byte
  • DateTime
  • DateTimeOffset
  • Decimal
  • Double
  • Enum
  • Guid
  • Int16
  • Int32
  • Int64
  • Object (Endast vid serialisering och om körningstypen är en av de typer som stöds i den här listan.)
  • SByte
  • Single
  • String
  • UInt16
  • UInt32
  • UInt64

System.Data-namnrymd

Det finns inga inbyggda konverterare för DataSet, DataTableoch relaterade typer i System.Data namnområdet. Det är inte säkert att deserialisera dessa typer från ej betrodda indata, enligt beskrivningen i säkerhetsvägledningen. Du kan dock skriva en anpassad konverterare för att stödja dessa typer. Exempel på anpassad konverterarkod som serialiserar och deserialiserar en DataTablefinns i RoundtripDataTable.cs.

Se även