База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / C#

Потребителски JSON конвертори: граници на стойностите, грешки и инвариантно форматиране

Създайте конвертор, който чете и записва точно една JSON стойност, отхвърля несъвместими входни данни и отделя инвариантното форматиране на текст от JSON кодирането.

Версия: C# 12 and .NET 8; later runtimes may add compatible features

Синтаксис

// 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}")

В C# 12 и .NET 8 JsonConverter<T> от System.Text.Json.Serialization определя как се чете и записва една стойност от тип T. Utf8JsonReader, Utf8JsonWriter, JsonTokenType и JsonException са в System.Text.Json. Четецът преминава само напред през JSON токените в UTF-8; TokenType показва вида на токена чрез стойност от изброимия тип JsonTokenType. Number не е същото като String, съдържащ цифри.

При влизане в Read четецът е на първия токен на стойността. За скалар върнете резултат без извикване на reader.Read(); за обект или масив спрете на съответния EndObject или EndArray. Преждевременното спиране или четенето отвъд края на стойността нарушава договора. Четецът е изменяем ref struct: подайте го с ref, ако извикващият код трябва да види придвижването му. В C# 12 не го декларирайте като локална променлива в метод async и не използвайте изгледи към байтовете на токените след връщане на буфера им в пула.

Проверете за Number преди TryGetInt32(out int value): за друг вид токен методът хвърля InvalidOperationException, а за число, което не може да прочете като int, връща false. || пропуска десния операнд, ако левият е истина. За несъвместими входни данни хвърлете JsonException; сериализаторът може да попълни Path, LineNumber и BytePositionInLine. По подразбиране при четене конвертор за стойностен тип, който не допуска null, получава Null; при референтни типове и Nullable<T> сериализаторът обикновено обработва null сам, освен ако конверторът зададе HandleNull на true.

Write записва точно една стойност чрез подадения записващ обект, без да го освобождава. WriteNumberValue(int) записва число без кавички. WriteStringValue(string?) записва низ, който не е null, в кавички и екранира специалните знаци според правилата на JSON. Ако аргументът е null, методът записва JSON литерала null без кавички. Не сглобявайте JSON чрез интерполация и не изключвайте проверките, за да пропуснете ненадеждни входни данни.

System.FormattableString.Invariant(FormattableString) връща string с аргументи, форматирани според инвариантната култура. Подайте интерполацията направо или я запазете като FormattableString; вече форматиран string не може да се преформатира така. F1 дава един знак след десетичния разделител, тук 12.5. Това е форматиране на текст, а не JSON сериализация или екраниране.

Примери

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

Резултат

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

`Tenths` съхранява температурата в десети от градуса. Двата елемента проверяват границата при четене; цифрите в кавички, препълването и `null` се отхвърлят. Изрично зададеният формат със запетая дава `temperature=12,5`, а инвариантният — `temperature=12.5`. JSON остава `[125,-35]`.

Свързани уроци

  • C# · Урок 58 · Напреднало · Версия: 3

Източници