JsonSerializerOptions 類別

定義

提供搭配 JsonSerializer 使用的選項。

public ref class JsonSerializerOptions sealed
public sealed class JsonSerializerOptions
type JsonSerializerOptions = class
Public NotInheritable Class JsonSerializerOptions
繼承
JsonSerializerOptions

備註

如需詳細資訊,請參閱 如何序列化和還原序列化 JSON

建構函式

JsonSerializerOptions()

初始化 JsonSerializerOptions 類別的新執行個體。

JsonSerializerOptions(JsonSerializerDefaults)

使用由指定 JsonSerializerDefaults 所判斷的預先定義選項組,來建構新的 JsonSerializerOptions 執行個體。

JsonSerializerOptions(JsonSerializerOptions)

將選項從 JsonSerializerOptions 執行個體複製到新的執行個體。

屬性

AllowOutOfOrderMetadataProperties

提供搭配 JsonSerializer 使用的選項。

AllowTrailingCommas

取得或設定值,指出在所要還原序列化的 JSON 承載內,是否允許 (並忽略) 物件或陣列中的 JSON 值清單結尾有額外逗號。

Converters

取得已註冊的使用者定義轉換器清單。

Default

取得使用預設組態之 的 JsonSerializerOptions 唯讀單一實例。

DefaultBufferSize

取得或設定建立暫存緩衝區時要使用的預設緩衝區大小 (以位元組為單位)。

DefaultIgnoreCondition

取得或設定值,這個值會決定序列化或還原序列化期間何時忽略具有預設值的屬性。 預設值是 Never

DictionaryKeyPolicy

取得或設定用來將 IDictionary 機碼名稱轉換為另一種格式 (例如,駝峰式大小寫) 的原則。

Encoder

取得或設定要在逸出字串時使用的編碼器,設為 null 則可使用預設編碼器。

IgnoreNullValues
已淘汰.

取得或設定值,指出序列化和還原序列化期間是否 null 忽略值。 預設值是 false

IgnoreReadOnlyFields

取得或設定值,指出序列化期間是否忽略唯讀欄位。 如果使用 readonly 關鍵字標記欄位,便代表欄位為唯讀。 預設值是 false

IgnoreReadOnlyProperties

取得值,指出序列化期間是否忽略唯讀屬性。 預設值是 false

IncludeFields

取得或設定值,這個值表示是否在序列化和還原序列化期間處理欄位。 預設值是 false

IndentCharacter

提供搭配 JsonSerializer 使用的選項。

IndentSize

提供搭配 JsonSerializer 使用的選項。

IsReadOnly

取得值,這個值表示目前實例是否已鎖定以供使用者修改。

MaxDepth

取得或設定序劣化或還原序列化 JSON 時允許的最大深度,預設值 (亦即 0) 指出 64 的最大深度。

NumberHandling

取得或設定 物件,指定序列化或還原序列化時應該如何處理數位類型。

PreferredObjectCreationHandling

取得或設定還原序列化 JSON 時屬性的慣用物件建立處理。

PropertyNameCaseInsensitive

取得或設定值,指出屬性的名稱是否在還原序列化期間使用不區分大小寫的比較。 預設值是 false

PropertyNamingPolicy

取得或設定用來指定的值,該值會指定在物件上將屬性的名稱轉換為另一個格式的原則,例如駝峰式大寫,或 null 以讓屬性名稱保持不變。

ReadCommentHandling

取得或設定值,此值定義在還原序列化期間如何處理註解。

ReferenceHandler

取得或設定 物件,指定讀取和寫入 JSON 時如何處理物件參考。

TypeInfoResolver

取得或設定 JsonTypeInfo 這個實例所使用的合約解析程式。

TypeInfoResolverChain

取得這個實例所使用的鏈結 JsonTypeInfo 合約解析程式清單。

UnknownTypeHandling

取得或設定 物件,指定還原序列化宣告為 Object 的型別在還原序列化期間如何處理。

UnmappedMemberHandling

取得或設定 物件,指定如何在 JsonSerializer 還原序列化物件類型時處理無法對應至特定 .NET 成員的 JSON 屬性。

Web

提供搭配 JsonSerializer 使用的選項。

WriteIndented

取得或設定值,這個值表示 JSON 是否應該使用美式列印。 根據預設,JSON 會序列化,而不會有任何額外的空白字元。

方法

AddContext<TContext>()
已淘汰.

將新的 JsonSerializerContext 附加至目前 JsonSerializerOptions 實例的中繼資料解析。

Equals(Object)

判斷指定的物件是否等於目前的物件。

(繼承來源 Object)
GetConverter(Type)

傳回所指定類型的轉換器。

GetHashCode()

做為預設雜湊函式。

(繼承來源 Object)
GetType()

取得目前執行個體的 Type

(繼承來源 Object)
GetTypeInfo(Type)

JsonTypeInfo取得目前 JsonSerializerOptions 實例所解析的合約中繼資料。

MakeReadOnly()

將目前的實例標示為唯讀,以防止任何進一步的使用者修改。

MakeReadOnly(Boolean)

將目前的實例標示為唯讀,以防止任何進一步的使用者修改。

MemberwiseClone()

建立目前 Object 的淺層複製。

(繼承來源 Object)
ToString()

傳回代表目前物件的字串。

(繼承來源 Object)
TryGetTypeInfo(Type, JsonTypeInfo)

嘗試取得 JsonTypeInfo 目前 JsonSerializerOptions 實例所解析的合約中繼資料。

適用於