CKTIS / C#
JsonSerializerOptions — konfigurácia čítania a zápisu JSON
System.Text.Json.JsonSerializerOptions riadi prevod objektov .NET na JSON a ich čítanie z JSON. Umožňuje nastaviť názvy vlastností, komentáre, neznáme vlastnosti, spracovanie čísel a vynechávanie hodnôt null. Inštanciu nastavte pred prvým použitím a pri ďalších operáciách ju opakovane používajte.
Verzia: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Syntax
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 poskytuje konfiguráciu metódam JsonSerializer.Serialize a JsonSerializer.Deserialize. Príklad je určený pre .NET 10; UnmappedMemberHandling je dostupné od .NET 8. Nie je potrebná žiadna jazyková funkcia vo verzii preview. Jednoduché new JsonSerializerOptions() zachováva názvy vlastností, pri čítaní rozlišuje veľké a malé písmená a používa striktné spracovanie čísel; predvolené nastavenia webových aplikácií sa môžu líšiť.
JsonNamingPolicy predstavuje pravidlo na prevod názvov. PropertyNamingPolicy = JsonNamingPolicy.CamelCase prevádza ItemCount na itemCount pri zápise aj čítaní. Nezapína porovnávanie bez rozlišovania veľkosti písmen: na to slúži PropertyNameCaseInsensitive. Atribút [JsonPropertyName] má pred týmto pravidlom prednosť.
ReadCommentHandling používa JsonCommentHandling: predvolená hodnota Disallow komentáre odmieta, zatiaľ čo Skip ich prijíma a ignoruje. Hodnotu Allow, určenú pre reader, táto možnosť serializátora nepodporuje. UnmappedMemberHandling používa JsonUnmappedMemberHandling: predvolená hodnota Skip ignoruje nenamapované vlastnosti JSON, ak sa nezachytia ako rozširujúce údaje. Ak pre daný typ platí Disallow, nenamapovaná vlastnosť JSON vyvolá výnimku JsonException. Konfigurácia konkrétneho typu môže mať prednosť pred nastavením v možnostiach serializátora. Ak je Disallow nastavené iba v možnostiach, člen označený atribútom [JsonExtensionData] môže zachytiť nenamapované vlastnosti bez vyvolania výnimky. Toto nastavenie nevyžaduje, aby vstup obsahoval každú vlastnosť modelu.
NumberHandling používa príznaky JsonNumberHandling. Predvolená hodnota Strict vyžaduje číselné tokeny; AllowReadingFromString navyše umožňuje prečítať "3" ako číslo, ale pri zápise sa stále použije 3. Samostatný príznak WriteAsString zapisuje čísla v úvodzovkách. DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull pri zápise vynechá vlastnosti s hodnotou null; nevynechá 0 ani false a nebráni čítaniu null.
Možnosti nastavte pred prvou serializáciou alebo deserializáciou: potom sa inštancia stane nemennou. Opätovne ju používajte, aby ste zachovali jej vyrovnávacie pamäte metadát; zdieľanie medzi vláknami je bezpečné. Príklad preskočí komentár, prečíta číslo v úvodzovkách a zapíše objekt bez Note. Pri deserializácii typu Payload z príkladu by nenamapovaná vlastnosť JSON vyvolala výnimku JsonException.
Príklady
#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; }
}
Výsledok
{"itemCount":3}Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tejto presnej verzie.
Zdroje
- .NET API browser
- JsonSerializerOptions Class
- How to instantiate JsonSerializerOptions instances with System.Text.Json
- How to customize property names and values with System.Text.Json
- JsonSerializerOptions.ReadCommentHandling Property
- Handle unmapped members during deserialization
- JsonNumberHandling Enum
- JsonIgnoreCondition Enum