JsonSerializerOptions Класс

Определение

Пространство имен:

System.Text.Json

Сборка:

System.Text.Json.dll

Пакет:

System.Text.Json v9.0.0-preview.7.24405.7

Исходный код:

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)	Создает новый экземпляр JsonSerializerOptions с предопределенным набором параметров, определенных указанным JsonSerializerDefaults.
JsonSerializerOptions(JsonSerializerOptions)	Копирует параметры из JsonSerializerOptions экземпляра в новый экземпляр.

Свойства

AllowOutOfOrderMetadataProperties	Позволяет указывать свойства метаданных JSON после регулярных свойств в десериализированном объекте JSON.
AllowTrailingCommas	Получает или задает значение, указывающее, разрешено ли дополнительное запятое в конце списка значений JSON в объекте или массиве (и игнорируется) в полезных данных JSON, десериализированных.
Converters	Возвращает список определяемых пользователем преобразователей, зарегистрированных.
Default	Возвращает только для чтения одноэлементный экземпляр JsonSerializerOptions, использующий конфигурацию по умолчанию.
DefaultBufferSize	Возвращает или задает размер буфера по умолчанию в байтах, используемый при создании временных буферов.
DefaultIgnoreCondition	Возвращает или задает значение, определяющее, когда свойства со значениями по умолчанию игнорируются во время сериализации или десериализации. Значение по умолчанию — Never.
DictionaryKeyPolicy	Возвращает или задает политику, используемую для преобразования имени ключа IDictionary в другой формат, например верблюдьего регистра.
Encoder	Возвращает или задает кодировщик, используемый при экранировании строк или null для использования кодировщика по умолчанию.
IgnoreNullValues	Устаревшие.. Возвращает или задает значение, указывающее, игнорируются ли null значения во время сериализации и десериализации. Значение по умолчанию — false.
IgnoreReadOnlyFields	Возвращает или задает значение, указывающее, игнорируются ли поля только для чтения во время сериализации. Поле доступно только для чтения, если оно отмечено ключевым словом readonly. Значение по умолчанию — false.
IgnoreReadOnlyProperties	Возвращает значение, указывающее, игнорируются ли свойства только для чтения во время сериализации. Значение по умолчанию — false.
IncludeFields	Возвращает или задает значение, указывающее, обрабатываются ли поля во время сериализации и десериализации. Значение по умолчанию — false.
IndentCharacter	Определяет символ отступа, используемый при включении WriteIndented. По умолчанию используется символ пробела.
IndentSize	Определяет размер отступа, используемый при включении WriteIndented. По умолчанию — два.
IsReadOnly	Возвращает значение, указывающее, заблокирован ли текущий экземпляр для изменения пользователя.
MaxDepth	Возвращает или задает максимальную глубину, разрешенную при сериализации или десериализации JSON, со значением по умолчанию 0, указывающее максимальную глубину 64.
NewLine	Возвращает или задает новую строку строки, которая будет использоваться при WriteIndentedtrue. По умолчанию используется значение NewLine.
NumberHandling	Возвращает или задает объект, указывающий, как следует обрабатывать типы чисел при сериализации или десериализации.
PreferredObjectCreationHandling	Возвращает или задает предпочтительную обработку создания объектов для свойств при десериализации JSON.
PropertyNameCaseInsensitive	Возвращает или задает значение, указывающее, используется ли имя свойства без учета регистра во время десериализации. Значение по умолчанию — false.
PropertyNamingPolicy	Возвращает или задает значение, указывающее политику, используемую для преобразования имени свойства в объект в другой формат, например верблюдьего регистра, или null, чтобы оставить имена свойств неизменными.
ReadCommentHandling	Возвращает или задает значение, определяющее способ обработки комментариев во время десериализации.
ReferenceHandler	Возвращает или задает объект, указывающий способ обработки ссылок на объекты при чтении и записи JSON.
RespectNullableAnnotations	Возвращает или задает значение, указывающее, следует ли учитывать заметки null во время сериализации и десериализации.
RespectRequiredConstructorParameters	Возвращает или задает значение, указывающее, следует ли указывать не необязательные параметры конструктора во время десериализации.
TypeInfoResolver	Возвращает или задает сопоставитель контракта JsonTypeInfo, используемый этим экземпляром.
TypeInfoResolverChain	Возвращает список цепочки JsonTypeInfo сопоставителей контрактов, используемых этим экземпляром.
UnknownTypeHandling	Возвращает или задает объект, указывающий способ десериализации типа, объявленного как Object, обрабатывается во время десериализации.
UnmappedMemberHandling	Возвращает или задает объект, указывающий, как JsonSerializer обрабатывает свойства JSON, которые нельзя сопоставить с определенным элементом .NET при десериализации типов объектов.
Web	Получает только для чтения одноэлементный экземпляр JsonSerializerOptions, использующий веб-конфигурацию.
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.

Методы расширения

GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions)

Возвращает схему JSON для type в виде документа JsonNode.