用枚举数组反序列化 json

Question

使用枚举：

namespace AppGlobals
{
    [JsonConverter(typeof(JsonStringEnumConverter))]
    public enum BoardSymbols
    {
        [EnumMember(Value = "X")]
        First = 'X',
        [EnumMember(Value = "O")]
        Second = 'O',
        [EnumMember(Value = "?")]
        EMPTY = '?'
    }
}

我想为我的api定义一个模型：

using System;
using System.ComponentModel.DataAnnotations;
using System.Text.Json.Serialization;
using Newtonsoft.Json;

namespace Assignment_1
{
    public class MyRequest
    {
//...
        [Required]
        [MinLength(9)]
        [MaxLength(9)]
        [JsonProperty("changeTypes", ItemConverterType = typeof(JsonStringEnumConverter))]
        public AppGlobals.BoardSymbols[] GameBoard { get; set; }
    }
}

其中 GameBoard 应序列化为 JSON 作为字符串数组，其名称由 EnumMember 属性指定。这种方法改编自 Deserialize json character as enumeration。但是，它不起作用。如果我将枚举更改为：

，这确实有效

    [JsonConverter(typeof(JsonStringEnumConverter))]
    public enum BoardSymbols
    {
      X='X',
      Y='Y'
    }

但我显然在 'empty' 枚举上遇到了限制。我该怎么做？

更新 2：

我的启动中没有 AddNewtonsoftJson()，完全转换为 Newtonsoft。现在我的错误可能更可操作：

System.InvalidCastException: Unable to cast object of type 'CustomJsonStringEnumConverter' to type 'Newtonsoft.Json.JsonConverter'.
   at Newtonsoft.Json.Serialization.JsonTypeReflector.CreateJsonConverterInstance(Type converterType, Object[] args)

这是有道理的，给我规定的解决方案指定了一个 JsonConverterFactory ..我只需要原始的 JsonConverter 作为我的用例。

Answer 1

TL/DR: 你这里有两个基本问题:

.NET Core 3.0+ 有一个 new built-in JSON serializer System.Text.Json, and you are mixing up attributes and classes between this new serializer and Json.NET。当两者都安装时，这很容易做到，因为它们共享一些 class 名称，例如 JsonSerializer 和 JsonConverter.
默认使用新的序列化程序，但尚不支持将枚举序列化为具有自定义值名称的字符串；详情见。

解决问题的最简单方法是切换回 Json.NET，如图并使用此序列化程序独有的属性、转换器和命名空间。

首先我们来分析一下这两个序列化器的异同点：

System.Text.Json:
- 自动内置到 .NET Core 3.0+ 中并用于 JSON 由 ASP.NET Core 3.0+ by default.
  [=151 序列化=]
- 命名空间 System.Text.Json and System.Text.Json.Serialization.
- 类包括 System.Text.Json.Serialization.JsonConverter, System.Text.Json.Serialization.JsonConverter<T> and System.Text.Json.JsonSerializer.
- 属性包括System.Text.Json.Serialization.JsonPropertyNameAttribute, System.Text.Json.Serialization.JsonConverterAttribute and System.Text.Json.Serialization.JsonExtensionDataAttribute.
- System.Text.Json.Serialization.JsonStringEnumConverter 支持将枚举序列化为字符串，但是 未实现通过属性重命名。
  
  请参阅至以了解可能的解决方法。
Json.NET:
- 可用于在 ASP.NET Core 3.0+ 中序列化的第 3 方库，方法是添加对 Microsoft.AspNetCore.Mvc.NewtonsoftJson 的 NuGet 引用，然后在中调用 AddNewtonsoftJson() Startup.ConfigureServices.
  
  有关详细信息，请参阅 to by poke。
- 命名空间包括 Newtonsoft.Json, Newtonsoft.Json.Converters, Newtonsoft.Json.Linq and Newtonsoft.Json.Serialization among others.
- 类包括 Newtonsoft.Json.JsonConverter, Newtonsoft.Json.JsonConverter<T> and Newtonsoft.Json.JsonSerializer
- 属性包括Newtonsoft.Json.JsonPropertyAttribute, Newtonsoft.Json.JsonConverterAttribute and Newtonsoft.Json.JsonExtensionDataAttribute among others.
- 应用 Newtonsoft.Json.Converters.StringEnumConverter when the EnumMemberAttribute 属性自动支持将枚举序列化为重命名的字符串。

