CKTIS / C#
Dvosmjerni JSON pretvornik: čitanje, pisanje i provjera tokena
Izradi pretvornik System.Text.Json koji čita i zapisuje jedan JSON objekt, odbija nevaljane tokene te izričito primjenjuje camelCase i izostavljanje vrijednosti null.
Verzija: C# 12 and .NET 8; later runtimes may add compatible features
Sintaksa
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.").U C# 12 i .NET 8 JsonConverter<T> iz prostora imena System.Text.Json.Serialization definira oba smjera pretvorbe. Registriraj ga u options.Converters. Utf8JsonReader, Utf8JsonWriter, JsonTokenType i JsonException pripadaju prostoru imena System.Text.Json. Čitač kroz UTF-8 ulaz ide samo naprijed. To je promjenjivi ref struct: proslijedi ga s ref kako bi pomicao izvorni pokazivač položaja, a ne kopiju, i ne spremaj ga u polje klase.
Metoda Read pretvornika počinje na prvom tokenu vrijednosti. Za objekt provjeri StartObject, pročitaj svojstva i vrati se s pokazivačem na odgovarajućem EndObject, a ne iza njega. Isto pravilo vrijedi za nizove; kod skalarne vrijednosti ostani na njezinu tokenu. reader.TokenType vraća član enumeracije JsonTokenType; provjeri ga prije dohvaćanja vrijednosti. Number ne jamči da broj stane u int, pa upotrijebi TryGetInt32. Za nekompatibilan ulaz baci JsonException; serijalizator može popuniti Path, LineNumber i BytePositionInLine. Prerani završetak čitanja ili čitanje iza kraja vrijednosti također može izazvati JsonException.
Write zapisuje točno jednu potpunu vrijednost proslijeđenim Utf8JsonWriter; na njemu ne pozivaj Dispose ni Flush. Serijalizator primjenjuje PropertyNamingPolicy = JsonNamingPolicy.CamelCase i DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull na svojstva kojima sam upravlja, a ne na ručne pozive zapisivača. Primjer izračunava ista imena u oba smjera i izostavlja cijela svojstva s vrijednošću null samo uz WhenWritingNull; 0 se i dalje zapisuje. Razlikuje velika i mala slova, odbija nepoznata i ponovljena imena te implementira pravila izostavljanja Never i WhenWritingNull, a ne sve postavke serijalizatora.
string? je oznaka za analizu vrijednosti null u prevoditelju, a ne novi tip tijekom izvršavanja ni provjera JSON-a. int? je zaseban vrijednosni tip Nullable<int> koji predstavlja cijeli broj ili odsutnost vrijednosti. Serijalizator prema zadanim postavkama obrađuje vrijednosti null za referentne tipove i Nullable<T> bez pozivanja njihova pretvornika. Ako ih treba obraditi sam pretvornik, nadjačaj HandleNull tako da vraća true. Izostavljanje svojstava zasebno je pravilo: WhenWritingNull utječe samo na pisanje, a ugovor određuje dopušta li čitanje izostavljena svojstva ili izričiti JSON null. Ovdje su oba oblika dopuštena za Note i Rank, ali ne za DisplayName.
Primjeri
#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();
}
}Rezultat
{"displayName":"Ada"}
{"displayName":"Ada","note":null,"rank":null}
{"displayName":"Ada","rank":0}
Rejected: JsonExceptionPrvi redak izostavlja oba svojstva s vrijednošću null, drugi oba zapisuje kao null, a treći nakon čitanja zadržava vrijednost 0 za rank. Broj umjesto teksta u displayName izaziva JsonException.
Povezane lekcije
- C# · Lekcija 39 · Napredno · Verzija: 3
Izvori
- 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