JsonSerializer.Serialize Метод

Ссылка

Определение

Пространство имен:: System.Text.Json

Сборка:: System.Text.Json.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Перегрузки

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)	Записывает одно значение JSON (включая объекты или массивы) в предоставленный модуль записи.
Serialize(Stream, Object, Type, JsonSerializerContext)	Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в Stream.
Serialize(Stream, Object, Type, JsonSerializerOptions)	Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в Stream.
Serialize(Utf8JsonWriter, Object, JsonTypeInfo)	Записывает одно значение JSON (включая объекты или массивы) в предоставленный модуль записи.
Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)	Записывает представление JSON указанного типа в предоставленный модуль записи.
Serialize(Object, Type, JsonSerializerOptions)	Преобразует значение указанного типа в строку JSON.
Serialize(Stream, Object, JsonTypeInfo)	Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в Stream.
Serialize(Object, JsonTypeInfo)	Преобразует предоставленное значение в String.
Serialize(Object, Type, JsonSerializerContext)	Преобразует предоставленное значение в String.
Serialize<TValue>(TValue, JsonSerializerOptions)	Преобразует значение типа, заданного параметром универсального типа, в строку JSON.
Serialize<TValue>(TValue, JsonTypeInfo<TValue>)	Преобразует предоставленное значение в String.
Serialize<TValue>(Stream, TValue, JsonSerializerOptions)	Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в Stream.
Serialize<TValue>(Stream, TValue, JsonTypeInfo<TValue>)	Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в Stream.
Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)	Записывает представление JSON типа, указанного параметром универсального типа, в предоставленный модуль записи.
Serialize<TValue>(Utf8JsonWriter, TValue, JsonTypeInfo<TValue>)	Записывает одно значение JSON (включая объекты или массивы) в предоставленный модуль записи.

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)

Записывает одно значение JSON (включая объекты или массивы) в предоставленный модуль записи.

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)

Параметры

writer: Utf8JsonWriter

Модуль записи JSON, в который производится запись.

value: Object

Значение для преобразования и записи.

inputType: Type

Тип value для преобразования.

context: JsonSerializerContext

Поставщик метаданных для сериализуемых типов.

Исключения

ArgumentException

Параметр inputType несовместим с параметром value.

ArgumentNullException

Параметр writer или inputType имеет значение null.

NotSupportedException

Совместимые объекты JsonConverter для inputType или его сериализуемых членов отсутствуют.

InvalidOperationException

Метод GetTypeInfo(Type) предоставленного context возвращает null преобразуемый тип.

Применяется к

Serialize(Stream, Object, Type, JsonSerializerContext)

Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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)

Параметры

utf8Json: Stream

UTF-8 Stream для записи.

value: Object

Преобразуемое значение.

inputType: Type

Тип value для преобразования.

context: JsonSerializerContext

Поставщик метаданных для сериализуемых типов.

Исключения

ArgumentException

Параметр inputType несовместим с параметром value.

ArgumentNullException

Значение параметра utf8Json, inputType или context равно null.

NotSupportedException

Совместимые объекты JsonConverter для inputType или его сериализуемых членов отсутствуют.

Применяется к

Serialize(Stream, Object, Type, JsonSerializerOptions)

Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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)

Параметры

utf8Json: Stream

UTF-8 Stream для записи.

value: Object

Преобразуемое значение.

inputType: Type

Тип value для преобразования.

options: JsonSerializerOptions

Параметры для управления поведением преобразования.

Исключения

ArgumentException

Параметр inputType несовместим с параметром value.

ArgumentNullException

Параметр utf8Json или inputType имеет значение null.

NotSupportedException

Совместимые объекты JsonConverter для inputType или его сериализуемых членов отсутствуют.

Применяется к

Serialize(Utf8JsonWriter, Object, JsonTypeInfo)

Записывает одно значение JSON (включая объекты или массивы) в предоставленный модуль записи.

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)

Параметры

writer: Utf8JsonWriter

Записываемый модуль.

value: Object

Значение для преобразования и записи.

jsonTypeInfo: JsonTypeInfo

Метаданные о преобразуемом типе.

Исключения

ArgumentNullException

Параметр writer или jsonTypeInfo имеет значение null.

InvalidCastException

value не соответствует типу jsonTypeInfo.

Применяется к

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

Записывает представление JSON указанного типа в предоставленный модуль записи.

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)

