JsonSerializer.Serialize Método

Referência

Definição

Namespace:: System.Text.Json

Assembly:: System.Text.Json.dll

Pacote:: System.Text.Json v8.0.3

Pacote:: System.Text.Json v9.0.0-preview.3.24172.9

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Sobrecargas

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)	Grava um valor JSON (incluindo objetos ou matrizes) no gravador fornecido.
Serialize(Stream, Object, Type, JsonSerializerContext)	Converte o valor fornecido em texto JSON codificado em UTF-8 e o grava no Stream.
Serialize(Stream, Object, Type, JsonSerializerOptions)	Converte o valor fornecido em texto JSON codificado em UTF-8 e o grava no Stream.
Serialize(Utf8JsonWriter, Object, JsonTypeInfo)	Grava um valor JSON (incluindo objetos ou matrizes) no gravador fornecido.
Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)	Grava a representação JSON do tipo especificado para o gravador fornecido.
Serialize(Object, Type, JsonSerializerOptions)	Converte o valor de um tipo especificado em uma cadeia de caracteres JSON.
Serialize(Stream, Object, JsonTypeInfo)	Converte o valor fornecido em texto JSON codificado em UTF-8 e o grava no Stream.
Serialize(Object, JsonTypeInfo)	Converte o valor fornecido em um String.
Serialize(Object, Type, JsonSerializerContext)	Converte o valor fornecido em um String.
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.
Serialize<TValue>(TValue, JsonTypeInfo<TValue>)	Converte o valor fornecido em um String.
Serialize<TValue>(Stream, TValue, JsonSerializerOptions)	Converte o valor fornecido em texto JSON codificado em UTF-8 e o grava no Stream.
Serialize<TValue>(Stream, TValue, JsonTypeInfo<TValue>)	Converte o valor fornecido em texto JSON codificado em UTF-8 e o grava no Stream.
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.
Serialize<TValue>(Utf8JsonWriter, TValue, JsonTypeInfo<TValue>)	Grava um valor JSON (incluindo objetos ou matrizes) no gravador fornecido.

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Grava um valor JSON (incluindo objetos ou matrizes) no gravador fornecido.

public:
 static void Serialize(System::Text::Json::Utf8JsonWriter ^ writer, System::Object ^ value, Type ^ inputType, System::Text::Json::Serialization::JsonSerializerContext ^ context);

public static void Serialize (System.Text.Json.Utf8JsonWriter writer, object? value, Type inputType, System.Text.Json.Serialization.JsonSerializerContext context);

static member Serialize : System.Text.Json.Utf8JsonWriter * obj * Type * System.Text.Json.Serialization.JsonSerializerContext -> unit

Public Sub Serialize (writer As Utf8JsonWriter, value As Object, inputType As Type, context As JsonSerializerContext)

Parâmetros

writer: Utf8JsonWriter

Um gravador JSON no qual gravar.

value: Object

O valor a ser convertido e gravado.

inputType: Type

O tipo do value a ser convertido.

context: JsonSerializerContext

Um provedor de metadados para tipos serializáveis.

Exceções

ArgumentException

inputType não é compatível com value.

ArgumentNullException

writer ou inputType é null.

NotSupportedException

Não há nenhum JsonConverter compatível para inputType nem para os respectivos membros serializáveis.

InvalidOperationException

O GetTypeInfo(Type) método do fornecido context retorna null para o tipo a ser convertido.

Aplica-se a

Serialize(Stream, Object, Type, JsonSerializerContext)

Origem:: JsonSerializer.Write.Stream.cs

Origem:: JsonSerializer.Write.Stream.cs

Origem:: JsonSerializer.Write.Stream.cs

Converte o valor fornecido em texto JSON codificado em UTF-8 e o grava no Stream.

public:
 static void Serialize(System::IO::Stream ^ utf8Json, System::Object ^ value, Type ^ inputType, System::Text::Json::Serialization::JsonSerializerContext ^ context);

public static void Serialize (System.IO.Stream utf8Json, object? value, Type inputType, System.Text.Json.Serialization.JsonSerializerContext context);

static member Serialize : System.IO.Stream * obj * Type * System.Text.Json.Serialization.JsonSerializerContext -> unit

Public Sub Serialize (utf8Json As Stream, value As Object, inputType As Type, context As JsonSerializerContext)

Parâmetros

utf8Json: Stream

O UTF-8 Stream no qual gravar.

value: Object

O valor a ser convertido.

inputType: Type

O tipo do value a ser convertido.

context: JsonSerializerContext

Um provedor de metadados para tipos serializáveis.

Exceções

ArgumentException

inputType não é compatível com value.

ArgumentNullException

utf8Json, inputType ou context é null.

NotSupportedException

Não há nenhum JsonConverter compatível para inputType nem para os respectivos membros serializáveis.

Aplica-se a

Serialize(Stream, Object, Type, JsonSerializerOptions)

Origem:: JsonSerializer.Write.Stream.cs

Origem:: JsonSerializer.Write.Stream.cs

Origem:: JsonSerializer.Write.Stream.cs

Converte o valor fornecido em texto JSON codificado em UTF-8 e o grava no Stream.

public static void Serialize (System.IO.Stream utf8Json, object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default);

static member Serialize : System.IO.Stream * obj * Type * System.Text.Json.JsonSerializerOptions -> unit

Public Sub Serialize (utf8Json As Stream, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing)

Parâmetros

utf8Json: Stream

O UTF-8 Stream no qual gravar.

value: Object

O valor a ser convertido.

inputType: Type

O tipo do value a ser convertido.

options: JsonSerializerOptions

Opções para controlar o comportamento de conversão.

Exceções

ArgumentException

inputType não é compatível com value.

ArgumentNullException

utf8Json ou inputType é null.

NotSupportedException

Não há nenhum JsonConverter compatível para inputType nem para os respectivos membros serializáveis.

Aplica-se a

Serialize(Utf8JsonWriter, Object, JsonTypeInfo)

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Grava um valor JSON (incluindo objetos ou matrizes) no gravador fornecido.

public:
 static void Serialize(System::Text::Json::Utf8JsonWriter ^ writer, System::Object ^ value, System::Text::Json::Serialization::Metadata::JsonTypeInfo ^ jsonTypeInfo);

public static void Serialize (System.Text.Json.Utf8JsonWriter writer, object? value, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo);

static member Serialize : System.Text.Json.Utf8JsonWriter * obj * System.Text.Json.Serialization.Metadata.JsonTypeInfo -> unit

Public Sub Serialize (writer As Utf8JsonWriter, value As Object, jsonTypeInfo As JsonTypeInfo)

Parâmetros

writer: Utf8JsonWriter

O gravador a ser escrito.

value: Object

O valor a ser convertido e gravado.

jsonTypeInfo: JsonTypeInfo

Metadados sobre o tipo a ser convertido.

Exceções

ArgumentNullException

writer ou jsonTypeInfo é null.

InvalidCastException

value não corresponde ao tipo de jsonTypeInfo.

Aplica-se a

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Grava a representação JSON do tipo especificado para o gravador fornecido.

public static void Serialize (System.Text.Json.Utf8JsonWriter writer, object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default);

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 = Nothing)

Public Sub Serialize (writer As Utf8JsonWriter, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing)

Parâmetros

writer: Utf8JsonWriter

Um gravador JSON no qual gravar.

value: Object

O valor a ser convertido e gravado.

inputType: Type

O tipo do value a ser convertido.

options: JsonSerializerOptions

Opções para controlar o comportamento de serialização.

Exceções

ArgumentException

inputType não é compatível com value

ArgumentNullException

writer ou inputType é null.

NotSupportedException

Não há nenhum JsonConverter compatível para inputType nem para os respectivos membros serializáveis.

Comentários

O JsonWriterOptions usado para criar a instância do Utf8JsonWriter tem precedência sobre o JsonSerializerOptions quando eles entram em conflito. Portanto, JsonWriterOptions.Indented, e JsonWriterOptions.SkipValidation JsonWriterOptions.Encoder são usados durante a gravação.

Para obter mais informações, consulte Como serializar e desserializar o JSON.

Aplica-se a

Serialize(Object, Type, JsonSerializerOptions)

Origem:: JsonSerializer.Write.String.cs

Origem:: JsonSerializer.Write.String.cs

Origem:: JsonSerializer.Write.String.cs

Converte o valor de um tipo especificado em uma cadeia de caracteres JSON.

public static string Serialize (object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default);

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 = Nothing) As String

Public Function Serialize (value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing) As String

Parâmetros

value: Object

O valor a ser convertido.

inputType: Type

O tipo do value a ser convertido.

options: JsonSerializerOptions

Opções para controlar o comportamento de conversão.

Retornos

String

A representação da cadeia de caracteres JSON do valor.

Exceções

ArgumentException

inputType não é compatível com value.

ArgumentNullException

inputType é null.

NotSupportedException

Não há nenhum JsonConverter compatível para inputType nem para os respectivos membros serializáveis.

Comentários

O uso de um String não é tão eficiente quanto usar a codificação UTF-8, pois a implementação usa internamente UTF-8. Consulte também SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) e SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).

Para obter mais informações, consulte Como serializar e desserializar o JSON.

Aplica-se a

Serialize(Stream, Object, JsonTypeInfo)

Origem:: JsonSerializer.Write.Stream.cs

Origem:: JsonSerializer.Write.Stream.cs

Converte o valor fornecido em texto JSON codificado em UTF-8 e o grava no Stream.

public:
 static void Serialize(System::IO::Stream ^ utf8Json, System::Object ^ value, System::Text::Json::Serialization::Metadata::JsonTypeInfo ^ jsonTypeInfo);

public static void Serialize (System.IO.Stream utf8Json, object? value, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo);

static member Serialize : System.IO.Stream * obj * System.Text.Json.Serialization.Metadata.JsonTypeInfo -> unit

Public Sub Serialize (utf8Json As Stream, value As Object, jsonTypeInfo As JsonTypeInfo)

Parâmetros

utf8Json: Stream

O UTF-8 Stream no qual gravar.

value: Object

O valor a ser convertido.

jsonTypeInfo: JsonTypeInfo

Metadados sobre o tipo a ser convertido.

Exceções

ArgumentNullException

utf8Json é null.

InvalidCastException

value não corresponde ao tipo de jsonTypeInfo.

Aplica-se a

Serialize(Object, JsonTypeInfo)

Origem:: JsonSerializer.Write.String.cs

Origem:: JsonSerializer.Write.String.cs

Converte o valor fornecido em um String.

public:
 static System::String ^ Serialize(System::Object ^ value, System::Text::Json::Serialization::Metadata::JsonTypeInfo ^ jsonTypeInfo);

public static string Serialize (object? value, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo);

static member Serialize : obj * System.Text.Json.Serialization.Metadata.JsonTypeInfo -> string

Public Function Serialize (value As Object, jsonTypeInfo As JsonTypeInfo) As String

Parâmetros

value: Object

O valor a ser convertido.

jsonTypeInfo: JsonTypeInfo

Metadados sobre o tipo a ser convertido.

Retornos

String

Uma String representação do valor.

Exceções

ArgumentNullException

jsonTypeInfo é null.

InvalidCastException

value não corresponde ao tipo de jsonTypeInfo.

Comentários

O uso de um String não é tão eficiente quanto usar a codificação UTF-8, pois a implementação usa internamente UTF-8. Consulte também SerializeToUtf8Bytes(Object, JsonTypeInfo) e SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken).

Aplica-se a

Serialize(Object, Type, JsonSerializerContext)

Origem:: JsonSerializer.Write.String.cs

Origem:: JsonSerializer.Write.String.cs

Origem:: JsonSerializer.Write.String.cs

Converte o valor fornecido em um String.

public:
 static System::String ^ Serialize(System::Object ^ value, Type ^ inputType, System::Text::Json::Serialization::JsonSerializerContext ^ context);

public static string Serialize (object? value, Type inputType, System.Text.Json.Serialization.JsonSerializerContext context);

static member Serialize : obj * Type * System.Text.Json.Serialization.JsonSerializerContext -> string

