CKTIS / C#
Obousměrný převodník JSON: čtení, zápis a ověřování tokenů
Vytvoř převodník System.Text.Json, který čte a zapisuje jeden objekt JSON, odmítá neplatné tokeny a výslovně uplatňuje názvy v camelCase a vynechávání hodnot null.
Verze: C# 12 and .NET 8; later runtimes may add compatible features
Syntaxe
using System.Text.Json;
using System.Text.Json.Serialization;
// Members of JsonConverter<T>:
public abstract T? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options);
public abstract void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options);
// Inspect reader.TokenType (a JsonTokenType) before reading a value.
// Reject incompatible input with new JsonException("Expected a JSON string.").V C# 12 a .NET 8 definuje JsonConverter<T> z System.Text.Json.Serialization oba směry převodu. Zaregistruj ho v options.Converters. Utf8JsonReader, Utf8JsonWriter, JsonTokenType a JsonException patří do System.Text.Json. Čtečka prochází vstup v UTF-8 pouze vpřed. Je to měnitelný ref struct: předávej ho pomocí ref, aby se posouval původní kurzor, a ne jeho kopie. Neukládej ho do pole třídy.
Metoda Read převodníku začíná na prvním tokenu hodnoty. U objektu ověř StartObject, přečti vlastnosti a vrať se s kurzorem na odpovídajícím EndObject, ne za ním. Stejné pravidlo platí pro pole; u skalární hodnoty zůstaň na jejím tokenu. reader.TokenType vrací člena výčtu JsonTokenType; ověř ho před získáním hodnoty. Number nezaručuje, že číslo lze uložit do int, proto použij TryGetInt32. Pro nekompatibilní vstup vyvolej JsonException; serializátor může doplnit Path, LineNumber a BytePositionInLine. Předčasné ukončení čtení i čtení za konec hodnoty může také vyvolat JsonException.
Write zapíše právě jednu úplnou hodnotu předaným Utf8JsonWriter; nevolej na něm Dispose ani Flush. Serializátor uplatňuje PropertyNamingPolicy = JsonNamingPolicy.CamelCase a DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull na vlastnosti, které spravuje sám, nikoli na ruční volání zapisovače. Příklad odvozuje stejné názvy v obou směrech a vynechává celé vlastnosti s hodnotou null jen při WhenWritingNull; 0 se zapíše. Rozlišuje velikost písmen, odmítá neznámé a duplicitní názvy a implementuje pravidla vynechávání Never a WhenWritingNull, ne všechna nastavení serializátoru.
string? je anotace pro analýzu hodnot null překladačem, ne nový běhový typ ani ověření JSON. int? je odlišný hodnotový typ Nullable<int>, který reprezentuje celé číslo nebo nepřítomnost hodnoty. Serializátor standardně zpracovává hodnoty null pro referenční typy a Nullable<T> bez volání jejich převodníku. Má-li je zpracovat sám převodník, přepiš HandleNull tak, aby vracelo true. Vynechávání vlastností je samostatná věc: WhenWritingNull působí jen při zápisu a kontrakt určuje, zda čtení připouští chybějící vlastnosti nebo výslovné JSON null. Zde jsou obě formy povolené pro Note a Rank, ale ne pro DisplayName.
Příklady
#nullable enable
using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Text.Json.Serialization;
var options = new JsonSerializerOptions
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
};
options.Converters.Add(new ProfileCardConverter());
var card = new ProfileCard("Ada", null, null);
Console.WriteLine(JsonSerializer.Serialize(card, options));
var keepNulls = new JsonSerializerOptions(options)
{
DefaultIgnoreCondition = JsonIgnoreCondition.Never
};
Console.WriteLine(JsonSerializer.Serialize(card, keepNulls));
var read = JsonSerializer.Deserialize<ProfileCard>(
"""{"displayName":"Ada","note":null,"rank":0}""", options)
?? throw new JsonException("Expected a non-null profile card.");
Console.WriteLine(JsonSerializer.Serialize(read, options));
try
{
_ = JsonSerializer.Deserialize<ProfileCard>("""{"displayName":42}""", options);
}
catch (JsonException)
{
Console.WriteLine("Rejected: JsonException");
}
sealed record ProfileCard(string DisplayName, string? Note, int? Rank);
sealed class ProfileCardConverter : JsonConverter<ProfileCard>
{
private static string Name(JsonSerializerOptions options, string clrName) =>
options.PropertyNamingPolicy?.ConvertName(clrName) ?? clrName;
public override ProfileCard Read(ref Utf8JsonReader reader, Type typeToConvert,
JsonSerializerOptions options)
{
if (reader.TokenType != JsonTokenType.StartObject)
throw new JsonException("Expected an object.");
string displayNameKey = Name(options, nameof(ProfileCard.DisplayName));
string noteKey = Name(options, nameof(ProfileCard.Note));
string rankKey = Name(options, nameof(ProfileCard.Rank));
var seen = new HashSet<string>(StringComparer.Ordinal);
string? displayName = null;
string? note = null;
int? rank = null;
while (reader.Read())
{
if (reader.TokenType == JsonTokenType.EndObject)
return new ProfileCard(
displayName ?? throw new JsonException("Missing display name."), note, rank);
if (reader.TokenType != JsonTokenType.PropertyName)
throw new JsonException("Expected a property name.");
string key = reader.GetString() ?? throw new JsonException("Missing property name.");
if (!seen.Add(key))
throw new JsonException("Duplicate property.");
if (!reader.Read())
throw new JsonException("Missing property value.");
if (key == displayNameKey && reader.TokenType == JsonTokenType.String)
displayName = reader.GetString();
else if (key == noteKey && reader.TokenType is JsonTokenType.String or JsonTokenType.Null)
note = reader.GetString();
else if (key == rankKey && reader.TokenType == JsonTokenType.Null)
rank = null;
else if (key == rankKey && reader.TokenType == JsonTokenType.Number &&
reader.TryGetInt32(out int number))
rank = number;
else
throw new JsonException("Unknown property or invalid value.");
}
throw new JsonException("Expected the end of the object.");
}
public override void Write(Utf8JsonWriter writer, ProfileCard value, JsonSerializerOptions options)
{
bool omitNulls = options.DefaultIgnoreCondition == JsonIgnoreCondition.WhenWritingNull;
writer.WriteStartObject();
writer.WriteString(Name(options, nameof(ProfileCard.DisplayName)), value.DisplayName);
if (value.Note is not null || !omitNulls)
writer.WriteString(Name(options, nameof(ProfileCard.Note)), value.Note);
if (value.Rank is int rank)
writer.WriteNumber(Name(options, nameof(ProfileCard.Rank)), rank);
else if (!omitNulls)
writer.WriteNull(Name(options, nameof(ProfileCard.Rank)));
writer.WriteEndObject();
}
}Výsledek
{"displayName":"Ada"}
{"displayName":"Ada","note":null,"rank":null}
{"displayName":"Ada","rank":0}
Rejected: JsonExceptionPrvní řádek vynechá obě vlastnosti s hodnotou null, druhý je obě zapíše jako null a třetí po přečtení zachová hodnotu rank rovnou 0. Číslo místo textu v displayName vyvolá JsonException.
Související lekce
- C# · Lekce 39 · Pokročilá · Verze: 3
Zdroje
- How to write custom converters for JSON serialization
- How to use Utf8JsonReader in System.Text.Json
- Utf8JsonWriter Class
- JsonTokenType Enum
- JsonException Class
- How to customize property names and values with System.Text.Json
- How to ignore properties with System.Text.Json
- Nullable reference types
- Nullable value types