Jak ignorovat vlastnosti pomocí System.Text.Json

Článek
02/22/2024

Při serializaci objektů jazyka C# do formátu JSON (JavaScript Object Notation) se ve výchozím nastavení serializují všechny veřejné vlastnosti. Pokud nechcete, aby se některé z nich zobrazovaly ve výsledném formátu JSON, máte několik možností. V tomto článku se dozvíte, jak ignorovat vlastnosti na základě různých kritérií:

Jednotlivé vlastnosti
Všechny vlastnosti jen pro čtení
Všechny vlastnosti s hodnotou null
Všechny vlastnosti výchozí hodnoty

Ignorovat jednotlivé vlastnosti

Pokud chcete ignorovat jednotlivé vlastnosti, použijte atribut [JsonIgnore].

Následující příklad ukazuje typ serializace. Zobrazuje také výstup JSON:

public class WeatherForecastWithIgnoreAttribute
{
    public DateTimeOffset Date { get; set; }
    public int TemperatureCelsius { get; set; }
    [JsonIgnore]
    public string? Summary { get; set; }
}

Public Class WeatherForecastWithIgnoreAttribute
    Public Property [Date] As DateTimeOffset
    Public Property TemperatureCelsius As Integer

    <JsonIgnore>
    Public Property Summary As String

End Class

{
  "Date": "2019-08-01T00:00:00-07:00",
  "TemperatureCelsius": 25,
}

Podmíněné vyloučení můžete zadat nastavením vlastnosti atributu Condition [JsonIgnore]. Výčet JsonIgnoreCondition poskytuje následující možnosti:

Always - Vlastnost je vždy ignorována. Pokud není zadána žádná Condition , předpokládá se tato možnost.
Never - Vlastnost je vždy serializována a deserializována, bez DefaultIgnoreConditionohledu na , IgnoreReadOnlyPropertiesa IgnoreReadOnlyFields globální nastavení.
WhenWritingDefault - Vlastnost je ignorována při serializaci, pokud se jedná o typ odkazu null, typ nullhodnoty null nebo typ defaulthodnoty .
WhenWritingNull - Vlastnost je ignorována při serializaci, pokud se jedná o typ odkazu null, nebo typ nullhodnoty nullable .

Následující příklad ukazuje použití vlastnosti atributu Condition [JsonIgnore]:

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

namespace JsonIgnoreAttributeExample
{
    public class Forecast
    {
        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
        public DateTime Date { get; set; }

        [JsonIgnore(Condition = JsonIgnoreCondition.Never)]
        public int TemperatureC { get; set; }

        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
        public string? Summary { get; set; }
    };

    public class Program
    {
        public static void Main()
        {
            Forecast forecast = new()
            {
                Date = default,
                Summary = null,
                TemperatureC = default
            };

            JsonSerializerOptions options = new()
            {
                DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingDefault
            };

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

            Console.WriteLine(forecastJson);
        }
    }
}

// Produces output like the following example:
//
//{"TemperatureC":0}

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

Namespace JsonIgnoreAttributeExample

    Public Class Forecast

        <JsonIgnore(Condition:=JsonIgnoreCondition.WhenWritingDefault)>
        Public Property [Date] As Date

        <JsonIgnore(Condition:=JsonIgnoreCondition.Never)>
        Public Property TemperatureC As Integer

        <JsonIgnore(Condition:=JsonIgnoreCondition.WhenWritingNull)>
        Public Property Summary As String

    End Class

    Public NotInheritable Class Program

        Public Shared Sub Main()
            Dim forecast1 As New Forecast() With {
                .[Date] = CType(Nothing, Date),
                .Summary = Nothing,
                .TemperatureC = CType(Nothing, Integer)
                }

            Dim options As New JsonSerializerOptions() With {
                .DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingDefault
                }

            Dim forecastJson As String = JsonSerializer.Serialize(forecast1, options)

            Console.WriteLine(forecastJson)
        End Sub

    End Class

End Namespace

' Produces output like the following example:
'
'{"TemperatureC":0}

Ignorovat všechny vlastnosti jen pro čtení

Vlastnost je jen pro čtení, pokud obsahuje veřejný getter, ale ne veřejné setter. Chcete-li při serializaci ignorovat všechny vlastnosti jen pro čtení, nastavte JsonSerializerOptions.IgnoreReadOnlyProperties na hodnotu true, jak je znázorněno v následujícím příkladu:

var options = new JsonSerializerOptions
{
    IgnoreReadOnlyProperties = true,
    WriteIndented = true
};
jsonString = JsonSerializer.Serialize(weatherForecast, options);

Dim options As JsonSerializerOptions = New JsonSerializerOptions With {
    .IgnoreReadOnlyProperties = True,
    .WriteIndented = True
}
jsonString = JsonSerializer.Serialize(weatherForecast, options)

Následující příklad ukazuje typ serializace. Zobrazuje také výstup JSON:

public class WeatherForecastWithROProperty
{
    public DateTimeOffset Date { get; set; }
    public int TemperatureCelsius { get; set; }
    public string? Summary { get; set; }
    public int WindSpeedReadOnly { get; private set; } = 35;
}

