Onveranderbare typen en eigenschappen gebruiken

Artikel
10/26/2023

Een onveranderbaar type is een type dat voorkomt dat u eigenschaps- of veldwaarden van een object wijzigt nadat het is geïnstantieerd. Het type kan een record zijn, geen openbare eigenschappen of velden hebben, alleen-lezeneigenschappen hebben of eigenschappen hebben met privé- of init-only-setters. System.String is een voorbeeld van een onveranderbaar type. System.Text.Json biedt verschillende manieren waarop u JSON kunt deserialiseren naar onveranderbare typen.

Geparameteriseerde constructors

System.Text.Json Standaard wordt de standaard openbare constructor zonder parameters gebruikt. U kunt het echter vertellen om een geparameteriseerde constructor te gebruiken, waardoor het mogelijk is om een onveranderbare klasse of struct te deserialiseren.

Als voor een klasse de enige constructor een geparameteriseerde is, wordt die constructor gebruikt.

Geef voor een struct, of een klasse met meerdere constructors, de klasse op die moet worden gebruikt door het kenmerk [JsonConstructor] toe te passen. Wanneer het kenmerk niet wordt gebruikt, wordt er altijd een openbare parameterloze constructor gebruikt, indien aanwezig.

In het volgende voorbeeld wordt het [JsonConstructor] kenmerk gebruikt:

using System.Text.Json;
using System.Text.Json.Serialization;

namespace ImmutableTypes
{
    public struct Forecast
    {
        public DateTime Date { get; }
        public int TemperatureC { get; }
        public string Summary { get; }

        [JsonConstructor]
        public Forecast(DateTime date, int temperatureC, string summary) =>
            (Date, TemperatureC, Summary) = (date, temperatureC, summary);
    }

    public class Program
    {
        public static void Main()
        {
            string json = """
                {
                    "date":"2020-09-06T11:31:01.923395-07:00",
                    "temperatureC":-1,
                    "summary":"Cold"
                }
                """;
            Console.WriteLine($"Input JSON: {json}");

            var options = JsonSerializerOptions.Web;

            Forecast forecast = JsonSerializer.Deserialize<Forecast>(json, options);

            Console.WriteLine($"forecast.Date: {forecast.Date}");
            Console.WriteLine($"forecast.TemperatureC: {forecast.TemperatureC}");
            Console.WriteLine($"forecast.Summary: {forecast.Summary}");

            string roundTrippedJson =
                JsonSerializer.Serialize<Forecast>(forecast, options);

            Console.WriteLine($"Output JSON: {roundTrippedJson}");
        }
    }
}

// Produces output like the following example:
//
//Input JSON: { "date":"2020-09-06T11:31:01.923395-07:00","temperatureC":-1,"summary":"Cold"}
//forecast.Date: 9 / 6 / 2020 11:31:01 AM
//forecast.TemperatureC: -1
//forecast.Summary: Cold
//Output JSON: { "date":"2020-09-06T11:31:01.923395-07:00","temperatureC":-1,"summary":"Cold"}

Imports System.Text.Json
Imports System.Text.Json.Serialization

Namespace ImmutableTypes

    Public Structure Forecast
        Public ReadOnly Property [Date] As Date
        Public ReadOnly Property TemperatureC As Integer
        Public ReadOnly Property Summary As String

        <JsonConstructor>
        Public Sub New([Date] As Date, TemperatureC As Integer, Summary As String)
            Me.Date = [Date]
            Me.TemperatureC = TemperatureC
            Me.Summary = Summary
        End Sub

    End Structure

    Public NotInheritable Class Program

        Public Shared Sub Main()
            Dim json As String = "{""date"":""2020-09-06T11:31:01.923395-07:00"",""temperatureC"":-1,""summary"":""Cold""}"
            Console.WriteLine($"Input JSON: {json}")

            Dim forecast1 As Forecast = JsonSerializer.Deserialize(Of Forecast)(json, JsonSerializerOptions.Web)

            Console.WriteLine($"forecast.Date: {forecast1.[Date]}")
            Console.WriteLine($"forecast.TemperatureC: {forecast1.TemperatureC}")
            Console.WriteLine($"forecast.Summary: {forecast1.Summary}")

            Dim roundTrippedJson As String = JsonSerializer.Serialize(forecast1, JsonSerializerOptions.Web)

            Console.WriteLine($"Output JSON: {roundTrippedJson}")
        End Sub

    End Class

End Namespace

