.NET 8 nicht-öffentliche Member in die JSON-Serialisierung einbeziehen

Ab .NET 8 lassen sich beim Einsatz von System.Text.Json auch nicht-öffentliche Properties in die Serialisierung einbeziehen. Dazu versehen Sie die nicht-öffentliche Property einfach mit dem Attribut JsonIncludeAttribute.

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)]
public sealed class JsonIncludeAttribute : System.Text.Json.Serialization.JsonAttribute

Das Attribut funktioniert mit jedem nicht-öffentlichen Modifier, also private, protected oder internal. Sehen wir uns ein Beispiel an:

string json = JsonSerializer.Serialize(new MyClass(1, 2, 3));

Console.WriteLine(json);

public class MyClass
{
    public MyClass(int privateProperty, int protectedProperty, int internalProperty)
    {
        PrivateProperty = privateProperty;
        ProtectedProperty = protectedProperty;
        InternalProperty = internalProperty;
    }

    [JsonInclude]
    private int PrivateProperty { get; }

    [JsonInclude]
    protected int ProtectedProperty { get; }

    [JsonInclude]
    internal int InternalProperty { get; }
}

Wie zu erwarten, ergibt das die folgende Ausgabe:

{"PrivateProperty":1,"ProtectedProperty":2,"InternalProperty":3}