Public Function Serialize (value As Object, inputType As Type, context As JsonSerializerContext) As String

Parâmetros

value: Object

O valor a ser convertido.

inputType: Type

O tipo do value a ser convertido.

context: JsonSerializerContext

Um provedor de metadados para tipos serializáveis.

Retornos

String

Uma String representação do valor.

Exceções

NotSupportedException

Não há nenhum JsonConverter compatível para inputType nem para os respectivos membros serializáveis.

InvalidOperationException

O GetTypeInfo(Type) método do fornecido context retorna null para o tipo a ser convertido.

ArgumentNullException

inputType ou context é null.

Comentários

O uso de um String não é tão eficiente quanto usar a codificação UTF-8, pois a implementação usa internamente UTF-8. SerializeToUtf8Bytes(Object, Type, JsonSerializerContext) Veja também e SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken).

Aplica-se a

Serialize<TValue>(TValue, JsonSerializerOptions)

Origem:: JsonSerializer.Write.String.cs

Origem:: JsonSerializer.Write.String.cs

Origem:: JsonSerializer.Write.String.cs

Converte o valor de um tipo especificado por um parâmetro de tipo genérico em uma cadeia de caracteres JSON.

public static string Serialize<TValue> (TValue value, System.Text.Json.JsonSerializerOptions? options = default);

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 = Nothing) As String

Public Function Serialize(Of TValue) (value As TValue, Optional options As JsonSerializerOptions = Nothing) As String

Parâmetros de tipo

TValue

O tipo de valor a serializar.

Parâmetros

value: TValue

O valor a ser convertido.

options: JsonSerializerOptions

Opções para controlar o comportamento de serialização.

Retornos

String

Uma representação de cadeia de caracteres JSON do valor.

Exceções

NotSupportedException

Não há nenhum JsonConverter compatível para TValue nem para os respectivos membros serializáveis.

Comentários

Para obter mais informações, consulte Como serializar e desserializar o JSON.

Aplica-se a

Serialize<TValue>(TValue, JsonTypeInfo<TValue>)

Origem:: JsonSerializer.Write.String.cs

Origem:: JsonSerializer.Write.String.cs

Origem:: JsonSerializer.Write.String.cs

Converte o valor fornecido em um String.

public:
generic <typename TValue>
 static System::String ^ Serialize(TValue value, System::Text::Json::Serialization::Metadata::JsonTypeInfo<TValue> ^ jsonTypeInfo);

public static string Serialize<TValue> (TValue value, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo);

static member Serialize : 'Value * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> -> string

Public Function Serialize(Of TValue) (value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue)) As String

Parâmetros de tipo

TValue

O tipo de valor a serializar.

Parâmetros

value: TValue

O valor a ser convertido.

jsonTypeInfo: JsonTypeInfo<TValue>

Metadados sobre o tipo a ser convertido.

Retornos

String

Uma String representação do valor.

Exceções

NotSupportedException

Não há nenhum JsonConverter compatível para TValue nem para os respectivos membros serializáveis.

ArgumentNullException

jsonTypeInfo é null.

Comentários

O uso de um String não é tão eficiente quanto usar a codificação UTF-8, pois a implementação usa internamente UTF-8. Consulte também SerializeToUtf8Bytes<TValue>(TValue, JsonTypeInfo<TValue>) e SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken).

Aplica-se a

Serialize<TValue>(Stream, TValue, JsonSerializerOptions)

Origem:: JsonSerializer.Write.Stream.cs

Origem:: JsonSerializer.Write.Stream.cs

Origem:: JsonSerializer.Write.Stream.cs

Converte o valor fornecido em texto JSON codificado em UTF-8 e o grava no Stream.

public static void Serialize<TValue> (System.IO.Stream utf8Json, TValue value, System.Text.Json.JsonSerializerOptions? options = default);

static member Serialize : System.IO.Stream * 'Value * System.Text.Json.JsonSerializerOptions -> unit

Public Sub Serialize(Of TValue) (utf8Json As Stream, value As TValue, Optional options As JsonSerializerOptions = Nothing)

Parâmetros de tipo