' Produces output like the following example:
'
'Input JSON: { "date":"2020-09-06T11:31:01.923395-07:00","temperatureC":-1,"summary":"Cold"}
'forecast.Date: 9 / 6 / 2020 11:31:01 AM
'forecast.TemperatureC: -1
'forecast.Summary: Cold
'Output JSON: { "date":"2020-09-06T11:31:01.923395-07:00","temperatureC":-1,"summary":"Cold"}

In .NET 7 en eerdere versies kan het [JsonConstructor] kenmerk alleen worden gebruikt met openbare constructors.

De parameternamen van een geparameteriseerde constructor moeten overeenkomen met de eigenschapsnamen en -typen. Matching is niet hoofdlettergevoelig en de constructorparameter moet overeenkomen met de werkelijke eigenschapsnaam, zelfs als u [JsonPropertyName] gebruikt om de naam van een eigenschap te wijzigen. In het volgende voorbeeld wordt de naam van de TemperatureC eigenschap gewijzigd celsius in de JSON, maar de constructorparameter heeft nog steeds de naam temperatureC:

using System.Text.Json;
using System.Text.Json.Serialization;

namespace ImmutableTypesCtorParms
{
    public readonly struct Forecast
    {
        public DateTime Date { get; }
        [JsonPropertyName("celsius")]
        public int TemperatureC { get; }
        public string Summary { get; }

        [JsonConstructor]
        public Forecast(DateTime date, int temperatureC, string summary) =>
            (Date, TemperatureC, Summary) = (date, temperatureC, summary);
    }

    public class Program
    {
        public static void Main()
        {
            string json = """
                {
                    "date":"2020-09-06T11:31:01.923395-07:00",
                    "celsius":-1,
                    "summary":"Cold"
                }
                """;
            Console.WriteLine($"Input JSON: {json}");

            var options = JsonSerializerOptions.Web;

            Forecast forecast = JsonSerializer.Deserialize<Forecast>(json, options);

            Console.WriteLine($"forecast.Date: {forecast.Date}");
            Console.WriteLine($"forecast.TemperatureC: {forecast.TemperatureC}");
            Console.WriteLine($"forecast.Summary: {forecast.Summary}");

            string roundTrippedJson =
                JsonSerializer.Serialize<Forecast>(forecast, options);

            Console.WriteLine($"Output JSON: {roundTrippedJson}");

        }
    }
}

// Produces output like the following example:
//
//Input JSON: { "date":"2020-09-06T11:31:01.923395-07:00","celsius":-1,"summary":"Cold"}
//forecast.Date: 9 / 6 / 2020 11:31:01 AM
//forecast.TemperatureC: -1
//forecast.Summary: Cold
//Output JSON: { "date":"2020-09-06T11:31:01.923395-07:00","celsius":-1,"summary":"Cold"}

Bovendien [JsonPropertyName]ondersteunen de volgende kenmerken deserialisatie met geparameteriseerde constructors:

Records

Records worden ook ondersteund voor serialisatie en deserialisatie, zoals wordt weergegeven in het volgende voorbeeld:

using System.Text.Json;

namespace Records
{
    public record Forecast(DateTime Date, int TemperatureC)
    {
        public string? Summary { get; init; }
    };

    public class Program
    {
        public static void Main()
        {
            Forecast forecast = new(DateTime.Now, 40)
            {
                Summary = "Hot!"
            };

            string forecastJson = JsonSerializer.Serialize<Forecast>(forecast);
            Console.WriteLine(forecastJson);
            Forecast? forecastObj = JsonSerializer.Deserialize<Forecast>(forecastJson);
            Console.WriteLine(forecastObj);
        }
    }
}

// Produces output like the following example:
//
//{ "Date":"2020-10-21T15:26:10.5044594-07:00","TemperatureC":40,"Summary":"Hot!"}
//Forecast { Date = 10 / 21 / 2020 3:26:10 PM, TemperatureC = 40, Summary = Hot! }

U kunt een van de kenmerken toepassen op de eigenschapsnamen, met behulp van het property: doel op het kenmerk. Zie het artikel over records in de C#-taal voor meer informatie over positionele records.

Niet-openbare leden en eigenschapstoegangsors

U kunt het gebruik van een niet-openbare toegangsfunctie voor een eigenschap inschakelen met behulp van het kenmerk [JsonInclude] , zoals wordt weergegeven in het volgende voorbeeld:

using System.Text.Json;
using System.Text.Json.Serialization;

namespace NonPublicAccessors
{
    public class Forecast
    {
        public DateTime Date { get; init; }

        [JsonInclude]
        public int TemperatureC { get; private set; }

        [JsonInclude]
        public string? Summary { private get; set; }
    };

