如何为 System.Text.Json.JsonSerializer 全局设置默认选项？

Question

而不是这个：

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

我想做这样的事情：

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

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

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

希望在我们最常见的情况下不必传递JsonSerializerOptions 的实例，并为异常而不是规则覆盖。

如this q & a 所示，这是 Json.Net 的一个有用功能。我在the documentation 中查看了System.Text.Json 以及this GitHub repo 中的.NET Core。还有this one。

在 .NET Core 3 中似乎没有管理 JSON 序列化默认值的类比。还是我忽略了它？

---

• 更新 [2020-07-18]： 请参阅 this answer 了解 nuget package 以及支持默认设置的便捷方法。

• 更新 [2019 年 12 月 23 日]： 部分由于 community input 这个问题在 .NET 5.0 中是 added to the roadmap。

• 更新 [2019-10-10]： 如果有兴趣看到为 System.Text.Json.JsonSerializer 实施此行为，请前往致Chris Yungmann指出的the open GitHub issue并称重。

Answer 1

您可以创建扩展方法。 Here's an example

我使用单独的方法而不是必须构建特殊设置，以便所有设置都在一个位置并且易于重复使用。

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

然后您将其作为字符串的方法调用，无论是文字还是变量。

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

Answer 2

不，JsonSerializerOptions 不会公开default options。如果您使用的是特定的 Web 框架，则可能有一种方法可以通过它指定（反）序列化设置。否则，我建议您创建自己的便捷方法。

另见this open issue。

Answer 3

默认选项未在 .NET Core 3.1 的 JsonSerializer 中公开。但是，截至 2019 年 12 月，对于 5.0，这一直是 added to the road map。

.NET 5.0 的发布日期为 expected2020 年 11 月。但不能保证此特定问题会在任何特定时间得到解决。除了等待之外，这些答案还提供了一些解决方法：

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

此外，受@ps2goat 的回答启发，我打包了我的便利扩展方法，并将它们放在nuget.org 和github 上：

• https://www.nuget.org/packages/Fetchgoods.Text.Json.Extensions/

Answer 4

这似乎对我有用，在 StartUp.ConfigureServices 中：

services.AddControllers().AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
        options.JsonSerializerOptions.PropertyNamingPolicy=JsonNamingPolicy.CamelCase;
    });

Answer 5

GitHub用户andre-ss6提出了一个workaround，如下：

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

Answer 6

（如果你曾经改用 Json.NET）

我更喜欢并建议使用明确的设置并将设置传递给所有调用，但您可以使用 DefaultSettings 设置默认值。

JsonConvert.DefaultSettings = () => MySuperJsonSerializerSettings;

然后

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