JsonSerializerOptions Classe

Definição

Fornece opções para serem usadas com JsonSerializer.

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

Observações

Para mais informações, veja Como serializar e desserializar JSON.

Construtores

Name Description
JsonSerializerOptions()

Inicializa uma nova instância da JsonSerializerOptions classe.

JsonSerializerOptions(JsonSerializerDefaults)

Constrói uma nova JsonSerializerOptions instância com um conjunto pré-definido de opções determinado pelo especificado JsonSerializerDefaults.

JsonSerializerOptions(JsonSerializerOptions)

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

Propriedades

Name Description
AllowDuplicateProperties

Recebe ou define um valor que indica se nomes duplicados de propriedades são permitidos ao desserializar objetos JSON.

AllowOutOfOrderMetadataProperties

Recebe ou define um valor que indica se propriedades de metadados JSON podem ser especificadas após propriedades normais num objeto JSON desserializado.

AllowTrailingCommas

Get ou define um valor que indica se uma vírgula extra no final de uma lista de valores JSON num objeto ou array é permitida (e ignorada) dentro da carga útil JSON que está a ser desserializada.

Converters

Obtém a lista de conversores definidos pelo utilizador que foram registados.

Default

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

DefaultBufferSize

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

DefaultIgnoreCondition

Recebe ou define um valor que determina quando propriedades com valores predefinidos são ignoradas durante a serialização ou desserialização. O valor predefinido é Never.

DictionaryKeyPolicy

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

Encoder

Obtém ou define o codificador para usar ao escapar das strings, ou null para usar o codificador padrão.

IgnoreNullValues
Obsoleto.

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

IgnoreReadOnlyFields

Recebe ou define um valor que indica se os campos de apenas leitura são ignorados durante a serialização. Um campo é apenas de leitura se estiver marcado com a readonly palavra-chave. O valor predefinido é false.

IgnoreReadOnlyProperties

Recebe ou define um valor que indica se as propriedades de apenas leitura são ignoradas durante a serialização. O valor predefinido é false.

IncludeFields

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

IndentCharacter

Define o carácter de indentação usado quando WriteIndented está ativado. Por defeito, o carácter espaço.

IndentSize

Define o tamanho da indentação usado quando WriteIndented está ativado. Por defeito, é dois.

IsReadOnly

Recebe um valor que indica se a instância atual foi bloqueada para modificação do utilizador.

MaxDepth

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

NewLine

Obtém ou define a nova cadeia de linha para usar quando WriteIndented é true.

O padrão é o valor de NewLine.

NumberHandling

Obtém ou define um objeto que especifica como os tipos numéricos devem ser tratados ao serializar ou desserializar.

PreferredObjectCreationHandling

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

PropertyNameCaseInsensitive

Obtém ou define um valor que indica se o nome de uma propriedade utiliza uma comparação insensível a maiúsculas e minúsculas durante a desserialização. O valor predefinido é false.

PropertyNamingPolicy

Recebe ou define um valor que especifica a política usada para converter o nome de uma propriedade num objeto para outro formato, como camel-casing, ou null para manter os nomes das propriedades 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 objetos são tratadas ao ler e escrever JSON.

RespectNullableAnnotations

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

RespectRequiredConstructorParameters

Recebe ou define um valor que indica se parâmetros não opcionais do construtor devem ser especificados durante a desserialização.

Strict

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

TypeInfoResolver

Obtém ou define o resolvedor JsonTypeInfo contratual usado por esta instância.

TypeInfoResolverChain

Obtém a lista de resolvers de contratos encadeados JsonTypeInfo usados por esta instância.

UnknownTypeHandling

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

UnmappedMemberHandling

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

Web

Obtém uma instância JsonSerializerOptions singleton, apenas de leitura que usa a configuração web.

WriteIndented

Recebe ou define um valor que indica se o JSON deve usar impressão bonita. Por defeito, o JSON é serializado sem qualquer espaço em branco adicional.

Métodos

Name Description
AddContext<TContext>()
Obsoleto.

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

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetConverter(Type)

Devolve o conversor para o tipo especificado.

GetHashCode()

Serve como função de hash predefinida.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
GetTypeInfo(Type)

Faz com que os JsonTypeInfo metadados do contrato sejam resolvidos pela instância atual JsonSerializerOptions .

GetTypeInfo<T>()

Fornece opções para serem usadas com JsonSerializer.

MakeReadOnly()

Marca a instância atual como apenas leitura para evitar qualquer modificação adicional do utilizador.

MakeReadOnly(Boolean)

Marca a instância atual como apenas de leitura, impedindo qualquer modificação adicional do utilizador.

MemberwiseClone()

Cria uma cópia superficial do atual Object.

(Herdado de Object)
ToString()

Devolve uma cadeia que representa o objeto atual.

(Herdado de Object)
TryGetTypeInfo(Type, JsonTypeInfo)

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

TryGetTypeInfo<T>(JsonTypeInfo<T>)

Fornece opções para serem usadas com JsonSerializer.

Métodos da Extensão

Name Description
AddAIContentType(JsonSerializerOptions, Type, String)

Adiciona um tipo de conteúdo personalizado à configuração polimórfica para AIContent.

AddAIContentType<TContent>(JsonSerializerOptions, String)

Adiciona um tipo de conteúdo personalizado à configuração polimórfica para AIContent.

GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions)

Gera um esquema JSON correspondente aos metadados do contrato do tipo especificado.

Aplica-se a