Podporované typy kolekcí v System.Text.Json
Tento článek poskytuje přehled o tom, které kolekce jsou podporovány pro serializaci a deserializaci. System.Text.Json.JsonSerializer podporuje typ kolekce pro serializaci, pokud:
- Odvozeno od IEnumerable nebo IAsyncEnumerable<T>
- Obsahuje prvky, které jsou serializovatelné.
Serializátor volá metodu GetEnumerator() a zapisuje prvky.
Deserializace je složitější a u některých typů kolekcí se nepodporuje.
Následující části jsou uspořádány podle oboru názvů a ukazují, které typy jsou podporovány pro serializaci a deserializaci.
Obor názvů System.Array
Typ | Serializace | Rekonstrukci |
---|---|---|
Jednorozměrná pole | ✔️ | ✔️ |
Vícerozměrná pole | ❌ | ❌ |
Jagged arrays | ✔️ | ✔️ |
System.Collections – obor názvů
Typ | Serializace | Rekonstrukci |
---|---|---|
ArrayList | ✔️ | ✔️ |
BitArray | ✔️ | ❌ |
DictionaryEntry | ✔️ | ✔️ |
Hashtable | ✔️ | ✔️ |
ICollection | ✔️ | ✔️ |
IDictionary | ✔️ | ✔️ |
IEnumerable | ✔️ | ✔️ |
IList | ✔️ | ✔️ |
Queue | ✔️ | ✔️ |
SortedList | ✔️ | ✔️ |
Stack * | ✔️ | ✔️ |
* Viz podpora zpáteční cesty pro Stack
typy.
System.Collections.Generic – obor názvů
Typ | Serializace | Rekonstrukci |
---|---|---|
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> ‡ | ✔️ | ✔️ |
* Viz podporované typy klíčů.
† Viz následující část .IAsyncEnumerable<T>
– Viz podpora zpáteční cesty pro Stack
typy.
IAsyncEnumerable<T>
Následující příklady používají streamy jako reprezentaci libovolného asynchronního zdroje dat. Zdrojem můžou být soubory na místním počítači nebo výsledky z databázového dotazu nebo volání rozhraní API webové služby.
Serializace streamu
System.Text.Json
podporuje serializaci IAsyncEnumerable<T> hodnot jako pole JSON, jak je znázorněno v následujícím příkladu:
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>
hodnoty jsou podporovány pouze asynchronními serializačními metodami, například JsonSerializer.SerializeAsync.
Deserializace datových proudů
Metoda DeserializeAsyncEnumerable
podporuje deserializaci streamování, jak je znázorněno v následujícím příkladu:
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
Metoda DeserializeAsyncEnumerable
podporuje pouze čtení z polí JSON na kořenové úrovni.
Metoda DeserializeAsync podporuje IAsyncEnumerable<T>
, ale jeho podpis neumožňuje streamování. Vrátí konečný výsledek jako jednu hodnotu, jak je znázorněno v následujícím příkladu.
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
V tomto příkladu deserializátor vyrovnávací paměti veškerý IAsyncEnumerable<T>
obsah před vrácením deserializovaného objektu. Toto chování je nezbytné, protože deserializátor musí před vrácením výsledku přečíst celou datovou část JSON.
System.Collections.Immutable – obor názvů
Typ | Serializace | Rekonstrukci |
---|---|---|
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> * | ✔️ | ✔️ |
* Viz podpora zpáteční cesty pro Stack
typy.
† Viz podporované typy klíčů.
System.Collections.Specialized – obor názvů
Typ | Serializace | Rekonstrukci |
---|---|---|
BitVector32 | ✔️ | ❌* |
HybridDictionary | ✔️ | ✔️ |
IOrderedDictionary | ✔️ | ❌ |
ListDictionary | ✔️ | ✔️ |
NameValueCollection | ✔️ | ❌ |
StringCollection | ✔️ | ❌ |
StringDictionary | ✔️ | ❌ |
* Při BitVector32 deserializaci je vlastnost vynechána, Data protože nemá veřejnou setter. Žádná výjimka se nevyvolá.
System.Collections.Concurrent – obor názvů
Typ | Serializace | Rekonstrukci |
---|---|---|
BlockingCollection<T> | ✔️ | ❌ |
ConcurrentBag<T> | ✔️ | ❌ |
ConcurrentDictionary<TKey,TValue> † | ✔️ | ✔️ |
ConcurrentQueue<T> | ✔️ | ✔️ |
ConcurrentStack<T> * | ✔️ | ✔️ |
* Viz podpora zpáteční cesty pro Stack
typy.
† Viz podporované typy klíčů.
System.Collections.ObjectModel – obor názvů
Typ | Serializace | Rekonstrukci |
---|---|---|
Collection<T> | ✔️ | ✔️ |
Řetězec KeyedCollection<, TValue> * | ✔️ | ❌ |
ObservableCollection<T> | ✔️ | ✔️ |
ReadOnlyCollection<T> | ✔️ | ❌ |
ReadOnlyDictionary<TKey,TValue> | ✔️ | ❌ |
ReadOnlyObservableCollection<T> | ✔️ | ❌ |
* Jiné nežstring
klíče nejsou podporované.
Vlastní kolekce
Každý typ kolekce, který není v jednom z předchozích oborů názvů, se považuje za vlastní kolekci. Tyto typy zahrnují uživatelem definované typy a typy definované ASP.NET Core. Například Microsoft.Extensions.Primitives je v této skupině.
Všechny vlastní kolekce (vše, co je odvozeno IEnumerable
) jsou podporovány pro serializaci, pokud jsou podporovány jejich typy prvků.
Vlastní kolekce s podporou deserializace
Vlastní kolekce se podporuje pro deserializaci, pokud:
Není rozhraní ani abstraktní.
Má konstruktor bez parametrů.
Obsahuje typy prvků, které jsou podporovány JsonSerializer.
Implementuje nebo dědí jedno nebo více následujících rozhraní nebo tříd:
- ConcurrentQueue<T>
- ConcurrentStack<T> *
- ICollection<T>
- IDictionary
- IDictionary<TKey,TValue> †
- IList
- IList<T>
- Queue
- Queue<T>
- Stack *
- Stack<T> *
* Viz podpora zpáteční cesty pro
Stack
typy.† Viz podporované typy klíčů.
Vlastní kolekce se známými problémy
Existují známé problémy s následujícími vlastními kolekcemi:
- ExpandoObject: Viz dotnet/runtime#29690.
- DynamicObject: Viz dotnet/runtime#1808.
- DataTable: Viz dotnet/docs#21366.
- Microsoft.AspNetCore.Http.FormFile: Viz dotnet/runtime#1559.
- Microsoft.AspNetCore.Http.IFormCollection: Viz dotnet/runtime#1559.
Další informace o známých problémech naleznete v otevřených problémech v System.Text.Jsonsouboru .
Podporované typy klíčů
Mezi podporované typy klíčů Dictionary
a SortedList
typů patří:
Boolean
Byte
DateTime
DateTimeOffset
Decimal
Double
Enum
Guid
Int16
Int32
Int64
Object
(Pouze při serializaci a pokud je typ modulu runtime jedním z podporovaných typů v tomto seznamu.)SByte
Single
String
UInt16
UInt32
UInt64
System.Data – obor názvů
Neexistují žádné integrované převaděče pro DataSet, DataTablea související typy v System.Data oboru názvů. Deserializace těchto typů z nedůvěryhodného vstupu není bezpečná, jak je vysvětleno v doprovodných materiálech zabezpečení. Můžete však napsat vlastní převaděč pro podporu těchto typů. Vzorový kód vlastního převaděče, který serializuje a deserializuje a DataTable
, viz RoundtripDataTable.cs.
Viz také
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro