JsonSerializer.Serialize Method

Definition

Overloads

Serialize(Object, Type, JsonSerializerOptions)

Converte o valor de um tipo especificado em uma cadeia de caracteres JSON.Converts the value of a specified type into a JSON string.

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

Grava a representação JSON do tipo especificado para o gravador fornecido.Writes the JSON representation of the specified type to the provided writer.

Serialize<TValue>(TValue, JsonSerializerOptions)

Converte o valor de um tipo especificado por um parâmetro de tipo genérico em uma cadeia de caracteres JSON.Converts the value of a type specified by a generic type parameter into a JSON string.

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

Grava a representação JSON de um tipo especificado por um parâmetro de tipo genérico no gravador fornecido.Writes the JSON representation of a type specified by a generic type parameter to the provided writer.

Serialize(Object, Type, JsonSerializerOptions)

Converte o valor de um tipo especificado em uma cadeia de caracteres JSON.Converts the value of a specified type into a JSON string.

public static string Serialize (object value, Type inputType, System.Text.Json.JsonSerializerOptions options = default);
static member Serialize : obj * Type * System.Text.Json.JsonSerializerOptions -> string
Public Shared Function Serialize (value As Object, inputType As Type, Optional options As JsonSerializerOptions = null) As String

Parameters

value
Object

O valor a ser convertido.The value to convert.

inputType
Type

O tipo do value a ser convertido.The type of the value to convert.

options
JsonSerializerOptions

Opções para controlar o comportamento de conversão.Options to control the conversion behavior.

Returns

String

A representação da cadeia de caracteres JSON do valor.The JSON string representation of the value.

Exceptions

inputType não é compatível com value.inputType is not compatible with value.

inputType é null.inputType is null.

Não há nenhum JsonConverter compatível para inputType nem para os respectivos membros serializáveis.There is no compatible JsonConverter for inputType or its serializable members.

Remarks

Usar um String não é tão eficiente quanto usar a codificação UTF-8, pois a implementação internamente usa UTF-8.Using a String is not as efficient as using UTF-8 encoding since the implementation internally uses UTF-8. Consulte também SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) e SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).See also SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) and SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).

Para obter mais informações, consulte como serializar e desserializar JSON.For more information, see How to serialize and deserialize JSON.

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

Grava a representação JSON do tipo especificado para o gravador fornecido.Writes the JSON representation of the specified type to the provided writer.

public static void Serialize (System.Text.Json.Utf8JsonWriter writer, object value, Type inputType, System.Text.Json.JsonSerializerOptions options = default);
static member Serialize : System.Text.Json.Utf8JsonWriter * obj * Type * System.Text.Json.JsonSerializerOptions -> unit
Public Shared Sub Serialize (writer As Utf8JsonWriter, value As Object, inputType As Type, Optional options As JsonSerializerOptions = null)

Parameters

writer
Utf8JsonWriter

Um gravador JSON no qual gravar.The JSON writer to write to.

value
Object

O valor a ser convertido e gravado.The value to convert and write.

inputType
Type

O tipo do value a ser convertido.The type of the value to convert.

options
JsonSerializerOptions

Opções para controlar o comportamento de serialização.Options to control serialization behavior.

Exceptions

inputType não é compatível com valueinputType is not compatible with value

writer ou inputType é null.writer or inputType is null.

Não há nenhum JsonConverter compatível para inputType nem para os respectivos membros serializáveis.There is no compatible JsonConverter for inputType or its serializable members.

Remarks

O JsonWriterOptions usado para criar a instância do Utf8JsonWriter ter precedência sobre os JsonSerializerOptions quando eles entram em conflito.The JsonWriterOptions used to create the instance of the Utf8JsonWriter take precedence over the JsonSerializerOptions when they conflict. Portanto, JsonWriterOptions.Indented, JsonWriterOptions.SkipValidatione JsonWriterOptions.Encoder são usados durante a gravação.Hence, JsonWriterOptions.Indented, JsonWriterOptions.SkipValidation, and JsonWriterOptions.Encoder are used while writing.

Para obter mais informações, consulte como serializar e desserializar JSON.For more information, see How to serialize and deserialize JSON.

Serialize<TValue>(TValue, JsonSerializerOptions)

Converte o valor de um tipo especificado por um parâmetro de tipo genérico em uma cadeia de caracteres JSON.Converts the value of a type specified by a generic type parameter into a JSON string.

public static string Serialize<TValue> (TValue value, System.Text.Json.JsonSerializerOptions options = default);
static member Serialize : 'Value * System.Text.Json.JsonSerializerOptions -> string
Public Shared Function Serialize(Of TValue) (value As TValue, Optional options As JsonSerializerOptions = null) As String

Type Parameters

TValue

O tipo do valor a ser serializado.The type of the value to serialize.

Parameters

value
TValue

O valor a ser convertido.The value to convert.

options
JsonSerializerOptions

Opções para controlar o comportamento de serialização.Options to control serialization behavior.

Returns

String

Uma representação de cadeia de caracteres JSON do valor.A JSON string representation of the value.

Exceptions

Não há nenhum JsonConverter compatível para TValue nem para os respectivos membros serializáveis.There is no compatible JsonConverter for TValue or its serializable members.

Remarks

Usar um String não é tão eficiente quanto usar a codificação UTF-8, pois a implementação internamente usa UTF-8.Using a String is not as efficient as using UTF-8 encoding since the implementation internally uses UTF-8. Consulte também SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) e SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).See also SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) and SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).

Para obter mais informações, consulte como serializar e desserializar JSON.For more information, see How to serialize and deserialize JSON.

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

Grava a representação JSON de um tipo especificado por um parâmetro de tipo genérico no gravador fornecido.Writes the JSON representation of a type specified by a generic type parameter to the provided writer.

public static void Serialize<TValue> (System.Text.Json.Utf8JsonWriter writer, TValue value, System.Text.Json.JsonSerializerOptions options = default);
static member Serialize : System.Text.Json.Utf8JsonWriter * 'Value * System.Text.Json.JsonSerializerOptions -> unit
Public Shared Sub Serialize(Of TValue) (writer As Utf8JsonWriter, value As TValue, Optional options As JsonSerializerOptions = null)

Type Parameters

TValue

O tipo do valor a ser serializado.The type of the value to serialize.

Parameters

writer
Utf8JsonWriter

Um gravador JSON no qual gravar.A JSON writer to write to.

value
TValue

O valor a ser convertido e gravado.The value to convert and write.

options
JsonSerializerOptions

Opções para controlar o comportamento de serialização.Options to control serialization behavior.

Exceptions

writer é null.writer is null.

Não há nenhum JsonConverter compatível para TValue nem para os respectivos membros serializáveis.There is no compatible JsonConverter for TValue or its serializable members.

Remarks

O JsonWriterOptions usado para criar a instância do Utf8JsonWriter ter precedência sobre os JsonSerializerOptions quando eles entram em conflito.The JsonWriterOptions used to create the instance of the Utf8JsonWriter take precedence over the JsonSerializerOptions when they conflict. Portanto, JsonWriterOptions.Indented, JsonWriterOptions.SkipValidatione JsonWriterOptions.Encoder são usados durante a gravação.Hence, JsonWriterOptions.Indented, JsonWriterOptions.SkipValidation, and JsonWriterOptions.Encoder are used while writing.

Para obter mais informações, consulte como serializar e desserializar JSON.For more information, see How to serialize and deserialize JSON.

Applies to