CKTIS / C#
Двупосочен JSON конвертор: четене, запис и проверка на токени
Създай конвертор за System.Text.Json, който чете и записва един JSON обект, отхвърля невалидни токени и изрично прилага camelCase и пропускане на стойности null.
Версия: C# 12 and .NET 8; later runtimes may add compatible features
Синтаксис
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.").В C# 12 и .NET 8 JsonConverter<T> от System.Text.Json.Serialization определя и двете посоки на преобразуване. Регистрирай го в options.Converters. Utf8JsonReader, Utf8JsonWriter, JsonTokenType и JsonException са в System.Text.Json. Четецът се движи само напред през входните данни в UTF-8. Той е изменяем ref struct: предавай го чрез ref, за да преместваш оригиналния курсор, а не копие, и не го съхранявай в поле на клас.
Методът Read на конвертора започва върху първия токен на стойността. За обект провери StartObject, прочети свойствата и завърши с курсор върху съответстващия EndObject, не след него. Същото правило важи за масивите; при скаларна стойност остани върху нейния токен. reader.TokenType връща елемент от изброимия тип JsonTokenType; провери го, преди да извлечеш стойността. Number не гарантира, че числото може да се представи като int, затова използвай TryGetInt32. При несъвместим вход хвърли JsonException; сериализаторът може да попълни Path, LineNumber и BytePositionInLine. Преждевременното прекратяване на четенето или преминаването отвъд края на стойността също може да доведе до JsonException.
Write записва точно една завършена стойност чрез предоставения Utf8JsonWriter; не извиквай неговите Dispose или Flush. Сериализаторът прилага PropertyNamingPolicy = JsonNamingPolicy.CamelCase и DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull към свойствата, които управлява, а не към ръчните извиквания на записващия обект. Примерът изчислява едни и същи имена в двете посоки и пропуска изцяло свойствата със стойност null само при WhenWritingNull; 0 се записва. Той различава главни и малки букви, отхвърля непознати и повторени имена и реализира правилата за пропускане Never и WhenWritingNull, а не всички настройки на сериализатора.
string? е анотация за анализа на стойности null от компилатора, а не нов тип по време на изпълнение или проверка на JSON. int? е отделният стойностен тип Nullable<int>, който представя цяло число или липса на стойност. По подразбиране сериализаторът обработва стойностите null за референтни типове и Nullable<T>, без да извиква конвертора им. Ако конверторът трябва да ги обработва сам, предефинирай HandleNull, така че да връща true. Пропускането на свойства е отделно правило: WhenWritingNull действа само при запис, а договорът определя дали при четене са допустими липсващи свойства или изрично JSON null. Тук и двете форми са допустими за Note и Rank, но не и за DisplayName.
Примери
#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();
}
}Резултат
{"displayName":"Ada"}
{"displayName":"Ada","note":null,"rank":null}
{"displayName":"Ada","rank":0}
Rejected: JsonExceptionПървият ред пропуска и двете свойства със стойност null, вторият ги записва като null, а третият запазва rank със стойност 0 след прочитането. Число вместо текст в displayName предизвиква JsonException.
Свързани уроци
- C# · Урок 39 · Напреднало · Версия: 3
Източници
- 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