JsonSerializerOptions.RespectNullableAnnotations Vlastnost

Definice

Obor názvů:

System.Text.Json

Sestavení:

System.Text.Json.dll

Balíček:

System.Text.Json v9.0.0-rc.2.24473.5

Získá nebo nastaví hodnotu, která označuje, zda mají být poznámky nullability dodrženy během serializace a deserializace.

public:
 property bool RespectNullableAnnotations { bool get(); void set(bool value); };

public bool RespectNullableAnnotations { get; set; }

member this.RespectNullableAnnotations : bool with get, set

Public Property RespectNullableAnnotations As Boolean

Hodnota vlastnosti

Boolean

Výjimky

InvalidOperationException

Tato vlastnost je nastavena po serializaci nebo deserializaci došlo.

Poznámky

Konfiguruje serializátor vyvolat výjimku při pokusu o serializaci null hodnotu z nenulable vlastnost getter, nebo při deserializaci null hodnotu do nenulovatelné vlastnosti setter nebo konstruktor parametru. Poznámky s hodnotou null jsou vyřešeny z vlastností, polí a parametrů konstruktoru, které serializátor používá. To zahrnuje poznámky vyplývající z atributů, jako jsou NotNullAttribute, MaybeNullAttribute, AllowNullAttribute a DisallowNullAttribute.

Vzhledem k omezením v tom, jak jsou v době běhu reprezentovány odkazové typy s možnou hodnotou null, toto nastavení řídí pouze anotaci s nulovou dostupností ne generických vlastností, polí a parametrů konstruktoru. Nedá se použít k vynucení poznámek s možnou hodnotou null u typů kořenové úrovně, elementů kolekce nebo obecných parametrů. Výchozí nastavení této vlastnosti lze přepínat na úrovni aplikace pomocí přepínače funkce System.Text.Json.Serialization.RespectNullableAnnotationsDefault.

Ověřovací funkce s hodnotou null nezávisle na ověření požadované hodnoty, to znamená, že nastavení nemá žádný vliv ve scénářích, kdy datová část chybí požadovaná vlastnost. To lze nakonfigurovat nezávisle pomocí klíčového slova required, atributu JsonRequiredAttribute nebo vlastnosti RespectRequiredConstructorParameters.

Doporučuje se, aby nové aplikace vždy nastavily tuto vlastnost na true, v kombinaci s úzce související RespectRequiredConstructorParameters vlastnost.