CKTIS / C#
Prilagođeni pretvarači za JSON: granice vrijednosti, pogreške i invarijantno oblikovanje
Napišite pretvarač koji čita i zapisuje točno jednu vrijednost JSON-a, odbija nekompatibilan unos i odvaja invarijantno oblikovanje teksta od kodiranja JSON-a.
Verzija: 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}")U C# 12 i .NET 8 JsonConverter<T> iz System.Text.Json.Serialization određuje kako čitati i zapisivati jednu vrijednost tipa T. Utf8JsonReader, Utf8JsonWriter, JsonTokenType i JsonException nalaze se u System.Text.Json. Čitač prolazi kroz UTF-8 tokene JSON-a samo unaprijed; TokenType označava vrstu tokena vrijednošću enumeracije JsonTokenType. Number nije isto što i String koji sadrži znamenke.
Na ulasku u Read čitač je na prvom tokenu vrijednosti. Za skalarnu vrijednost vratite rezultat bez poziva reader.Read(); za objekt ili polje stanite na odgovarajućem EndObject ili EndArray. Prerano zaustavljanje ili čitanje preko granice vrijednosti krši ugovor. Čitač je promjenjivi ref struct: proslijedite ga uz ref ako pozivatelj mora vidjeti njegov napredak. U C# 12 nemojte ga deklarirati kao lokalnu varijablu u metodi async ni koristiti poglede na bajtove tokena nakon vraćanja njihova međuspremnika u spremište za ponovnu uporabu.
Provjerite Number prije TryGetInt32(out int value): za drugu vrstu tokena metoda baca InvalidOperationException, a za broj koji ne može pročitati kao int vraća false. || preskače desni operand ako je lijevi istinit. Za nekompatibilan unos bacite JsonException; serijalizator može popuniti Path, LineNumber i BytePositionInLine. Pretvarač vrijednosnog tipa koji ne dopušta null pri čitanju zadano dobiva Null; za referentne tipove i Nullable<T> serijalizator u pravilu sam obrađuje null, osim ako pretvarač postavi HandleNull na true.
Write zapisuje točno jednu vrijednost predanim zapisivačem i ne oslobađa ga. WriteNumberValue(int) zapisuje broj bez navodnika. WriteStringValue(string?) zapisuje niz znakova koji nije null u navodnicima i primjenjuje pravila izbjegavanja znakova u JSON-u. Ako je argument null, zapisuje literal null bez navodnika. Ne sastavljajte JSON interpolacijom niti isključujte provjeru valjanosti kako bi nepouzdan unos prošao.
System.FormattableString.Invariant(FormattableString) vraća string s argumentima oblikovanima prema invarijantnoj kulturi. Interpolaciju proslijedite izravno ili je zadržite kao FormattableString; već oblikovani string ne možete tako preoblikovati. F1 daje jedno decimalno mjesto, ovdje 12.5. To je oblikovanje teksta, a ne serijalizacija ili izbjegavanje znakova u JSON-u.
Primjeri
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` čuva temperaturu u desetinkama stupnja. Dva elementa ispituju granicu čitanja; znamenke u navodnicima, prekoračenje raspona i `null` odbijaju se. Izričit format sa zarezom daje `temperature=12,5`, a invarijantni `temperature=12.5`. JSON ostaje `[125,-35]`.
Povezane lekcije
- C# · Lekcija 58 · Napredno · Verzija: 3
Izvori
- How to write custom converters for JSON serialization
- How to use Utf8JsonReader in System.Text.Json
- Utf8JsonWriter Class (System.Text.Json)
- JsonTokenType Enum (System.Text.Json)
- Utf8JsonReader.TryGetInt32(Int32) Method (System.Text.Json)
- JsonException Class (System.Text.Json)
- FormattableString.Invariant(FormattableString) Method (System)
- String interpolation using $
- ref structure types (C# reference)
- How to use Utf8JsonWriter in System.Text.Json
- NumberFormatInfo Class (System.Globalization)