Параметры

writer: Utf8JsonWriter

Модуль записи JSON, в который производится запись.

value: Object

Значение для преобразования и записи.

inputType: Type

Тип value для преобразования.

options: JsonSerializerOptions

Параметры управления поведением сериализации.

Исключения

ArgumentException

Параметр inputType несовместим с параметром value

ArgumentNullException

Параметр writer или inputType имеет значение null.

NotSupportedException

Совместимые объекты JsonConverter для inputType или его сериализуемых членов отсутствуют.

Объект , JsonWriterOptions используемый для создания экземпляра , Utf8JsonWriter имеет приоритет над JsonSerializerOptions , когда они конфликтуют. Следовательно, JsonWriterOptions.Indentedпри записи используются , JsonWriterOptions.SkipValidationи JsonWriterOptions.Encoder .

Дополнительные сведения см. в разделе Сериализация и десериализация JSON.

Применяется к

Serialize(Object, Type, JsonSerializerOptions)

Преобразует значение указанного типа в строку 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

Параметры

value: Object

Преобразуемое значение.

inputType: Type

Тип value для преобразования.

options: JsonSerializerOptions

Параметры для управления поведением преобразования.

Возвращаемое значение

String

Строковое представление JSON значения.

Исключения

ArgumentException

Параметр inputType несовместим с параметром value.

ArgumentNullException

inputType имеет значение null.

NotSupportedException

Совместимые объекты JsonConverter для inputType или его сериализуемых членов отсутствуют.

String Использование не так эффективно, как использование кодировки UTF-8, так как реализация внутренне использует UTF-8. См. также SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) и SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).

Дополнительные сведения см. в разделе Сериализация и десериализация JSON.

Применяется к

Serialize(Stream, Object, JsonTypeInfo)

Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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)

Параметры

utf8Json: Stream

UTF-8 Stream для записи.

value: Object

Преобразуемое значение.

jsonTypeInfo: JsonTypeInfo

Метаданные о преобразуемом типе.

Исключения

ArgumentNullException

utf8Json имеет значение null.

InvalidCastException

value не соответствует типу jsonTypeInfo.

Применяется к

Serialize(Object, JsonTypeInfo)

Преобразует предоставленное значение в 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

Параметры

value: Object

Преобразуемое значение.

jsonTypeInfo: JsonTypeInfo

Метаданные о преобразуемом типе.

Возвращаемое значение

String

Представление String значения.

Исключения

ArgumentNullException

jsonTypeInfo имеет значение null.

InvalidCastException

value не соответствует типу jsonTypeInfo.

String Использование не так эффективно, как использование кодировки UTF-8, так как реализация внутренне использует UTF-8. См. также SerializeToUtf8Bytes(Object, JsonTypeInfo) и SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken).

Применяется к

Serialize(Object, Type, JsonSerializerContext)

Преобразует предоставленное значение в 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

Параметры

value: Object

Преобразуемое значение.

inputType: Type

Тип value для преобразования.

context: JsonSerializerContext

Поставщик метаданных для сериализуемых типов.

Возвращаемое значение

String

Представление String значения.

Исключения

NotSupportedException

Совместимые объекты JsonConverter для inputType или его сериализуемых членов отсутствуют.

InvalidOperationException

Метод GetTypeInfo(Type) предоставленного context возвращает null преобразуемый тип.

ArgumentNullException

Параметр inputType или context имеет значение null.

String Использование не так эффективно, как использование кодировки UTF-8, так как реализация внутренне использует UTF-8. Также см. SerializeToUtf8Bytes(Object, Type, JsonSerializerContext) и SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken).

Применяется к

Serialize<TValue>(TValue, JsonSerializerOptions)

Преобразует значение типа, заданного параметром универсального типа, в строку 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

Параметры типа

TValue

Тип сериализуемого значения.

Параметры

value: TValue

Преобразуемое значение.

options: JsonSerializerOptions

Параметры управления поведением сериализации.

Возвращаемое значение

String

Строковое представление JSON значения.

Исключения

NotSupportedException

Совместимые объекты JsonConverter для TValue или его сериализуемых членов отсутствуют.

Применяется к

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

Преобразует предоставленное значение в 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

Параметры типа

TValue

Тип сериализуемого значения.

Параметры

value: TValue

Преобразуемое значение.

