JsonSerializer.Serialize Metoda

Definicja

Przestrzeń nazw:

System.Text.Json

Zestaw:

System.Text.Json.dll

Przeciążenia

Serialize(Stream, Object, Type, JsonSerializerContext)	Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w Stream.
Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)	Zapisuje jedną wartość JSON (w tym obiekty lub tablice) do dostarczonego składnika zapisywania.
Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)	Zapisuje reprezentację JSON określonego typu w podanym składniku zapisywania.
Serialize(Utf8JsonWriter, Object, JsonTypeInfo)	Zapisuje jedną wartość JSON (w tym obiekty lub tablice) do dostarczonego składnika zapisywania.
Serialize(Stream, Object, Type, JsonSerializerOptions)	Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w Stream.
Serialize(Object, Type, JsonSerializerOptions)	Konwertuje wartość określonego typu na ciąg JSON.
Serialize(Stream, Object, JsonTypeInfo)	Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w Stream.
Serialize(Object, JsonTypeInfo)	Konwertuje podaną wartość na String.
Serialize(Object, Type, JsonSerializerContext)	Konwertuje podaną wartość na String.
Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)	Zapisuje reprezentację JSON typu określonego przez ogólny parametr typu do dostarczonego składnika zapisywania.
Serialize<TValue>(TValue, JsonSerializerOptions)	Konwertuje wartość typu określonego przez parametr typu ogólnego na ciąg JSON.
Serialize<TValue>(TValue, JsonTypeInfo<TValue>)	Konwertuje podaną wartość na String.
Serialize<TValue>(Stream, TValue, JsonSerializerOptions)	Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w Stream.
Serialize<TValue>(Stream, TValue, JsonTypeInfo<TValue>)	Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w Stream.
Serialize<TValue>(Utf8JsonWriter, TValue, JsonTypeInfo<TValue>)	Zapisuje jedną wartość JSON (w tym obiekty lub tablice) do dostarczonego składnika zapisywania.

Serialize(Stream, Object, Type, JsonSerializerContext)

Źródło:

JsonSerializer.Write.Stream.cs

Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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)

Parametry

utf8Json

Stream

Stream do zapisu w formacie UTF-8.

value

Object

Wartość do przekonwertowania.

inputType

Type

Typ value do konwersji.

context

JsonSerializerContext

Dostawca metadanych dla typów możliwych do serializacji.

Wyjątki

ArgumentException

inputType nie jest zgodny z value.

ArgumentNullException

utf8Json, inputTypelub context jest null.

NotSupportedException

Nie ma zgodnych JsonConverter dla inputType ani jego składowych z możliwością serializacji.

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerContext)

Źródło:

JsonSerializer.Write.Utf8JsonWriter.cs

Zapisuje jedną wartość JSON (w tym obiekty lub tablice) do dostarczonego składnika zapisywania.

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)

Parametry

writer

Utf8JsonWriter

Zapis w formacie JSON do zapisu.

value

Object

Wartość do konwersji i zapisu.

inputType

Type

Typ value do konwersji.

context

JsonSerializerContext

Dostawca metadanych dla typów możliwych do serializacji.

Wyjątki

ArgumentException

inputType nie jest zgodny z value.

ArgumentNullException

writer lub inputType jest null.

NotSupportedException

Nie ma zgodnych JsonConverter dla inputType ani jego składowych z możliwością serializacji.

InvalidOperationException

Metoda GetTypeInfo(Type) podanej context zwraca null dla typu do konwersji.

Serialize(Utf8JsonWriter, Object, Type, JsonSerializerOptions)

Źródło:

JsonSerializer.Write.Utf8JsonWriter.cs

Zapisuje reprezentację JSON określonego typu w podanym składniku zapisywania.

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)

Parametry

writer

Utf8JsonWriter

Zapis w formacie JSON do zapisu.

value

Object

Wartość do konwersji i zapisu.

inputType

Type

Typ value do konwersji.

options

JsonSerializerOptions

Opcje kontrolowania zachowania serializacji.

Wyjątki

ArgumentException

inputType nie jest zgodna z value

ArgumentNullException

writer lub inputType jest null.

NotSupportedException

Nie ma zgodnych JsonConverter dla inputType ani jego składowych z możliwością serializacji.

Uwagi

JsonWriterOptions użyte do utworzenia wystąpienia Utf8JsonWriter mają pierwszeństwo przed JsonSerializerOptions w przypadku konfliktu. W związku z tym JsonWriterOptions.Indented, JsonWriterOptions.SkipValidationi JsonWriterOptions.Encoder są używane podczas pisania.

Aby uzyskać więcej informacji, zobacz Jak serializować i deserializowaćJSON.

