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

CKTIS / C#

Utf8JsonReader – branje žetonov JSON iz UTF-8

Utf8JsonReader iz System.Text.Json bere bajte JSON v kodiranju UTF-8 po en žeton naenkrat in samo naprej. Omogoča izbiro potrebnih vrednosti brez gradnje drevesa dokumenta ali deserializacije dokumenta v objekte.

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

Sintaksa

var reader = new Utf8JsonReader(utf8Json);
while (reader.Read())
{
    // Inspect reader.TokenType and read the current token's value.
}

Utf8JsonReader je spremenljiv ref struct iz System.Text.Json, na voljo v .NET 10. Sprejme ReadOnlySpan<byte> ali ReadOnlySequence<byte>. Ne zgradi drevesa dokumenta; koda, ki ga kliče, sama razlaga zaporedne žetone in strukturo JSON.

Read() se premakne na naslednji žeton, TokenType pa določa njegovo vrsto. Metode, kot je GetInt32(), preberejo trenutno vrednost, ne da bi premaknile bralnik. Pred klicem preverite vrsto žetona; tudi število mora ustrezati ciljnemu tipu. ValueTextEquals() primerja ime ali besedilo ob upoštevanju ubežnih zaporedij JSON, ne da bi ustvaril vmesni string.

Bralnika ni mogoče shraniti v polje razreda ali ga ohraniti čez mejo await. Funkciji za pomoč, ki mora premakniti izvirni bralnik, ga posredujte z ref; kopija ima neodvisen položaj. Pri večdelnem vhodu preverite HasValueSequence, preden izberete ValueSequence ali ValueSpan.

Konstruktor v primeru predpostavlja celoten dokument. Pri vhodu po delih uporabite isFinalBlock, ohranite CurrentState in neporabljene bajte, ki jih označuje BytesConsumed, nato pa po prejemu dodatnih podatkov ustvarite nov bralnik. Samo stanje teh bajtov ne hrani. Ko Read() zazna skladenjsko napako v zapisu JSON, sproži izjemo JsonException. Vendar lahko niz v narekovajih prepozna kot žeton, tudi če niz vsebuje neveljavna zaporedja UTF-8. Pri dekodiranju takega žetona lahko GetString() sproži izjemo InvalidOperationException namesto JsonException. Komentarji in zaključne vejice privzeto niso dovoljeni.

Primeri

using System;
using System.Text.Json;

ReadOnlySpan<byte> json = "{\"name\":\"Ada\",\"age\":25}"u8;
var reader = new Utf8JsonReader(json);

while (reader.Read())
{
    if (reader.TokenType == JsonTokenType.PropertyName &&
        reader.ValueTextEquals("age"u8))
    {
        if (!reader.Read() || reader.TokenType != JsonTokenType.Number)
            throw new JsonException("Expected a number.");

        Console.WriteLine(reader.GetInt32());
    }
}

Rezultat

25

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

Viri