KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / C#

Utf8JsonReader — JSON-tokens uit UTF-8 lezen

Utf8JsonReader uit System.Text.Json leest UTF-8-gecodeerde JSON-bytes token voor token en uitsluitend vooruit. Zo kun je waarden selecteren zonder een documentboom op te bouwen of het document naar objecten te deserialiseren.

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

Syntax

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

Utf8JsonReader is een veranderlijke ref struct in System.Text.Json en is beschikbaar in .NET 10. De reader accepteert ReadOnlySpan<byte> of ReadOnlySequence<byte>. Hij bouwt geen documentboom op; de aanroepende code interpreteert zelf de opeenvolgende tokens en de JSON-structuur.

Read() gaat naar het volgende token en TokenType geeft het type ervan aan. Methoden zoals GetInt32() lezen de huidige waarde zonder de reader verder te zetten. Controleer het tokentype voordat je ze aanroept; een getal moet bovendien binnen het doeltype passen. ValueTextEquals() vergelijkt een naam of tekst met inachtneming van JSON-escape-sequenties, zonder een tussentijdse string te maken.

De reader kan niet worden opgeslagen in een klasseveld of worden behouden over een await-grens. Geef hem met ref door aan een hulpfunctie die de oorspronkelijke reader moet verplaatsen; een kopie heeft een onafhankelijke positie. Controleer bij invoer met meerdere segmenten HasValueSequence voordat je ValueSequence of ValueSpan kiest.

De constructor in het voorbeeld gaat uit van een volledig document. Gebruik bij invoer in blokken isFinalBlock, bewaar CurrentState en de niet-verbruikte bytes die door BytesConsumed worden aangegeven, en maak na het aanleveren van meer gegevens een nieuwe reader. De status bewaart die bytes niet zelf. Als Read() een JSON-syntaxisfout detecteert, werpt de methode een JsonException op. Toch kan de methode een tekenreeks tussen aanhalingstekens als token herkennen, ook als die ongeldige UTF-8-reeksen bevat. Bij het decoderen van dat token kan GetString() een InvalidOperationException opwerpen in plaats van een JsonException. Opmerkingen en afsluitende komma’s zijn standaard niet toegestaan.

Voorbeelden

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

Resultaat

25

De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.

Bronnen