Jak globalnie ustawić domyślne opcje dla System.Text.Json.JsonSerializer?

AKTUALIZACJA [23.12.2019]: Po części dzięki wkładowi społeczności głosowej ten problem został dodany do mapy drogowej dla .NET 5.0.

AKTUALIZACJA [10.10.2010]: Jeśli chcesz zobaczyć, jak to zachowanie zostało zaimplementowaneSystem.Text.Json.JsonSerializerprzejdź do otwartego numeru GitHub, na który zwrócił uwagę Chris Yungmann, i zważ.

Zamiast tego:

JsonSerializerOptions options = new JsonSerializerOptions
{
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase
    // etc.
};
JsonSerializer.Deserialize<SomeObject>(someJsonString, options);

Chciałbym zrobić coś takiego:

// This property is a pleasant fiction
JsonSerializer.DefaultSettings = new JsonSerializerOptions
{
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase
    // etc.
};

// This uses my options
JsonSerializer.Deserialize<SomeObject>(someJsonString); 

// And somewhere else in the same codebase...
// This also uses my options
JsonSerializer.Deserialize<SomeOtherObject>(someOtherJsonString); 

Mamy nadzieję, że nie JsonSerializerOptionsbędziemy musieli przekazywać instancji dla naszych najczęstszych przypadków i zastępować wyjątek, a nie regułę.

Jak wskazano w tym pytaniu , jest to przydatna funkcja Json.Net. Spojrzałem w dokumentacji dla System.Text.Jsonjak to repo GitHub for .NET Core. I ten jeden .

Wydaje się, że w .NET Core 3 nie ma analogicznego narzędzia do zarządzania domyślnymi serializacjami JSON. Czy mogę to przeoczyć?

Nie, JsonSerializerOptionsnie ujawnia opcji domyślnych . Jeśli używasz określonego frameworka internetowego, może istnieć sposób określenia (de-) ustawień serializacji za jego pośrednictwem. W przeciwnym razie sugeruję stworzenie własnych metod wygody.

Zobacz także ten otwarty problem .

Możesz utworzyć metodę rozszerzenia. Oto przykład

Używam osobnych metod zamiast budowania specjalnych ustawień, dzięki czemu wszystkie ustawienia będą w jednym miejscu i będą łatwe do ponownego użycia.

public static class DeserializeExtensions
{
    private static JsonSerializerOptions defaultSerializerSettings = new JsonSerializerOptions();

    // set this up how you need to!
    private static JsonSerializerOptions featureXSerializerSettings = new JsonSerializerOptions();


    public static T Deserialize<T>(this string json)
    {       
        return JsonSerializer.Deserialize<T>(json, defaultSerializerSettings);
    }

    public static T DeserializeCustom<T>(this string json, JsonSerializerOptions settings)
    {
        return JsonSerializer.Deserialize<T>(json, settings);
    }

    public static T DeserializeFeatureX<T>(this string json)
    {
        return JsonSerializer.Deserialize<T>(json, featureXSerializerSettings);
    }
}

Następnie wywołujesz go jako metodę na łańcuchu, dosłownym lub zmiennym.

    Car result = @"{""Wheels"": 4, ""Doors"": 2}".DeserializeFeatureX<Car>();

Domyślne opcje nie są widoczne w JsonSerializer.NET Core 3.1. Jednak od grudnia 2019 r. Zostało to dodane do mapy drogowej dla wersji 5.0.

Jest uwolnienie .NET 5.0 Oczekuje listopada 2020. Ale nie ma gwarancji, ten konkretny problem zostanie rozwiązany w danym momencie. Oprócz oczekiwania te odpowiedzi sugerują obejścia:

• https://stackoverflow.com/a/58331912/1011722
• https://stackoverflow.com/a/58959198/1011722

Obejście został zaproponowany przez GitHub użytkownika Andre-SS6 następująco:

((JsonSerializerOptions)typeof(JsonSerializerOptions)
    .GetField("s_defaultOptions", 
        System.Reflection.BindingFlags.Static |
        System.Reflection.BindingFlags.NonPublic).GetValue(null))
    .PropertyNameCaseInsensitive = true;

(Jeśli kiedykolwiek przełączysz się na używanie Json.NET)

Wolę i zalecam jawność i przekazywanie ustawień do wszystkich połączeń, ale możesz ustawić wartości domyślne za pomocą DefaultSettings .

JsonConvert.DefaultSettings = () => MySuperJsonSerializerSettings;

i wtedy

var json = JsonConvert.SerializeObject(o1);
var o2 = JsonConvert.DeserializeObject(x);