JsonSerializerOptions 类

定义

命名空间:

System.Text.Json

程序集:

System.Text.Json.dll

Source:

JsonSerializerOptions.cs

提供与 JsonSerializer 一起使用的选项。

public ref class JsonSerializerOptions sealed

public sealed class JsonSerializerOptions

type JsonSerializerOptions = class

Public NotInheritable Class JsonSerializerOptions

继承

Object

JsonSerializerOptions

注解

有关详细信息，请参阅 如何序列化和反序列化 JSON。

构造函数

JsonSerializerOptions()	初始化 JsonSerializerOptions 类的新实例。
JsonSerializerOptions(JsonSerializerDefaults)	使用由指定的 JsonSerializerDefaults 确定的一组预定义选项构造新的 JsonSerializerOptions 实例。
JsonSerializerOptions(JsonSerializerOptions)	将 JsonSerializerOptions 实例的选项复制到新实例。

属性

AllowTrailingCommas	获取或设置一个值，该值指示要反序列化的 JSON 有效负载中是否允许（和忽略）对象或数组中 JSON 值的列表末尾多余的逗号。
Converters	获取已注册的用户定义的转换器的列表。
Default	获取使用默认配置的 的 JsonSerializerOptions 只读单一实例。
DefaultBufferSize	获取或设置创建临时缓冲区时要使用的默认缓冲区大小（以字节为单位）。
DefaultIgnoreCondition	获取或设置一个值，该值确定在序列化或反序列化期间何时忽略具有默认值的属性。 默认值为 Never。
DictionaryKeyPolicy	获取或设置用于将 IDictionary 密钥名称转换为其他格式（如 camel 大小写）的策略。
Encoder	获取或设置要在转义字符串时使用的编码器，或为 null（要使用默认编码器的话）。
IgnoreNullValues	已过时. 获取或设置一个值，该值指示在序列化和反序列化期间是否 null 忽略值。 默认值为 false。
IgnoreReadOnlyFields	获取或设置一个值，该值指示在序列化期间是否忽略只读字段。 如果某字段用 readonly 关键字进行标记，则该字段为只读字段。 默认值为 false。
IgnoreReadOnlyProperties	获取一个值，该值指示在序列化期间是否忽略只读属性。 默认值为 false。
IncludeFields	获取或设置一个值，该值指示是否在序列化和反序列化期间处理字段。 默认值为 false。
IsReadOnly	获取一个值，该值指示当前实例是否已锁定以供用户修改。
MaxDepth	获取或设置序列化或反序列化 JSON 时允许的最大深度，默认值 0 表示最大深度为 64。
NumberHandling	获取或设置一个 对象，该对象指定序列化或反序列化时应如何处理数字类型。
PreferredObjectCreationHandling	获取或设置反序列化 JSON 时属性的首选对象创建处理。
PropertyNameCaseInsensitive	获取或设置一个值，该值指示属性名称在反序列化期间是否使用不区分大小写的比较。 默认值为 false。
PropertyNamingPolicy	获取或设置一个值，该值指定用于将对象的属性名称转换为其他格式（例如 camel 大小写）的策略；若为 null，则保持属性名称不变。
ReadCommentHandling	获取或设置一个值，该值定义反序列化过程中如何处理注释。
ReferenceHandler	获取或设置一个 对象，该对象指定在读取和写入 JSON 时如何处理对象引用。
TypeInfoResolver	获取或设置 JsonTypeInfo 此实例使用的协定解析程序。
TypeInfoResolverChain	获取此实例使用的已 JsonTypeInfo 链接协定解析程序的列表。
UnknownTypeHandling	获取或设置一个 对象，该对象指定如何在反序列化过程中反序列化声明为 Object 的类型。
UnmappedMemberHandling	获取或设置一个 对象，该对象指定在反序列化对象类型时如何处理 JsonSerializer 无法映射到特定 .NET 成员的 JSON 属性。
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 实例解析的协定元数据。