Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / C#

JsonSerializerOptions — konfiguracija branja in zapisovanja JSON

System.Text.Json.JsonSerializerOptions določa pretvorbo objektov .NET v JSON in branje iz JSON. Z njim lahko nastavite imena lastnosti, komentarje, neznane lastnosti, obravnavo števil in izpuščanje vrednosti null. Primerek nastavite pred prvo uporabo in ga nato znova uporabljajte.

Različica: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Sintaksa

var options = new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase, ReadCommentHandling = JsonCommentHandling.Skip, UnmappedMemberHandling = JsonUnmappedMemberHandling.Disallow, NumberHandling = JsonNumberHandling.AllowReadingFromString, DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull };
var value = JsonSerializer.Deserialize<T>(json, options);
string result = JsonSerializer.Serialize(value, options);

System.Text.Json.JsonSerializerOptions zagotavlja konfiguracijo za JsonSerializer.Serialize in JsonSerializer.Deserialize. Primer je namenjen za .NET 10; UnmappedMemberHandling je na voljo od .NET 8. Jezikovna funkcija v predogledni različici ni potrebna. Preprost new JsonSerializerOptions() ohrani imena lastnosti, pri branju razlikuje med velikimi in malimi črkami ter uporablja strogo obravnavo števil; privzete nastavitve spletnih aplikacij so lahko drugačne.

JsonNamingPolicy predstavlja pravilo za pretvorbo imen. PropertyNamingPolicy = JsonNamingPolicy.CamelCase pri pisanju in branju pretvori ItemCount v itemCount. S tem ne omogočite primerjave brez razlikovanja velikih in malih črk; za to uporabite PropertyNameCaseInsensitive. Atribut [JsonPropertyName] ima prednost pred pravilom.

ReadCommentHandling uporablja JsonCommentHandling: privzeta vrednost Disallow zavrne komentarje, medtem ko jih Skip sprejme in prezre. Vrednost Allow, namenjena bralniku, s to možnostjo serializatorja ni podprta. UnmappedMemberHandling uporablja JsonUnmappedMemberHandling: privzeta vrednost Skip prezre lastnosti JSON brez ustreznega člana v tipu, razen če se zajamejo kot razširitveni podatki. Če za tip velja Disallow, lastnost JSON brez ustreznega člana sproži izjemo JsonException. Konfiguracija za posamezen tip ima lahko prednost pred nastavitvijo v možnostih serializatorja. Če je Disallow nastavljeno samo v možnostih, lahko član z atributom [JsonExtensionData] zajame lastnosti brez ustreznega člana, ne da bi se sprožila izjema. Ta nastavitev ne zahteva, da so v vhodnih podatkih prisotne vse lastnosti modela.

NumberHandling uporablja zastavice JsonNumberHandling. Privzeta vrednost Strict zahteva številske žetone; AllowReadingFromString omogoča tudi branje "3" kot števila, vendar ga še vedno zapiše kot 3. Ločena zastavica WriteAsString zapiše števila v narekovajih. DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull pri zapisovanju izpusti lastnosti z vrednostjo null; ne izpusti 0 ali false in ne preprečuje branja null.

Možnosti konfigurirajte pred prvim serializiranjem ali deserializiranjem: nato primerek postane nespremenljiv. Znova ga uporabljajte, da ohranite predpomnilnike metapodatkov; souporaba med nitmi je varna. Primer preskoči komentar, prebere število v narekovajih in zapiše objekt brez Note. Pri deserializiranju tipa Payload iz primera bi lastnost JSON brez ustreznega člana sprožila izjemo JsonException.

Primeri

#nullable enable
using System;
using System.Text.Json;
using System.Text.Json.Serialization;

var options = new JsonSerializerOptions
{
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
    ReadCommentHandling = JsonCommentHandling.Skip,
    UnmappedMemberHandling = JsonUnmappedMemberHandling.Disallow,
    NumberHandling = JsonNumberHandling.AllowReadingFromString,
    DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
};

const string json = "{ /* input */ \"itemCount\": \"3\", \"note\": null }";
var value = JsonSerializer.Deserialize<Payload>(json, options)
    ?? throw new InvalidOperationException();
Console.WriteLine(JsonSerializer.Serialize(value, options));

public sealed class Payload
{
    public int ItemCount { get; set; }
    public string? Note { get; set; }
}

Rezultat

{"itemCount":3}

Prikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.

Viri