Serialize(Utf8JsonWriter, Object, JsonTypeInfo)

Źródło:

JsonSerializer.Write.Utf8JsonWriter.cs

Zapisuje jedną wartość JSON (w tym obiekty lub tablice) do dostarczonego składnika zapisywania.

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)

Parametry

writer

Utf8JsonWriter

Pisarz do pisania.

value

Object

Wartość do konwersji i zapisu.

jsonTypeInfo

JsonTypeInfo

Metadane dotyczące typu do konwersji.

Wyjątki

ArgumentNullException

writer lub jsonTypeInfo jest null.

InvalidCastException

value nie jest zgodny z typem jsonTypeInfo.

Serialize(Stream, Object, Type, JsonSerializerOptions)

Źródło:

JsonSerializer.Write.Stream.cs

Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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)

Parametry

utf8Json

Stream

Stream do zapisu w formacie UTF-8.

value

Object

Wartość do przekonwertowania.

inputType

Type

Typ value do konwersji.

options

JsonSerializerOptions

Opcje kontrolowania zachowania konwersji.

Wyjątki

ArgumentException

inputType nie jest zgodny z value.

ArgumentNullException

utf8Json lub inputType jest null.

NotSupportedException

Nie ma zgodnych JsonConverter dla inputType ani jego składowych z możliwością serializacji.

Serialize(Object, Type, JsonSerializerOptions)

Źródło:

JsonSerializer.Write.String.cs

Konwertuje wartość określonego typu na ciąg 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

Parametry

value

Object

Wartość do przekonwertowania.

inputType

Type

Typ value do konwersji.

options

JsonSerializerOptions

Opcje kontrolowania zachowania konwersji.

Zwraca

String

Reprezentacja ciągu JSON wartości.

Wyjątki

ArgumentException

inputType nie jest zgodny z value.

ArgumentNullException

inputType jest null.

NotSupportedException

Nie ma zgodnych JsonConverter dla inputType ani jego składowych z możliwością serializacji.

Uwagi

Użycie String nie jest tak wydajne, jak używanie kodowania UTF-8, ponieważ implementacja wewnętrznie używa utF-8. Zobacz również SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) i SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).

Aby uzyskać więcej informacji, zobacz Jak serializować i deserializowaćJSON.

Serialize(Stream, Object, JsonTypeInfo)

Źródło:

JsonSerializer.Write.Stream.cs

Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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)

Parametry

utf8Json

Stream

Stream do zapisu w formacie UTF-8.

value

Object

Wartość do przekonwertowania.

jsonTypeInfo

JsonTypeInfo

Metadane dotyczące typu do konwersji.

Wyjątki

ArgumentNullException

utf8Json jest null.

InvalidCastException

value nie jest zgodny z typem jsonTypeInfo.

Serialize(Object, JsonTypeInfo)

Źródło:

JsonSerializer.Write.String.cs

Konwertuje podaną wartość na 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

Parametry

value

Object

Wartość do przekonwertowania.

jsonTypeInfo

JsonTypeInfo

Metadane dotyczące typu do konwersji.

Zwraca

String

String reprezentacja wartości.

Wyjątki

ArgumentNullException

jsonTypeInfo jest null.

InvalidCastException

value nie jest zgodny z typem jsonTypeInfo.

Uwagi

Użycie String nie jest tak wydajne, jak używanie kodowania UTF-8, ponieważ implementacja wewnętrznie używa utF-8. Zobacz również SerializeToUtf8Bytes(Object, JsonTypeInfo) i SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken).

Serialize(Object, Type, JsonSerializerContext)

Źródło:

JsonSerializer.Write.String.cs

Konwertuje podaną wartość na 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

Parametry

value

Object

Wartość do przekonwertowania.

inputType

Type

Typ value do konwersji.

context

JsonSerializerContext

Dostawca metadanych dla typów możliwych do serializacji.

Zwraca

String

String reprezentacja wartości.

Wyjątki

NotSupportedException

Nie ma zgodnych JsonConverter dla inputType ani jego składowych z możliwością serializacji.

InvalidOperationException

Metoda GetTypeInfo(Type) podanej context zwraca null dla typu do konwersji.

ArgumentNullException

inputType lub context jest null.

Uwagi

Użycie String nie jest tak wydajne, jak używanie kodowania UTF-8, ponieważ implementacja wewnętrznie używa utF-8. Zobacz również SerializeToUtf8Bytes(Object, Type, JsonSerializerContext) i SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken).

Serialize<TValue>(Utf8JsonWriter, TValue, JsonSerializerOptions)

Źródło:

JsonSerializer.Write.Utf8JsonWriter.cs