    public class Program
    {
        public static void Main()
        {
            string json = """
                {
                    "Date":"2020-10-23T09:51:03.8702889-07:00",
                    "TemperatureC":40,
                    "Summary":"Hot"
                }
                """;
            Console.WriteLine($"Input JSON: {json}");

            Forecast forecastDeserialized = JsonSerializer.Deserialize<Forecast>(json)!;
            Console.WriteLine($"Date: {forecastDeserialized.Date}");
            Console.WriteLine($"TemperatureC: {forecastDeserialized.TemperatureC}");

            json = JsonSerializer.Serialize<Forecast>(forecastDeserialized);
            Console.WriteLine($"Output JSON: {json}");
        }
    }
}

// Produces output like the following example:
//
//Input JSON: { "Date":"2020-10-23T09:51:03.8702889-07:00","TemperatureC":40,"Summary":"Hot"}
//Date: 10 / 23 / 2020 9:51:03 AM
//TemperatureC: 40
//Output JSON: { "Date":"2020-10-23T09:51:03.8702889-07:00","TemperatureC":40,"Summary":"Hot"}

Imports System.Text.Json
Imports System.Text.Json.Serialization

Namespace NonPublicAccessors

    Public Class Forecast
        Public Property [Date] As Date

        Private _temperatureC As Integer

        <JsonInclude>
        Public Property TemperatureC As Integer
            Get
                Return _temperatureC
            End Get
            Private Set(Value As Integer)
                _temperatureC = Value
            End Set
        End Property

        Private _summary As String

        <JsonInclude>
        Public Property Summary As String
            Private Get
                Return _summary
            End Get
            Set(Value As String)
                _summary = Value
            End Set
        End Property

    End Class

    Public NotInheritable Class Program

        Public Shared Sub Main()
            Dim json As String = "{""Date"":""2020-10-23T09:51:03.8702889-07:00"",""TemperatureC"":40,""Summary"":""Hot""}"
            Console.WriteLine($"Input JSON: {json}")

            Dim forecastDeserialized As Forecast = JsonSerializer.Deserialize(Of Forecast)(json)
            Console.WriteLine($"Date: {forecastDeserialized.[Date]}")
            Console.WriteLine($"TemperatureC: {forecastDeserialized.TemperatureC}")

            json = JsonSerializer.Serialize(forecastDeserialized)
            Console.WriteLine($"Output JSON: {json}")
        End Sub

    End Class

End Namespace

' Produces output like the following example:
'
'Input JSON: { "Date":"2020-10-23T09:51:03.8702889-07:00","TemperatureC":40,"Summary":"Hot"}
'Date: 10 / 23 / 2020 9:51:03 AM
'TemperatureC: 40
'Output JSON: { "Date":"2020-10-23T09:51:03.8702889-07:00","TemperatureC":40,"Summary":"Hot"}

Door een eigenschap met een privé-setter op te delen, kunt u die eigenschap nog steeds deserialiseren.

In .NET 8 en latere versies kunt u ook het kenmerk [JsonInclude] gebruiken om niet-openbare leden aan te geven in het serialisatiecontract voor een bepaald type.

Notitie

In de brongeneratiemodus kunt u leden niet serialiseren private of accessors gebruiken private door aantekeningen te maken met het kenmerk [JsonInclude]. En u kunt alleen leden serialiseren internal of accessors gebruiken internal als ze zich in dezelfde assembly bevinden als de gegenereerde JsonSerializerContext.

Alleen-lezen eigenschappen

In .NET 8 en latere versies kunnen alleen-lezen eigenschappen of eigenschappen zonder setter privé of openbaar worden gedeserialiseerd. Hoewel u het exemplaar waarnaar de eigenschap verwijst niet kunt wijzigen, kunt u het wijzigen als het type van de eigenschap onveranderbaar is. U kunt bijvoorbeeld een element toevoegen aan een lijst. Als u een eigenschap met het kenmerk Alleen-lezen wilt deserialiseren, moet u het gedrag voor het maken van objecten zo instellen dat deze wordt ingevuld in plaats van vervangen. U kunt bijvoorbeeld aantekeningen toevoegen aan de eigenschap met het JsonObjectCreationHandlingAttribute kenmerk.

class A
{
    [JsonObjectCreationHandling(JsonObjectCreationHandling.Populate)]
    public List<int> Numbers1 { get; } = new List<int>() { 1, 2, 3 };
}

Zie Geïnitialiseerde eigenschappen vullen voor meer informatie.

Share via

Onveranderbare typen en eigenschappen gebruiken

Geparameteriseerde constructors

Records

Niet-openbare leden en eigenschapstoegangsors

Alleen-lezen eigenschappen

Zie ook

Aanvullende resources