c# - 如何为 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为我们最常见的情况传递一个实例，并为异常而不是规则覆盖。

如本问答所述，这是 Json.Net 的一个有用功能。我查看了.NET Core的文档以及这个 GitHub 存储库。而这个。System.Text.Json

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

---

• 更新 [2020-07-18]： 请参阅此答案以获取具有遵循默认设置的便捷方法的nuget 包。

• 更新 [2019-12-23]： 部分由于社区的声音输入，此问题已添加到.NET 5.0的路线图中。

• 更新 [2019-10-10]： 如果有兴趣看到这种行为的实施，请System.Text.Json.JsonSerializer直接前往Chris Yungmann指出的开放 GitHub 问题并权衡。

Answer 1

您可以创建扩展方法。这是一个例子

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

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不公开默认选项。如果您使用的是特定的 Web 框架，则可能有一种方法可以通过它指定（反）序列化设置。否则，我建议创建自己的便捷方法。

另请参阅此未解决的问题。

Answer 3

JsonSerializer.NET Core 3.1未公开默认选项。但是，截至 2019 年 12 月，这已添加到5.0的路线图中。

.NET 5.0预计于 2020 年 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提出了一种解决方法，如下所示：

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