jsonTypeInfo: JsonTypeInfo<TValue>

Метаданные о преобразуемом типе.

Возвращаемое значение

String

Представление String значения.

Исключения

NotSupportedException

Совместимые объекты JsonConverter для TValue или его сериализуемых членов отсутствуют.

ArgumentNullException

jsonTypeInfo имеет значение null.

String Использование не так эффективно, как использование кодировки UTF-8, так как реализация внутренне использует UTF-8. См. также SerializeToUtf8Bytes<TValue>(TValue, JsonTypeInfo<TValue>) и SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken).

Применяется к

Serialize<TValue>(Stream, TValue, JsonSerializerOptions)

Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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)

Параметры типа

TValue

Тип сериализуемого значения.

Параметры

utf8Json: Stream

UTF-8 Stream для записи.

value: TValue

Преобразуемое значение.

options: JsonSerializerOptions

Параметры для управления поведением преобразования.

Исключения

ArgumentNullException

utf8Json имеет значение null.

NotSupportedException

Совместимые объекты JsonConverter для TValue или его сериализуемых членов отсутствуют.

Применяется к

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

Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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))

Параметры типа

TValue

Тип сериализуемого значения.

Параметры

utf8Json: Stream

UTF-8 Stream для записи.

value: TValue

Преобразуемое значение.

jsonTypeInfo: JsonTypeInfo<TValue>

Метаданные о преобразуемом типе.

Исключения

ArgumentNullException

utf8Json имеет значение null.

NotSupportedException

Совместимые объекты JsonConverter для TValue или его сериализуемых членов отсутствуют.

Применяется к

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

Записывает представление JSON типа, указанного параметром универсального типа, в предоставленный модуль записи.

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)

Параметры типа

TValue

Тип сериализуемого значения.

Параметры

writer: Utf8JsonWriter

Модуль записи JSON, в который производится запись.

value: TValue

Значение для преобразования и записи.

options: JsonSerializerOptions

Параметры управления поведением сериализации.

Исключения

ArgumentNullException

writer имеет значение null.

NotSupportedException

Совместимые объекты JsonConverter для TValue или его сериализуемых членов отсутствуют.

Применяется к

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

Записывает одно значение JSON (включая объекты или массивы) в предоставленный модуль записи.

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

Параметры типа

TValue

Тип сериализуемого значения.

Параметры

writer: Utf8JsonWriter

Записываемый модуль.

value: TValue

Значение для преобразования и записи.

jsonTypeInfo: JsonTypeInfo<TValue>

Метаданные о преобразуемом типе.

Исключения

ArgumentNullException

Параметр writer или jsonTypeInfo имеет значение null.

NotSupportedException

Совместимые объекты JsonConverter для TValue или его сериализуемых членов отсутствуют.

Применяется к

JsonSerializer.Serialize Метод

Определение

Перегрузки

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)

Параметры

Исключения

Применяется к

Serialize(Stream, Object, Type, JsonSerializerContext)

Параметры

Исключения

Применяется к

Serialize(Stream, Object, Type, JsonSerializerOptions)

Параметры

Исключения

Применяется к

Serialize(Utf8JsonWriter, Object, JsonTypeInfo)

Параметры

Исключения

Применяется к

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

Параметры

Исключения

Комментарии

Применяется к

Serialize(Object, Type, JsonSerializerOptions)

Параметры

Возвращаемое значение

Исключения

Комментарии

Применяется к

Serialize(Stream, Object, JsonTypeInfo)

Параметры

Исключения

Применяется к

Serialize(Object, JsonTypeInfo)

Параметры

Возвращаемое значение

Исключения

Комментарии

Применяется к

Serialize(Object, Type, JsonSerializerContext)

Параметры

Возвращаемое значение

Исключения

Комментарии

Применяется к

Serialize<TValue>(TValue, JsonSerializerOptions)

Параметры типа

Параметры

Возвращаемое значение

Исключения

Комментарии

Применяется к

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

Параметры типа

Параметры

Возвращаемое значение

Исключения

Комментарии

Применяется к

Serialize<TValue>(Stream, TValue, JsonSerializerOptions)

Параметры типа

Параметры

Исключения

Применяется к

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

Параметры типа

Параметры

Исключения

Применяется к

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

Параметры типа

Параметры

Исключения

Комментарии

Применяется к

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

Параметры типа

Параметры

Исключения