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

CKTIS / C#

Pretvorniki JSON po meri: meje vrednosti, napake in invariantno oblikovanje

Napišite pretvornik, ki prebere in zapiše natanko eno vrednost JSON, zavrne nezdružljive podatke in loči invariantno oblikovanje besedila od kodiranja JSON.

Različica: C# 12 and .NET 8; later runtimes may add compatible features

Sintaksa

// C# 12 / .NET 8 — override signatures inside a JsonConverter<T> subclass
using System;
using System.Text.Json;
using System.Text.Json.Serialization;

public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options)

// Typical expressions inside method bodies:
reader.TokenType == JsonTokenType.Number
reader.TryGetInt32(out int value)
throw new JsonException("Expected an Int32 JSON number.");
writer.WriteNumberValue(value);
FormattableString.Invariant($"temperature={value / 10m:F1}")

V C# 12 in .NET 8 JsonConverter<T> iz System.Text.Json.Serialization določa, kako prebrati in zapisati eno vrednost tipa T. Utf8JsonReader, Utf8JsonWriter, JsonTokenType in JsonException so v System.Text.Json. Bralnik se po žetonih JSON v UTF-8 pomika samo naprej; TokenType pove vrsto žetona z vrednostjo naštevanja JsonTokenType. Number ni isto kot String, ki vsebuje števke.

Ob vstopu v Read je bralnik na prvem žetonu vrednosti. Pri skalarju vrnite rezultat brez klica reader.Read(); pri objektu ali tabeli se ustavite na pripadajočem EndObject ali EndArray. Prezgodnja ustavitev ali branje čez mejo vrednosti krši pogodbo. Bralnik je spremenljiv ref struct: podajte ga z ref, kadar mora klicatelj videti njegov napredek. V C# 12 ga ne deklarirajte kot lokalno spremenljivko v metodi async in ne uporabljajte pogledov na bajte žetonov po vrnitvi njihovega medpomnilnika v zalogo.

Pred TryGetInt32(out int value) preverite Number: za druge vrste žetonov metoda sproži InvalidOperationException; če števila ne more prebrati kot int, vrne false. || ne ovrednoti desnega operanda, če je levi resničen. Za nezdružljive podatke sprožite JsonException; serializator lahko izpolni Path, LineNumber in BytePositionInLine. Pri branju pretvornik za vrednostni tip, ki ne dopušča null, privzeto prejme Null; pri referenčnih tipih in Nullable<T> serializator navadno sam obravnava null, razen če pretvornik nastavi HandleNull na true.

Write s podanim zapisovalnikom zapiše natanko eno vrednost, ne da bi zapisovalnik sprostil. WriteNumberValue(int) zapiše število brez narekovajev. WriteStringValue(string?) zapiše niz, ki ni null, v narekovajih in uporabi ubežne znake v skladu s pravili JSON. Če je argument null, zapiše literal JSON null brez narekovajev. Ne sestavljajte JSON z interpolacijo in ne izklapljajte preverjanja, da bi prepustili nezaupanja vredne podatke.

System.FormattableString.Invariant(FormattableString) vrne string z argumenti, oblikovanimi po invariantni kulturi. Interpolacijo podajte neposredno ali jo shranite kot FormattableString; že oblikovanega string tako ne morete preoblikovati. F1 da eno decimalno mesto, tukaj 12.5. To je oblikovanje besedila, ne serializacija JSON ali ubežno kodiranje.

Primeri

using System;
using System.Globalization;
using System.Text.Json;
using System.Text.Json.Serialization;

var options = new JsonSerializerOptions();
options.Converters.Add(new TenthsConverter());

Tenths[] values = JsonSerializer.Deserialize<Tenths[]>("[125,-35]", options)!;
Console.WriteLine(JsonSerializer.Serialize(values, options));

FormattableString text = $"temperature={values[0].Value / 10m:F1}";
var commaFormat = new NumberFormatInfo { NumberDecimalSeparator = "," };
Console.WriteLine(text.ToString(commaFormat));
Console.WriteLine(FormattableString.Invariant(text));

foreach (string bad in new[] { "\"125\"", "2147483648", "null" })
{
    try
    {
        _ = JsonSerializer.Deserialize<Tenths>(bad, options);
        throw new InvalidOperationException("Expected JsonException.");
    }
    catch (JsonException)
    {
        Console.WriteLine($"rejected: {bad}");
    }
}

readonly record struct Tenths(int Value);

sealed class TenthsConverter : JsonConverter<Tenths>
{
    public override Tenths Read(ref Utf8JsonReader reader, Type typeToConvert,
        JsonSerializerOptions options)
    {
        if (reader.TokenType != JsonTokenType.Number || !reader.TryGetInt32(out int value))
            throw new JsonException("Expected an Int32 JSON number.");

        return new Tenths(value);
    }

    public override void Write(Utf8JsonWriter writer, Tenths value,
        JsonSerializerOptions options) => writer.WriteNumberValue(value.Value);
}

Rezultat

[125,-35]
temperature=12,5
temperature=12.5
rejected: "125"
rejected: 2147483648
rejected: null

`Tenths` hrani temperaturo v desetinah stopinje. Dva elementa preverita mejo branja; števke v narekovajih, prekoračitev obsega in `null` se zavrnejo. Izrecna oblika z vejico da `temperature=12,5`, invariantna oblika pa `temperature=12.5`. JSON ostane `[125,-35]`.

Povezane lekcije

  • C# · Lekcija 58 · Napredna · Različica: 3

Viri