Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / C#

Utf8JsonWriter — sekvenčný zápis JSON v UTF-8

Utf8JsonWriter z System.Text.Json umožňuje ručne zapisovať JSON ako bajty UTF-8 do Streamu alebo IBufferWriter<byte>. Určujete poradie vlastností aj štruktúru dokumentu, zatiaľ čo writer sa stará o syntax JSON a escapovanie reťazcov.

Verzia: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Syntax

using var writer = new Utf8JsonWriter(destination, new JsonWriterOptions { Indented = false });
writer.WriteStartObject();
writer.WriteString("name", "Ada");
writer.WriteEndObject();
writer.Flush();

Utf8JsonWriter v priestore názvov System.Text.Json je nízkoúrovňový mechanizmus na sekvenčný zápis JSON ako bajtov UTF-8 do Stream alebo IBufferWriter<byte>. Namiesto automatickej serializácie celého objektu zapisujete jeho vlastnosti a hodnoty výslovne. Hodí sa pri tvorbe vlastných serializátorov, ale nejde o upraviteľný strom dokumentu.

Volania WriteStartObject() a WriteEndObject() vymedzujú objekt. WriteString("name", "Ada") zapisuje dvojicu názov-hodnota, zatiaľ čo WriteStringValue("csharp") zapisuje iba hodnotu, napríklad prvok poľa. WriteStartArray("tags") začne vlastnosť poľa, ktorú uzavrie WriteEndArray(). Metódy na zápis reťazcov zabezpečujú potrebné escapovanie — JSON nevytvárajte spájaním textu.

Predvolene je výstup kompaktný a štrukturálna validácia je zapnutá; neplatná postupnosť operácií môže spôsobiť InvalidOperationException. JsonWriterOptions umožňuje nastaviť okrem iného Indented a SkipValidation. Vypnutím validácie prechádza zodpovednosť za správnu štruktúru na volajúci kód.

Pred čítaním výsledku zavolajte Flush(), aby sa čakajúce bajty odovzdali do cieľa. Nenahrádza to uzavretie objektov a polí príslušnými metódami. Na uvoľnenie writeru použite using. V príklade prevádza Encoding.UTF8.GetString(...) zapísané bajty na text iba na zobrazenie. Použité API sú dostupné v .NET 10 a nevyžadujú jazykové funkcie vo verzii preview.

Príklady

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

using var stream = new MemoryStream();
using var writer = new Utf8JsonWriter(stream);

writer.WriteStartObject();
writer.WriteString("name", "Ada");
writer.WriteNumber("score", 42);
writer.WriteStartArray("tags");
writer.WriteStringValue("csharp");
writer.WriteStringValue("json");
writer.WriteEndArray();
writer.WriteEndObject();
writer.Flush();

Console.WriteLine(Encoding.UTF8.GetString(stream.ToArray()));

Výsledok

{"name":"Ada","score":42,"tags":["csharp","json"]}

Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tejto presnej verzie.

Zdroje