CKTIS / C#
Dwukierunkowy konwerter JSON: odczyt, zapis i walidacja tokenów
Napisz konwerter System.Text.Json, który odczytuje i zapisuje jeden obiekt JSON, odrzuca nieprawidłowe tokeny oraz jawnie stosuje camelCase i regułę pomijania wartości null.
Wersja: C# 12 and .NET 8; later runtimes may add compatible features
Składnia
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.").W C# 12 i .NET 8 JsonConverter<T> z System.Text.Json.Serialization definiuje obie strony konwersji. Zarejestruj go w options.Converters. Typy Utf8JsonReader, Utf8JsonWriter, JsonTokenType i JsonException należą do System.Text.Json. Czytnik przesuwa się tylko do przodu po danych UTF-8. Jest mutowalnym ref struct: przekaż go przez ref, aby nie przesuwać kopii kursora; nie przechowuj go w polu klasy.
Read konwertera zaczyna na pierwszym tokenie wartości. Dla obiektu sprawdź StartObject, odczytaj właściwości i wróć z kursorem na odpowiadającym mu EndObject, nie za nim. Dla tablicy stosuj tę samą zasadę, a dla wartości skalarnej pozostań na jej tokenie. reader.TokenType zwraca element wyliczenia JsonTokenType; sprawdź go przed wywołaniem metody odczytującej wartość. Number nie gwarantuje, że liczba mieści się w int, więc użyj TryGetInt32. Przy niezgodnych danych zgłoś JsonException; serializator może uzupełnić Path, LineNumber i BytePositionInLine. Odczyt za krótki lub za daleki także może skończyć się JsonException.
Write zapisuje dokładnie jedną kompletną wartość przez dostarczony Utf8JsonWriter; nie zwalnia go ani nie opróżnia jego bufora. Serializator stosuje PropertyNamingPolicy = JsonNamingPolicy.CamelCase i DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull do właściwości, którymi sam zarządza, ale nie do ręcznych wywołań writera. Przykład jawnie wyznacza te same nazwy w obu kierunkach i pomija całe właściwości o wartości null tylko przy WhenWritingNull; 0 pozostaje w JSON. Porównuje nazwy z rozróżnianiem wielkości liter, odrzuca nieznane i powtórzone nazwy oraz obsługuje reguły pomijania Never i WhenWritingNull, a nie wszystkie możliwe ustawienia serializatora.
string? to adnotacja dla analizy null w kompilatorze, nie nowy typ wykonawczy ani walidacja JSON. int? to odrębny typ wartościowy Nullable<int>, reprezentujący liczbę albo brak wartości. Domyślnie serializator obsługuje null dla typów referencyjnych i Nullable<T> bez wywoływania ich konwertera; aby konwerter sam je obsłużył, nadpisz HandleNull tak, by zwracało true. To osobna kwestia od pomijania właściwości: WhenWritingNull dotyczy zapisu, a akceptowanie brakujących właściwości lub jawnego JSON null podczas odczytu zależy od kontraktu. Tutaj obie postacie są dozwolone dla Note i Rank, lecz nie dla DisplayName.
Przykłady
#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();
}
}Wynik
{"displayName":"Ada"}
{"displayName":"Ada","note":null,"rank":null}
{"displayName":"Ada","rank":0}
Rejected: JsonExceptionPierwsza linia pomija obie właściwości o wartości null, druga zapisuje obie jako null, a trzecia po odczycie zachowuje rank równy 0. Liczba zamiast tekstu w displayName powoduje JsonException.
Powiązane lekcje
- C# · Lekcja 39 · Zaawansowany · Wersja: 3
Źródła
- 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