Zapisuje reprezentację JSON typu określonego przez ogólny parametr typu do dostarczonego składnika zapisywania.

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)

Parametry typu

TValue

Typ wartości do serializacji.

Parametry

writer

Utf8JsonWriter

Zapis w formacie JSON do zapisu.

value

TValue

Wartość do konwersji i zapisu.

options

JsonSerializerOptions

Opcje kontrolowania zachowania serializacji.

Wyjątki

ArgumentNullException

writer jest null.

NotSupportedException

Nie ma zgodnych JsonConverter dla TValue ani jego składowych z możliwością serializacji.

Uwagi

JsonWriterOptions użyte do utworzenia wystąpienia Utf8JsonWriter mają pierwszeństwo przed JsonSerializerOptions w przypadku konfliktu. W związku z tym JsonWriterOptions.Indented, JsonWriterOptions.SkipValidationi JsonWriterOptions.Encoder są używane podczas pisania.

Aby uzyskać więcej informacji, zobacz Jak serializować i deserializowaćJSON.

Serialize<TValue>(TValue, JsonSerializerOptions)

Źródło:

JsonSerializer.Write.String.cs

Konwertuje wartość typu określonego przez parametr typu ogólnego na ciąg 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

Parametry typu

TValue

Typ wartości do serializacji.

Parametry

value

TValue

Wartość do przekonwertowania.

options

JsonSerializerOptions

Opcje kontrolowania zachowania serializacji.

Zwraca

String

Reprezentacja ciągu JSON wartości.

Wyjątki

NotSupportedException

Nie ma zgodnych JsonConverter dla TValue ani jego składowych z możliwością serializacji.

Uwagi

Użycie String nie jest tak wydajne, jak używanie kodowania UTF-8, ponieważ implementacja wewnętrznie używa utF-8. Zobacz również SerializeToUtf8Bytes(Object, Type, JsonSerializerOptions) i SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken).

Aby uzyskać więcej informacji, zobacz Jak serializować i deserializowaćJSON.

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

Źródło:

JsonSerializer.Write.String.cs

Konwertuje podaną wartość na 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

Parametry typu

TValue

Typ wartości do serializacji.

Parametry

value

TValue

Wartość do przekonwertowania.

jsonTypeInfo

JsonTypeInfo<TValue>

Metadane dotyczące typu do konwersji.

Zwraca

String

String reprezentacja wartości.

Wyjątki

NotSupportedException

Nie ma zgodnych JsonConverter dla TValue ani jego składowych z możliwością serializacji.

ArgumentNullException

jsonTypeInfo jest null.

Uwagi

Użycie String nie jest tak wydajne, jak używanie kodowania UTF-8, ponieważ implementacja wewnętrznie używa utF-8. Zobacz również SerializeToUtf8Bytes<TValue>(TValue, JsonTypeInfo<TValue>) i SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken).

Serialize<TValue>(Stream, TValue, JsonSerializerOptions)

Źródło:

JsonSerializer.Write.Stream.cs

Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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)

Parametry typu

TValue

Typ wartości do serializacji.

Parametry

utf8Json

Stream

Stream do zapisu w formacie UTF-8.

value

TValue

Wartość do przekonwertowania.

options

JsonSerializerOptions

Opcje kontrolowania zachowania konwersji.

Wyjątki

ArgumentNullException

utf8Json jest null.

NotSupportedException

Nie ma zgodnych JsonConverter dla TValue ani jego składowych z możliwością serializacji.

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

Źródło:

JsonSerializer.Write.Stream.cs

Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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))

Parametry typu

TValue

Typ wartości do serializacji.

Parametry

utf8Json

Stream

Stream do zapisu w formacie UTF-8.

value

TValue

Wartość do przekonwertowania.

jsonTypeInfo

JsonTypeInfo<TValue>

Metadane dotyczące typu do konwersji.

Wyjątki

ArgumentNullException

utf8Json jest null.

NotSupportedException

Nie ma zgodnych JsonConverter dla TValue ani jego składowych z możliwością serializacji.

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

Źródło:

JsonSerializer.Write.Utf8JsonWriter.cs

Zapisuje jedną wartość JSON (w tym obiekty lub tablice) do dostarczonego składnika zapisywania.

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

Parametry typu

TValue

Typ wartości do serializacji.

Parametry

writer

Utf8JsonWriter

Pisarz do pisania.

value

TValue

Wartość do konwersji i zapisu.

jsonTypeInfo

JsonTypeInfo<TValue>

Metadane dotyczące typu do konwersji.

Wyjątki

ArgumentNullException

writer lub jsonTypeInfo jest null.

NotSupportedException

Nie ma zgodnych JsonConverter dla TValue ani jego składowych z możliwością serializacji.