考虑到这一点，您在代码中使用了哪个序列化程序？由于您在问题中包含了命名空间，因此我们可以检查：

using System.Text.Json.Serialization; // System.Text.Json
using Newtonsoft.Json;                // Json.NET

namespace Assignment_1
{
    public class MyRequest
    {
//...
        [JsonProperty(                                         // JsonProperty from Newtonsoft
            "changeTypes", 
            ItemConverterType = typeof(JsonStringEnumConverter)// JsonStringEnumConverter from System.Text.Json
        )]
        public AppGlobals.BoardSymbols[] GameBoard { get; set; }
    }
}

如您所见，您将 Newtonsoft 的属性与 System.Text.Json 的转换器混在一起，这是行不通的。（也许您在 Visual Studio 中通过 "Resolve -> using ..." 右键单击选择了命名空间？）

那么，如何解决问题呢？由于 Json.NET 支持开箱即用的枚举值重命名，解决问题的最简单方法是使用此序列化程序。虽然性能可能不如 System.Text.Json，但它更完整，功能更全面。

为此，从您的代码中删除 命名空间 System.Text.Json.Serialization 和 System.Text.Json 以及对类型 JsonStringEnumConverter 的引用，并修改 MyRequest和BoardSymbols如下：

using System.Runtime.Serialization;
using Newtonsoft.Json.Converters;
using Newtonsoft.Json;

namespace Assignment_1
{
    public class MyRequest
    {
//...
        [Required]
        [MinLength(9)]
        [MaxLength(9)]
        [JsonProperty("changeTypes")] // No need to add StringEnumConverter here since it's already applied to the enum itself
        public AppGlobals.BoardSymbols[] GameBoard { get; set; }
    }
}

namespace AppGlobals
{
    [JsonConverter(typeof(StringEnumConverter))]
    public enum BoardSymbols
    {
        [EnumMember(Value = "X")]
        First = 'X',
        [EnumMember(Value = "O")]
        Second = 'O',
        [EnumMember(Value = "?")]
        EMPTY = '?'
    }
}

然后 NuGet Microsoft.AspNetCore.Mvc.NewtonsoftJson 并在 Startup.ConfigureServices 中调用 AddNewtonsoftJson():

services.AddMvc()
    .AddNewtonsoftJson();

或者如果您更喜欢全局使用 StringEnumConverter：

services.AddMvc()
    .AddNewtonsoftJson(o => o.SerializerSettings.Converters.Add(new Newtonsoft.Json.Converters.StringEnumConverter()));

请注意 docs

中的以下评论

Note: If the AddNewtonsoftJson method isn't available, make sure that you installed the Microsoft.AspNetCore.Mvc.NewtonsoftJson package. A common error is to install the Newtonsoft.Json package instead of the Microsoft.AspNetCore.Mvc.NewtonsoftJson package.

模型 fiddle here.

Answer 2

您可以创建您自己的 JsonStringEnumAttribute 并用它装饰您的枚举。

using System.Text.Json.Serialization;

class JsonStringEnumAttribute : JsonConverterAttribute
{
    public JsonStringEnumAttribute() : base(typeof(JsonStringEnumConverter))
    {

    }
}

然后把它放在你的枚举上：

[JsonStringEnum]
enum MyEnum
{
    Value1,
    Value2
}

然后您可以使用字符串值像这样反序列化 JSON：

{
    "MyEnumProperty1": "Value1",
    "MyEnumProperty2": ["Value2", "Value1"]
}

变成这样的class：

class MyClass
{
    MyEnum MyEnumProperty1 { get; set; }
    MyEnum[] MyEnumProperty2 { get; set; }
}

使用，例如，System.Net.Http.Json:

using HttpClient client = new();
var myObjects = await client.GetFromJsonAsync<MyClass>("/some-endpoint");

用枚举数组反序列化 json

deserialize json with array of enum

c#

asp.net

json.net

asp.net-core-webapi

asp.net-core-3.1

更新 2：