JsonSerializerOptions.RespectNullableAnnotations Properti

Definisi

Ruang nama:

System.Text.Json

Rakitan:

System.Text.Json.dll

Paket:

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

Mendapatkan atau menetapkan nilai yang menunjukkan apakah anotasi nullability harus dihormati selama serialisasi dan deserialisasi.

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

Nilai Properti

Boolean

Pengecualian

InvalidOperationException

Properti ini diatur setelah serialisasi atau deserialisasi terjadi.

Keterangan

Mengonfigurasi serializer untuk melemparkan pengecualian saat mencoba membuat serialisasi nilai null dari getter properti yang tidak dapat diubah ke null, atau saat mendeserialisasi nilai null ke dalam setter properti atau parameter konstruktor yang tidak dapat diubah ke null. Anotasi nullability diselesaikan dari properti, bidang, dan parameter konstruktor yang digunakan oleh serializer. Ini termasuk anotasi yang berasal dari atribut seperti NotNullAttribute, MaybeNullAttribute, AllowNullAttribute dan DisallowNullAttribute.

Karena pembatasan dalam bagaimana jenis referensi nullable diwakili pada run time, pengaturan ini hanya mengatur anotasi nullability properti, bidang, dan parameter konstruktor non-generik. Ini tidak dapat digunakan untuk menerapkan anotasi nullability dari jenis tingkat akar, elemen koleksi, atau parameter generik. Pengaturan default untuk properti ini dapat diubah ke seluruh aplikasi menggunakan sakelar fitur "System.Text.Json.Serialization.RespectNullableAnnotationsDefault".

Fungsi validasi nullability secara independen dari validasi keharusan, artinya pengaturan tidak berpengaruh dalam skenario di mana payload kehilangan properti yang diperlukan. Ini dapat dikonfigurasi secara independen menggunakan kata kunci required, atribut JsonRequiredAttribute, atau properti RespectRequiredConstructorParameters.

Disarankan agar aplikasi baru selalu mengatur properti ini ke true, dalam kombinasi dengan properti RespectRequiredConstructorParameters yang terkait erat.