JsonSerializer.Serialize Метод

Определение

Пространство имен:

System.Text.Json

Сборка:

System.Text.Json.dll

Перегрузки

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

Serialize(Stream, Object, Type, JsonSerializerContext)

Исходный код:

JsonSerializer.Write.Stream.cs

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

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

value

Object

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

inputType

Type

Тип преобразованного value.

context

JsonSerializerContext

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

Исключения

ArgumentException

inputType несовместим с value.

ArgumentNullException

utf8Json, inputTypeили contextnull.

NotSupportedException

Несовместимые JsonConverter для inputType или его сериализуемых элементов.

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)

Исходный код:

JsonSerializer.Write.Utf8JsonWriter.cs

Записывает одно значение 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 или inputTypenull.

NotSupportedException

Несовместимые JsonConverter для inputType или его сериализуемых элементов.

InvalidOperationException

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

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

Исходный код:

JsonSerializer.Write.Utf8JsonWriter.cs

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

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)

Параметры

writer

Utf8JsonWriter

Модуль записи JSON для записи.

value

Object

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

inputType

Type

Тип преобразованного value.

options

JsonSerializerOptions

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

Исключения

ArgumentException

inputType несовместим с value

ArgumentNullException

writer или inputTypenull.

NotSupportedException

Несовместимые JsonConverter для inputType или его сериализуемых элементов.

Комментарии

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

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

Serialize(Utf8JsonWriter, Object, JsonTypeInfo)

Исходный код:

JsonSerializer.Write.Utf8JsonWriter.cs

Записывает одно значение 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 или jsonTypeInfonull.

InvalidCastException

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

Serialize(Stream, Object, Type, JsonSerializerOptions)

Исходный код:

JsonSerializer.Write.Stream.cs

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

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

value

Object

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

inputType

Type

Тип преобразованного value.

options

JsonSerializerOptions

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

Исключения

ArgumentException

inputType несовместим с value.

ArgumentNullException

utf8Json или inputTypenull.

NotSupportedException

Несовместимые JsonConverter для inputType или его сериализуемых элементов.

Serialize(Object, Type, JsonSerializerOptions)

Исходный код:

JsonSerializer.Write.String.cs

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

Параметры

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)

Исходный код:

JsonSerializer.Write.Stream.cs

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

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

value

Object

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

jsonTypeInfo

JsonTypeInfo

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

Исключения

ArgumentNullException

utf8Json null.

InvalidCastException

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

Serialize(Object, JsonTypeInfo)

Исходный код:

JsonSerializer.Write.String.cs

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

Исходный код:

JsonSerializer.Write.String.cs

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

Комментарии

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

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

Исходный код:

JsonSerializer.Write.Utf8JsonWriter.cs

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

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)

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

TValue

Тип сериализации значения.

Параметры

writer

Utf8JsonWriter

Модуль записи JSON для записи.

value

TValue

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

options

JsonSerializerOptions

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

Исключения

ArgumentNullException

writer null.

NotSupportedException

Несовместимые JsonConverter для TValue или его сериализуемых элементов.

Комментарии

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

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

Serialize<TValue>(TValue, JsonSerializerOptions)

Исходный код:

JsonSerializer.Write.String.cs

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

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

TValue

Тип сериализации значения.

Параметры

value

TValue

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

options

JsonSerializerOptions

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

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

String

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

Исключения

NotSupportedException

Несовместимые JsonConverter для TValue или его сериализуемых элементов.

Комментарии

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

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

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

Исходный код:

JsonSerializer.Write.String.cs

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

Исходный код:

JsonSerializer.Write.Stream.cs

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

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

value

TValue

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

options

JsonSerializerOptions

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

Исключения

ArgumentNullException

utf8Json null.

NotSupportedException

Несовместимые JsonConverter для TValue или его сериализуемых элементов.

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

Исходный код:

JsonSerializer.Write.Stream.cs

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

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

value

TValue

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

jsonTypeInfo

JsonTypeInfo<TValue>

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

Исключения

ArgumentNullException

utf8Json null.

NotSupportedException

Несовместимые JsonConverter для TValue или его сериализуемых элементов.

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

Исходный код:

JsonSerializer.Write.Utf8JsonWriter.cs

Записывает одно значение 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 или jsonTypeInfonull.

NotSupportedException

Несовместимые JsonConverter для TValue или его сериализуемых элементов.