JsonSerializer.Serialize Método

Definição

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Sobrecargas

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

Serialize(Stream, Object, Type, JsonSerializerContext)

Origem:

JsonSerializer.Write.Stream.cs

Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o 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 Stream UTF-8 para o 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, inputTypeou context é null.

NotSupportedException

Não há JsonConverter compatíveis para inputType ou seus membros serializáveis.

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)

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 para escrever.

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á JsonConverter compatíveis para inputType ou seus membros serializáveis.

InvalidOperationException

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

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

Origem:

JsonSerializer.Write.Utf8JsonWriter.cs

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

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 Sub Serialize (writer As Utf8JsonWriter, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing)

Parâmetros

writer

Utf8JsonWriter

O gravador JSON para o qual escrever.

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á JsonConverter compatíveis para inputType ou seus membros serializáveis.

Comentários

Os JsonWriterOptions usados para criar a instância do Utf8JsonWriter têm precedência sobre o JsonSerializerOptions quando entram em conflito. Portanto, JsonWriterOptions.Indented, JsonWriterOptions.SkipValidatione JsonWriterOptions.Encoder são usados durante a gravação.

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

Serialize(Utf8JsonWriter, Object, JsonTypeInfo)

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.

Serialize(Stream, Object, Type, JsonSerializerOptions)

Origem:

JsonSerializer.Write.Stream.cs

Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o 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 Stream UTF-8 para o 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á JsonConverter compatíveis para inputType ou seus membros serializáveis.

Serialize(Object, Type, JsonSerializerOptions)

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);

static member Serialize : obj * Type * System.Text.Json.JsonSerializerOptions -> 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á JsonConverter compatíveis para inputType ou seus membros serializáveis.

Comentários

Usar 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 desserializarJSON.

Serialize(Stream, Object, JsonTypeInfo)

Origem:

JsonSerializer.Write.Stream.cs

Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o 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 Stream UTF-8 para o 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.

Serialize(Object, JsonTypeInfo)

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 representação String do valor.

Exceções

ArgumentNullException

jsonTypeInfo é null.

InvalidCastException

value não corresponde ao tipo de jsonTypeInfo.

Comentários

Usar 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).

Serialize(Object, Type, JsonSerializerContext)

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 representação String do valor.

Exceções

NotSupportedException

Não há JsonConverter compatíveis para inputType ou seus membros serializáveis.

InvalidOperationException

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

ArgumentNullException

inputType ou context é null.

Comentários

Usar 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, JsonSerializerContext) e SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken).

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

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);

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

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

Parâmetros de tipo

TValue

O tipo do valor a ser serializado.

Parâmetros

writer

Utf8JsonWriter

Um gravador JSON para escrever.

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á JsonConverter compatíveis para TValue ou seus membros serializáveis.

Comentários

Os JsonWriterOptions usados para criar a instância do Utf8JsonWriter têm precedência sobre o JsonSerializerOptions quando entram em conflito. Portanto, JsonWriterOptions.Indented, JsonWriterOptions.SkipValidatione JsonWriterOptions.Encoder são usados durante a gravação.

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

Serialize<TValue>(TValue, JsonSerializerOptions)

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);

static member Serialize : 'Value * System.Text.Json.JsonSerializerOptions -> string

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

Parâmetros de tipo

TValue

O tipo do valor a ser serializado.

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á JsonConverter compatíveis para TValue ou seus membros serializáveis.

Comentários

Usar 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 desserializarJSON.

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

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 do valor a ser serializado.

Parâmetros

value

TValue

O valor a ser convertido.

jsonTypeInfo

JsonTypeInfo<TValue>

Metadados sobre o tipo a ser convertido.

Retornos

String

Uma representação String do valor.

Exceções

NotSupportedException

Não há JsonConverter compatíveis para TValue ou seus membros serializáveis.

ArgumentNullException

jsonTypeInfo é null.

Comentários

Usar 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).

Serialize<TValue>(Stream, TValue, JsonSerializerOptions)

Origem:

JsonSerializer.Write.Stream.cs

Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o 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 do valor a ser serializado.

Parâmetros

utf8Json

Stream

O Stream UTF-8 para o 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á JsonConverter compatíveis para TValue ou seus membros serializáveis.

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

Origem:

JsonSerializer.Write.Stream.cs

Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o 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 do valor a ser serializado.

Parâmetros

utf8Json

Stream

O Stream UTF-8 para o 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á JsonConverter compatíveis para TValue ou seus membros serializáveis.

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

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 do valor a ser serializado.

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á JsonConverter compatíveis para TValue ou seus membros serializáveis.