Compartilhar via


JsonSerializerOptions Classe

Definição

Fornece opções a serem usadas com JsonSerializer.

public ref class JsonSerializerOptions sealed
public sealed class JsonSerializerOptions
type JsonSerializerOptions = class
Public NotInheritable Class JsonSerializerOptions
Herança
JsonSerializerOptions

Comentários

Para obter mais informações, consulte Como serializar e desserializarJSON.

Construtores

JsonSerializerOptions()

Inicializa uma nova instância da classe JsonSerializerOptions.

JsonSerializerOptions(JsonSerializerDefaults)

Constrói uma nova instância de JsonSerializerOptions com um conjunto predefinido de opções determinado pelo JsonSerializerDefaultsespecificado.

JsonSerializerOptions(JsonSerializerOptions)

Copia as opções de uma instância de JsonSerializerOptions para uma nova instância.

Propriedades

AllowOutOfOrderMetadataProperties

Permite que as propriedades de metadados JSON sejam especificadas após propriedades regulares em um objeto JSON desserializado.

AllowTrailingCommas

Obtenha ou define um valor que indica se uma vírgula extra no final de uma lista de valores JSON em um objeto ou matriz é permitida (e ignorada) dentro da carga JSON que está sendo desserializada.

Converters

Obtém a lista de conversores definidos pelo usuário que foram registrados.

Default

Obtém uma instância singleton somente leitura de JsonSerializerOptions que usa a configuração padrão.

DefaultBufferSize

Obtém ou define o tamanho do buffer padrão, em bytes, a ser usado ao criar buffers temporários.

DefaultIgnoreCondition

Obtém ou define um valor que determina quando as propriedades com valores padrão são ignoradas durante a serialização ou desserialização. O valor padrão é Never.

DictionaryKeyPolicy

Obtém ou define a política usada para converter o nome de uma chave de IDictionary em outro formato, como o casing de camel.

Encoder

Obtém ou define o codificador a ser usado ao escapar de cadeias de caracteres ou null usar o codificador padrão.

IgnoreNullValues
Obsoleto.

Obtém ou define um valor que indica se null valores são ignorados durante a serialização e desserialização. O valor padrão é false.

IgnoreReadOnlyFields

Obtém ou define um valor que indica se os campos somente leitura são ignorados durante a serialização. Um campo será somente leitura se estiver marcado com a palavra-chave readonly. O valor padrão é false.

IgnoreReadOnlyProperties

Obtém um valor que indica se as propriedades somente leitura são ignoradas durante a serialização. O valor padrão é false.

IncludeFields

Obtém ou define um valor que indica se os campos são tratados durante a serialização e desserialização. O valor padrão é false.

IndentCharacter

Define o caractere de recuo que está sendo usado quando WriteIndented está habilitado. O padrão é o caractere de espaço.

IndentSize

Define o tamanho do recuo que está sendo usado quando WriteIndented está habilitado. O padrão é dois.

IsReadOnly

Obtém um valor que indica se a instância atual foi bloqueada para modificação do usuário.

MaxDepth

Obtém ou define a profundidade máxima permitida ao serializar ou desserializar JSON, com o valor padrão de 0 indicando uma profundidade máxima de 64.

NewLine

Obtém ou define a nova cadeia de caracteres de linha a ser usada quando WriteIndented é true.

O padrão é o valor de NewLine.

NumberHandling

Obtém ou define um objeto que especifica como os tipos de número devem ser tratados ao serializar ou desserializar.

PreferredObjectCreationHandling

Obtém ou define o tratamento de criação de objeto preferencial para propriedades ao desserializar o JSON.

PropertyNameCaseInsensitive

Obtém ou define um valor que indica se o nome de uma propriedade usa uma comparação que não diferencia maiúsculas de minúsculas durante a desserialização. O valor padrão é false.

PropertyNamingPolicy

Obtém ou define um valor que especifica a política usada para converter o nome de uma propriedade em um objeto em outro formato, como casing de camelo ou null para deixar os nomes de propriedade inalterados.

ReadCommentHandling

Obtém ou define um valor que define como os comentários são tratados durante a desserialização.

ReferenceHandler

Obtém ou define um objeto que especifica como as referências de objeto são tratadas ao ler e gravar JSON.

RespectNullableAnnotations

Obtém ou define um valor que indica se as anotações de nulidade devem ser respeitadas durante a serialização e a desserialização.

RespectRequiredConstructorParameters

Obtém ou define um valor que indica se os parâmetros de construtor não opcionais devem ser especificados durante a desserialização.

TypeInfoResolver

Obtém ou define o resolvedor de contrato de JsonTypeInfo usado por essa instância.

TypeInfoResolverChain

Obtém a lista de resolvedores de contrato de JsonTypeInfo encadeados usados por essa instância.

UnknownTypeHandling

Obtém ou define um objeto que especifica como desserializar um tipo declarado como um Object é tratado durante a desserialização.

UnmappedMemberHandling

Obtém ou define um objeto que especifica como JsonSerializer lida com propriedades JSON que não podem ser mapeadas para um membro .NET específico ao desserializar tipos de objeto.

Web

Obtém uma instância singleton somente leitura de JsonSerializerOptions que usa a configuração da Web.

WriteIndented

Obtém ou define um valor que indica se o JSON deve usar uma impressão bonita. Por padrão, o JSON é serializado sem nenhum espaço em branco extra.

Métodos

AddContext<TContext>()
Obsoleto.

Acrescenta um novo JsonSerializerContext à resolução de metadados da instância de JsonSerializerOptions atual.

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetConverter(Type)

Retorna o conversor para o tipo especificado.

GetHashCode()

Serve como a função de hash padrão.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
GetTypeInfo(Type)

Obtém os metadados do contrato JsonTypeInfo resolvidos pela instância JsonSerializerOptions atual.

MakeReadOnly()

Marca a instância atual como somente leitura para evitar qualquer modificação adicional do usuário.

MakeReadOnly(Boolean)

Marca a instância atual como somente leitura impedindo qualquer modificação adicional do usuário.

MemberwiseClone()

Cria uma cópia superficial do Objectatual.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)
TryGetTypeInfo(Type, JsonTypeInfo)

Tenta resolver os metadados do contrato JsonTypeInfo pela instância JsonSerializerOptions atual.

Métodos de Extensão

GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions)

Obtém o esquema JSON para type como um documento JsonNode.

Aplica-se a