Baza znanjaCentar za ispite
HRHrvatski
Odaberi jezik13

CKTIS / C#

JsonSerializerOptions — konfiguriranje čitanja i pisanja JSON-a

System.Text.Json.JsonSerializerOptions upravlja pretvorbom .NET objekata u JSON i čitanjem iz JSON-a. Omogućuje konfiguriranje naziva svojstava, komentara, nepoznatih svojstava, obrade brojeva i izostavljanja vrijednosti null. Instancu konfigurirajte prije prve upotrebe, a zatim je ponovno upotrebljavajte.

Verzija: .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 pruža konfiguraciju metodama JsonSerializer.Serialize i JsonSerializer.Deserialize. Primjer je namijenjen za .NET 10; UnmappedMemberHandling dostupan je od .NET 8. Nije potrebna jezična značajka u pretpreglednoj verziji. Obični new JsonSerializerOptions() zadržava nazive svojstava, pri čitanju razlikuje velika i mala slova te primjenjuje strogu obradu brojeva; zadane postavke web-aplikacija mogu se razlikovati.

JsonNamingPolicy predstavlja pravilo za pretvorbu naziva. PropertyNamingPolicy = JsonNamingPolicy.CamelCase pretvara ItemCount u itemCount pri pisanju i čitanju. To ne omogućuje uspoređivanje bez razlikovanja velikih i malih slova: za to služi PropertyNameCaseInsensitive. Atribut [JsonPropertyName] ima prednost pred pravilom.

ReadCommentHandling upotrebljava JsonCommentHandling: zadana vrijednost Disallow odbacuje komentare, dok ih Skip prihvaća i zanemaruje. Vrijednost Allow, namijenjena čitaču, nije podržana ovom opcijom serijalizatora. UnmappedMemberHandling upotrebljava JsonUnmappedMemberHandling: zadana vrijednost Skip zanemaruje nemapirana svojstva JSON-a, osim ako se pohrane kao podaci proširenja. Ako za određeni tip vrijedi Disallow, nemapirano svojstvo JSON-a izaziva iznimku JsonException. Konfiguracija pojedinog tipa može imati prednost pred postavkom u opcijama serijalizatora. Ako je Disallow postavljen samo u opcijama, član označen atributom [JsonExtensionData] može preuzeti nemapirana svojstva bez izazivanja iznimke. Ta postavka ne zahtijeva da svako svojstvo modela bude prisutno u ulaznim podacima.

NumberHandling upotrebljava zastavice JsonNumberHandling. Zadana vrijednost Strict zahtijeva numeričke tokene; AllowReadingFromString dopušta i čitanje vrijednosti "3" kao broja, ali je i dalje zapisuje kao 3. Zasebna zastavica WriteAsString zapisuje brojeve u navodnicima. DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull pri pisanju izostavlja svojstva čija je vrijednost null; ne izostavlja 0 ni false i ne sprječava čitanje vrijednosti null.

Opcije konfigurirajte prije prve serijalizacije ili deserijalizacije: nakon toga instanca postaje nepromjenjiva. Ponovno je upotrebljavajte kako biste zadržali predmemorije metapodataka; dijeljenje među dretvama sigurno je. Primjer preskače komentar, čita broj u navodnicima i zapisuje objekt bez Note. Pri deserijalizaciji tipa Payload iz primjera nemapirano svojstvo JSON-a izazvalo bi iznimku JsonException.

Primjeri

#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}

Prikazani kôd i navedeni rezultat provjereni su u izoliranom okruženju metodom zabilježenom u dokazu provjere za ovu točnu verziju.

Izvori