Public Class WeatherForecastWithROProperty
    Public Property [Date] As DateTimeOffset
    Public Property TemperatureCelsius As Integer
    Public Property Summary As String
    Private _windSpeedReadOnly As Integer

    Public Property WindSpeedReadOnly As Integer
        Get
            Return _windSpeedReadOnly
        End Get
        Private Set(Value As Integer)
            _windSpeedReadOnly = Value
        End Set
    End Property

End Class

{
  "Date": "2019-08-01T00:00:00-07:00",
  "TemperatureCelsius": 25,
  "Summary": "Hot",
}

Tato možnost se vztahuje pouze na vlastnosti. Pokud chcete při serializaci polí ignorovat pole jen pro čtení, použijte JsonSerializerOptions.IgnoreReadOnlyFields globální nastavení.

Poznámka:

Vlastnosti typu kolekce jen pro čtení jsou stále serializovány, i když JsonSerializerOptions.IgnoreReadOnlyProperties je nastavena na true.

Ignorovat všechny vlastnosti null-hodnota

Chcete-li ignorovat všechny vlastnosti null-hodnota, nastavte DefaultIgnoreCondition vlastnost na WhenWritingNull, jak je znázorněno v následujícím příkladu:

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

namespace IgnoreNullOnSerialize
{
    public class Forecast
    {
        public DateTime Date { get; set; }
        public int TemperatureC { get; set; }
        public string? Summary { get; set; }
    };

    public class Program
    {
        public static void Main()
        {
            Forecast forecast = new()
            {
                Date = DateTime.Now,
                Summary = null,
                TemperatureC = default
            };

            JsonSerializerOptions options = new()
            {
                DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
            };

            string forecastJson =
                JsonSerializer.Serialize<Forecast>(forecast, options);
            
            Console.WriteLine(forecastJson);
        }
    }
}

// Produces output like the following example:
//
//{"Date":"2020-10-30T10:11:40.2359135-07:00","TemperatureC":0}

Imports System.Text.Json

Namespace IgnoreNullOnSerialize

    Public Class Forecast
        Public Property [Date] As Date
        Public Property TemperatureC As Integer
        Public Property Summary As String
    End Class

    Public NotInheritable Class Program

        Public Shared Sub Main()
            Dim forecast1 As New Forecast() With
            {
            .[Date] = Date.Now,
            .Summary = Nothing,
            .TemperatureC = CType(Nothing, Integer)
            }

            Dim options As New JsonSerializerOptions

            Dim forecastJson As String = JsonSerializer.Serialize(forecast1, options)

            Console.WriteLine(forecastJson)
        End Sub

    End Class

End Namespace

' Produces output like the following example:
'
'{"Date":"2020-10-30T10:11:40.2359135-07:00","TemperatureC":0}

Ignorovat všechny vlastnosti výchozí hodnoty

Chcete-li zabránit serializaci výchozích hodnot ve vlastnostech typu hodnoty, nastavte DefaultIgnoreCondition vlastnost na WhenWritingDefault, jak je znázorněno v následujícím příkladu:

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

namespace IgnoreValueDefaultOnSerialize
{
    public class Forecast
    {
        public DateTime Date { get; set; }
        public int TemperatureC { get; set; }
        public string? Summary { get; set; }
    };

    public class Program
    {
        public static void Main()
        {
            Forecast forecast = new()
            {
                Date = DateTime.Now,
                Summary = null,
                TemperatureC = default
            };

            JsonSerializerOptions options = new()
            {
                DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingDefault
            };

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

            Console.WriteLine(forecastJson);
        }
    }
}

// Produces output like the following example:
//
//{ "Date":"2020-10-21T15:40:06.8920138-07:00"}

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

Namespace IgnoreValueDefaultOnSerialize

    Public Class Forecast
        Public Property [Date] As Date
        Public Property TemperatureC As Integer
        Public Property Summary As String
    End Class

    Public NotInheritable Class Program

        Public Shared Sub Main()
            Dim forecast1 As New Forecast() With
            {.[Date] = Date.Now,
              .Summary = Nothing,
              .TemperatureC = CType(Nothing, Integer)
            }

            Dim options As New JsonSerializerOptions() With {
                .DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingDefault
            }

            Dim forecastJson As String = JsonSerializer.Serialize(forecast1, options)

            Console.WriteLine(forecastJson)
        End Sub

    End Class

End Namespace

' Produces output like the following example:
'
'{ "Date":"2020-10-21T15:40:06.8920138-07:00"}

Nastavení WhenWritingDefault také zabraňuje serializaci typu odkazu null-hodnota a vlastnosti typu hodnoty null.

Sdílet prostřednictvím

Jak ignorovat vlastnosti pomocí System.Text.Json

Ignorovat jednotlivé vlastnosti

Ignorovat všechny vlastnosti jen pro čtení

Ignorovat všechny vlastnosti null-hodnota

Ignorovat všechny vlastnosti výchozí hodnoty

Viz také

Další materiály