Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / C#

Utf8JsonWriter — zaporedno zapisovanje JSON-a v UTF-8

Utf8JsonWriter iz System.Text.Json omogoča ročno zapisovanje JSON-a kot bajtov UTF-8 v Stream ali IBufferWriter<byte>. Nadziraš vrstni red lastnosti in strukturo dokumenta, writer pa poskrbi za sintakso JSON-a in ubežne znake v nizih.

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

Sintaksa

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

Utf8JsonWriter v imenskem prostoru System.Text.Json je nizkonivojski mehanizem za zaporedno zapisovanje JSON-a kot bajtov UTF-8 v Stream ali IBufferWriter<byte>. Namesto samodejne serializacije celotnega objekta njegove lastnosti in vrednosti zapišeš izrecno. Uporaben je pri ustvarjanju lastnih serializatorjev, ni pa urejevalno drevo dokumenta.

Klica WriteStartObject() in WriteEndObject() omejita objekt. WriteString("name", "Ada") zapiše par ime-vrednost, medtem ko WriteStringValue("csharp") zapiše samo vrednost, na primer element polja. WriteStartArray("tags") začne lastnost polja, ki jo zaključi WriteEndArray(). Metode za zapis nizov poskrbijo za potrebno ubežno zapisovanje — JSON-a ne sestavljaj z združevanjem besedila.

Privzeto je izhod zgoščen, preverjanje strukture pa je omogočeno; neveljavno zaporedje operacij lahko povzroči InvalidOperationException. JsonWriterOptions omogoča nastavitev možnosti, kot sta Indented in SkipValidation. Če preverjanje onemogočiš, za pravilno strukturo odgovarja koda, ki writer kliče.

Pred branjem rezultata pokliči Flush(), da se čakajoči bajti prenesejo na cilj. To ne nadomesti zapiranja objektov in polj z ustreznimi metodami. Za sprostitev writerja uporabi using. V primeru Encoding.UTF8.GetString(...) pretvori zapisane bajte v besedilo izključno za prikaz. Uporabljeni API-ji so na voljo v .NET 10 in ne zahtevajo jezikovnih funkcij v različici preview.

Primeri

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()));

Rezultat

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

Prikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.

Viri