TValue

O tipo de valor a serializar.

Parâmetros

utf8Json: Stream

O UTF-8 Stream no qual gravar.

value: TValue

O valor a ser convertido.

options: JsonSerializerOptions

Opções para controlar o comportamento de conversão.

Exceções

ArgumentNullException

utf8Json é null.

NotSupportedException

Não há nenhum JsonConverter compatível para TValue nem para os respectivos membros serializáveis.

Aplica-se a

Serialize<TValue>(Stream, TValue, JsonTypeInfo<TValue>)

Origem:: JsonSerializer.Write.Stream.cs

Origem:: JsonSerializer.Write.Stream.cs

Origem:: JsonSerializer.Write.Stream.cs

Converte o valor fornecido em texto JSON codificado em UTF-8 e o grava no Stream.

public:
generic <typename TValue>
 static void Serialize(System::IO::Stream ^ utf8Json, TValue value, System::Text::Json::Serialization::Metadata::JsonTypeInfo<TValue> ^ jsonTypeInfo);

public static void Serialize<TValue> (System.IO.Stream utf8Json, TValue value, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo);

static member Serialize : System.IO.Stream * 'Value * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> -> unit

Public Sub Serialize(Of TValue) (utf8Json As Stream, value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue))

Parâmetros de tipo

TValue

O tipo de valor a serializar.

Parâmetros

utf8Json: Stream

O UTF-8 Stream no qual gravar.

value: TValue

O valor a ser convertido.

jsonTypeInfo: JsonTypeInfo<TValue>

Metadados sobre o tipo a ser convertido.

Exceções

ArgumentNullException

utf8Json é null.

NotSupportedException

Não há nenhum JsonConverter compatível para TValue nem para os respectivos membros serializáveis.

Aplica-se a

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Grava a representação JSON de um tipo especificado por um parâmetro de tipo genérico no gravador fornecido.

public static void Serialize<TValue> (System.Text.Json.Utf8JsonWriter writer, TValue value, System.Text.Json.JsonSerializerOptions? options = default);

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 = Nothing)

Public Sub Serialize(Of TValue) (writer As Utf8JsonWriter, value As TValue, Optional options As JsonSerializerOptions = Nothing)

Parâmetros de tipo

TValue

O tipo de valor a serializar.

Parâmetros

writer: Utf8JsonWriter

Um gravador JSON no qual gravar.

value: TValue

O valor a ser convertido e gravado.

options: JsonSerializerOptions

Opções para controlar o comportamento de serialização.

Exceções

ArgumentNullException

writer é null.

NotSupportedException

Não há nenhum JsonConverter compatível para TValue nem para os respectivos membros serializáveis.

Comentários

Para obter mais informações, consulte Como serializar e desserializar o JSON.

Aplica-se a

Serialize<TValue>(Utf8JsonWriter, TValue, JsonTypeInfo<TValue>)

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Origem:: JsonSerializer.Write.Utf8JsonWriter.cs

Grava um valor JSON (incluindo objetos ou matrizes) no gravador fornecido.

public:
generic <typename TValue>
 static void Serialize(System::Text::Json::Utf8JsonWriter ^ writer, TValue value, System::Text::Json::Serialization::Metadata::JsonTypeInfo<TValue> ^ jsonTypeInfo);

public static void Serialize<TValue> (System.Text.Json.Utf8JsonWriter writer, TValue value, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo);

static member Serialize : System.Text.Json.Utf8JsonWriter * 'Value * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> -> unit

Public Sub Serialize(Of TValue) (writer As Utf8JsonWriter, value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue))

Parâmetros de tipo

TValue

O tipo de valor a serializar.

Parâmetros

writer: Utf8JsonWriter

O gravador a ser escrito.

value: TValue

O valor a ser convertido e gravado.

jsonTypeInfo: JsonTypeInfo<TValue>

Metadados sobre o tipo a ser convertido.

Exceções

ArgumentNullException

writer ou jsonTypeInfo é null.

NotSupportedException

Não há nenhum JsonConverter compatível para TValue nem para os respectivos membros serializáveis.

Aplica-se a