JsonSerializer.Serialize メソッド

定義

オーバーロード

Serialize(Object, Type, JsonSerializerOptions)

指定した型の値を JSON 文字列に変換します。Converts the value of a specified type into a JSON string.

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

指定された型の JSON 表現を指定されたライターに書き込みます。Writes the JSON representation of the specified type to the provided writer.

Serialize<TValue>(TValue, JsonSerializerOptions)

ジェネリック型パラメーターで指定された型の値を JSON 文字列に変換します。Converts the value of a type specified by a generic type parameter into a JSON string.

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

ジェネリック型パラメーターで指定された型の JSON 表現を指定されたライターに書き込みます。Writes the JSON representation of a type specified by a generic type parameter to the provided writer.

Serialize(Object, Type, JsonSerializerOptions)

指定した型の値を JSON 文字列に変換します。Converts the value of a specified type into a JSON string.

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

パラメーター

value
Object

変換する値。The value to convert.

inputType
Type

変換対象の value の型。The type of the value to convert.

options
JsonSerializerOptions

変換動作を制御するオプション。Options to control the conversion behavior.

戻り値

String

値の JSON 文字列表現。The JSON string representation of the value.

例外

inputTypevalue と互換性がありません。inputType is not compatible with value.

inputTypenullです。inputType is null.

inputType またはそのシリアル化可能なメンバーに対して互換性のある JsonConverter はありません。There is no compatible JsonConverter for inputType or its serializable members.

注釈

String 実装では、内部的に utf-8 が使用されるため、を使用することは、utf-8 エンコードを使用する場合ほど効率的ではありません。Using a String is not as efficient as using UTF-8 encoding since the implementation internally uses UTF-8. SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) および SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken) も参照してください。See also SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) and SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).

詳細については、「JSON をシリアル化および逆シリアル化する方法」を参照してください。For more information, see How to serialize and deserialize JSON.

適用対象

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

指定された型の JSON 表現を指定されたライターに書き込みます。Writes the JSON representation of the specified type to the provided writer.

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)

パラメーター

writer
Utf8JsonWriter

書き込み先の JSON ライター。The JSON writer to write to.

value
Object

変換して書き込む値。The value to convert and write.

inputType
Type

変換対象の value の型。The type of the value to convert.

options
JsonSerializerOptions

シリアル化動作を制御するオプション。Options to control serialization behavior.

例外

inputTypevalue と互換性がありませんinputType is not compatible with value

writer または inputTypenull です。writer or inputType is null.

inputType またはそのシリアル化可能なメンバーに対して互換性のある JsonConverter はありません。There is no compatible JsonConverter for inputType or its serializable members.

注釈

JsonWriterOptions インスタンスを作成するために使用されるは、 Utf8JsonWriter 競合するときにより優先され JsonSerializerOptions ます。The JsonWriterOptions used to create the instance of the Utf8JsonWriter take precedence over the JsonSerializerOptions when they conflict. そのため、、、 JsonWriterOptions.Indented JsonWriterOptions.SkipValidation および JsonWriterOptions.Encoder は書き込み中に使用されます。Hence, JsonWriterOptions.Indented, JsonWriterOptions.SkipValidation, and JsonWriterOptions.Encoder are used while writing.

詳細については、「JSON をシリアル化および逆シリアル化する方法」を参照してください。For more information, see How to serialize and deserialize JSON.

適用対象

Serialize<TValue>(TValue, JsonSerializerOptions)

ジェネリック型パラメーターで指定された型の値を JSON 文字列に変換します。Converts the value of a type specified by a generic type parameter into a JSON string.

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

型パラメーター

TValue

シリアル化する値の型。The type of the value to serialize.

パラメーター

value
TValue

変換する値。The value to convert.

options
JsonSerializerOptions

シリアル化動作を制御するオプション。Options to control serialization behavior.

戻り値

String

値の JSON 文字列表現。A JSON string representation of the value.

例外

TValue またはそのシリアル化可能なメンバーに対して互換性のある JsonConverter はありません。There is no compatible JsonConverter for TValue or its serializable members.

注釈

String 実装では、内部的に utf-8 が使用されるため、を使用することは、utf-8 エンコードを使用する場合ほど効率的ではありません。Using a String is not as efficient as using UTF-8 encoding since the implementation internally uses UTF-8. SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) および SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken) も参照してください。See also SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) and SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).

詳細については、「JSON をシリアル化および逆シリアル化する方法」を参照してください。For more information, see How to serialize and deserialize JSON.

適用対象

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

ジェネリック型パラメーターで指定された型の JSON 表現を指定されたライターに書き込みます。Writes the JSON representation of a type specified by a generic type parameter to the provided writer.

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)

型パラメーター

TValue

シリアル化する値の型。The type of the value to serialize.

パラメーター

writer
Utf8JsonWriter

書き込み先の JSON ライター。A JSON writer to write to.

value
TValue

変換して書き込む値。The value to convert and write.

options
JsonSerializerOptions

シリアル化動作を制御するオプション。Options to control serialization behavior.

例外

writernullです。writer is null.

TValue またはそのシリアル化可能なメンバーに対して互換性のある JsonConverter はありません。There is no compatible JsonConverter for TValue or its serializable members.

注釈

JsonWriterOptions インスタンスを作成するために使用されるは、 Utf8JsonWriter 競合するときにより優先され JsonSerializerOptions ます。The JsonWriterOptions used to create the instance of the Utf8JsonWriter take precedence over the JsonSerializerOptions when they conflict. そのため、、、 JsonWriterOptions.Indented JsonWriterOptions.SkipValidation および JsonWriterOptions.Encoder は書き込み中に使用されます。Hence, JsonWriterOptions.Indented, JsonWriterOptions.SkipValidation, and JsonWriterOptions.Encoder are used while writing.

詳細については、「JSON をシリアル化および逆シリアル化する方法」を参照してください。For more information, see How to serialize and deserialize JSON.

適用対象