Поделиться через


JsonSerializer.Serialize Метод

Определение

Перегрузки

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
Исходный код:
JsonSerializer.Write.Stream.cs
Исходный код:
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

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

Исключения

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

utf8Json, inputTypeили contextnull.

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

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

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)

Исходный код:
JsonSerializer.Write.Utf8JsonWriter.cs
Исходный код:
JsonSerializer.Write.Utf8JsonWriter.cs
Исходный код:
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

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

Исключения

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

writer или inputTypenull.

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

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

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

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

Исходный код:
JsonSerializer.Write.Utf8JsonWriter.cs
Исходный код:
JsonSerializer.Write.Utf8JsonWriter.cs
Исходный код:
JsonSerializer.Write.Utf8JsonWriter.cs

Записывает представление 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

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

Исключения

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

writer или inputTypenull.

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

Комментарии

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

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

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

Serialize(Utf8JsonWriter, Object, JsonTypeInfo)

Исходный код:
JsonSerializer.Write.Utf8JsonWriter.cs
Исходный код:
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

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

Исключения

writer или jsonTypeInfonull.

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

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

Serialize(Stream, Object, Type, JsonSerializerOptions)

Исходный код:
JsonSerializer.Write.Stream.cs
Исходный код:
JsonSerializer.Write.Stream.cs
Исходный код:
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

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

Исключения

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

utf8Json или inputTypenull.

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

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

Serialize(Object, Type, JsonSerializerOptions)

Исходный код:
JsonSerializer.Write.String.cs
Исходный код:
JsonSerializer.Write.String.cs
Исходный код:
JsonSerializer.Write.String.cs

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

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

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

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

Исключения

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

inputType null.

Несовместимые 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
Исходный код:
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

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

Исключения

utf8Json null.

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

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

Serialize(Object, JsonTypeInfo)

Исходный код:
JsonSerializer.Write.String.cs
Исходный код:
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 представление значения.

Исключения

jsonTypeInfo null.

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

Комментарии

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

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

Serialize(Object, Type, JsonSerializerContext)

Исходный код:
JsonSerializer.Write.String.cs
Исходный код:
JsonSerializer.Write.String.cs
Исходный код:
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 представление значения.

Исключения

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

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

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
Исходный код:
JsonSerializer.Write.Utf8JsonWriter.cs
Исходный код:
JsonSerializer.Write.Utf8JsonWriter.cs

Записывает представление 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

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

Исключения

writer null.

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

Комментарии

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

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

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

Serialize<TValue>(TValue, JsonSerializerOptions)

Исходный код:
JsonSerializer.Write.String.cs
Исходный код:
JsonSerializer.Write.String.cs
Исходный код:
JsonSerializer.Write.String.cs

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

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

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

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

Исключения

Несовместимые 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
Исходный код:
JsonSerializer.Write.String.cs
Исходный код:
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 представление значения.

Исключения

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

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
Исходный код:
JsonSerializer.Write.Stream.cs
Исходный код:
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

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

Исключения

utf8Json null.

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

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

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

Исходный код:
JsonSerializer.Write.Stream.cs
Исходный код:
JsonSerializer.Write.Stream.cs
Исходный код:
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>

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

Исключения

utf8Json null.

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

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

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

Исходный код:
JsonSerializer.Write.Utf8JsonWriter.cs
Исходный код:
JsonSerializer.Write.Utf8JsonWriter.cs
Исходный код:
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>

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

Исключения

writer или jsonTypeInfonull.

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

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