34

使用 .NET Core 中的System.Text.Json序列化程序功能，如何为枚举值指定自定义值，类似于JsonPropertyName？例如：

public enum Example {
  Trick, 
  Treat, 
  [JsonPropertyName("Trick-Or-Treat")] // Error: Attribute 'JsonPropertyName' is not valid on this declaration type. It is only valid on 'property, indexer' declarations.
   TrickOrTreat
}
4

3 回答 3

34

中不支持开箱即用。当前存在一个未解决的问题Support for EnumMemberAttribute in JsonConverterEnum #31081请求此功能。在此期间，您将需要创建自己的JsonConverterFactory序列化枚举，该枚举具有由属性指定的自定义值名称。

如果您需要使用自定义值名称往返枚举，则需要从头开始创建通用转换器 + 转换器工厂。这在一般情况下有些涉及，因为有必要处理整数和字符串值的解析，[Flags]枚举值的每个组件的重命名，以及所有可能的基础类型（byte、short、int、long等ulong）的枚举。

JsonStringEnumMemberConverter当枚举用属性装饰时， fromMacross.Json.Extensions似乎提供了此功能；[EnumMember(Value = "custom name")]安装软件包Macross.Json.Extensions，然后执行：

[JsonConverter(typeof(System.Text.Json.Serialization.JsonStringEnumMemberConverter))]  // This custom converter was placed in a system namespace.
public enum Example 
{
  Trick,
  Treat,
  [EnumMember(Value = "Trick-Or-Treat")]
   TrickOrTreat,
}

有关使用详细信息，请参阅此处的文档。

或者，您可以使用 Json.NETStringEnumConverter作为参考模型来创建自己的模型。

如果您只需要使用自定义值名称序列化枚举，则可以通过创建一个来更轻松地完成此操作，该方法通过为每种类型构造一个自定义来JsonConverterFactory适应，该类型查找枚举成员上是否存在属性，如果找到，则映射成员名称到属性的值。（我之所以选择这是因为这是 Newtonsoft 支持的属性。）JsonStringEnumConverterJsonNamingPolicyenum[EnumMember(Value = "xxx")]EnumMember

首先介绍如下转换器：

public class CustomJsonStringEnumConverter : JsonConverterFactory
{
    private readonly JsonNamingPolicy namingPolicy;
    private readonly bool allowIntegerValues;
    private readonly JsonStringEnumConverter baseConverter;

    public CustomJsonStringEnumConverter() : this(null, true) { }

    public CustomJsonStringEnumConverter(JsonNamingPolicy namingPolicy = null, bool allowIntegerValues = true)
    {
        this.namingPolicy = namingPolicy;
        this.allowIntegerValues = allowIntegerValues;
        this.baseConverter = new JsonStringEnumConverter(namingPolicy, allowIntegerValues);
    }
    
    public override bool CanConvert(Type typeToConvert) => baseConverter.CanConvert(typeToConvert);

    public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options)
    {
        var query = from field in typeToConvert.GetFields(BindingFlags.Public | BindingFlags.Static)
                    let attr = field.GetCustomAttribute<EnumMemberAttribute>()
                    where attr != null
                    select (field.Name, attr.Value);
        var dictionary = query.ToDictionary(p => p.Item1, p => p.Item2);
        if (dictionary.Count > 0)
        {
            return new JsonStringEnumConverter(new DictionaryLookupNamingPolicy(dictionary, namingPolicy), allowIntegerValues).CreateConverter(typeToConvert, options);
        }
        else
        {
            return baseConverter.CreateConverter(typeToConvert, options);
        }
    }
}

public class JsonNamingPolicyDecorator : JsonNamingPolicy 
{
    readonly JsonNamingPolicy underlyingNamingPolicy;
    
    public JsonNamingPolicyDecorator(JsonNamingPolicy underlyingNamingPolicy) => this.underlyingNamingPolicy = underlyingNamingPolicy;

    public override string ConvertName (string name) => underlyingNamingPolicy == null ? name : underlyingNamingPolicy.ConvertName(name);
}

internal class DictionaryLookupNamingPolicy : JsonNamingPolicyDecorator 
{
    readonly Dictionary<string, string> dictionary;

    public DictionaryLookupNamingPolicy(Dictionary<string, string> dictionary, JsonNamingPolicy underlyingNamingPolicy) : base(underlyingNamingPolicy) => this.dictionary = dictionary ?? throw new ArgumentNullException();
    
    public override string ConvertName (string name) => dictionary.TryGetValue(name, out var value) ? value : base.ConvertName(name);
}

然后装饰你的enum：

public enum Example 
{
  Trick,
  Treat,
  [EnumMember(Value = "Trick-Or-Treat")]
   TrickOrTreat,
}

并按如下方式独立使用转换器：

var options = new JsonSerializerOptions
{
    Converters = { new CustomJsonStringEnumConverter() },
    WriteIndented = true,
};
var json = JsonSerializer.Serialize(values, options);

要将转换器注册到 asp.net 核心，请参阅例如这个对JsonConverter 等效的答案，即Mani Gandham的using System.Text.Json 。

笔记：

  • 这种方法只适用于序列化，因为JsonConverterFactory在反序列化过程中忽略了它的命名策略；请参阅System.Text.Json：JsonStringEnumConverter 在反序列化期间忽略其 JsonNamingPolicy。#31619了解详情。

  • 在 .Net Core 3.x 中，转换器可能无法按需要使用[Flags]枚举，例如：

    [Flags]
public enum Example 
{
  Trick = (1<<0),
  Treat = (1<<1),
  [EnumMember(Value = "Trick-Or-Treat")]
   TrickOrTreat = (1<<2),
}

    像这样的简单值Example.TrickOrTreat被正确地重命名，但像这样的复合值Example.Trick | Example.TrickOrTreat不是。后者的结果应该是"Trick, Trick-Or-Treat"but is "Trick, TrickOrTreat"。

    JsonConverterEnum<T>问题的原因是每个特定枚举类型的底层T调用ConvertName一次使用构造的复合名称，而不是多次使用复合名称的每个组件。如果需要解决方法，DictionaryLookupNamingPolicy.ConvertName()您可以尝试将传入的名称拆分为逗号分隔的组件，重新映射每个组件，然后重新组合结果。

    为了比较，Json.NET对复合标志值的每个组件StringEnumConverter调用等效方法，这似乎更正确。NamingStrategy.ResolvePropertyName(string name)

    在 .Net 5 中，此问题已修复，有关详细信息，请参阅问题 #31622。

演示小提琴在这里。

于 2019-11-27T00:20:03.547 回答
-1

在和中，Microsoft 通过JsonStringEnumConverter Class添加了对反序列化枚举的支持。

像这样装饰您的枚举值：

using System.Runtime.Serialization;
public enum VipStatus
{
    [EnumMember(Value = @"IS_VIP")]
    VIP = 1,

    [EnumMember(Value = @"IS_NOT_VIP")]
    NonVIP = 2,
}

给定一个像这样的类：

class MyClass {
    public VipStatus MyVipStatus { get; set; }
}

您可以使用 JsonStringEnumConverter 内联来序列化类的实例，如下所示：

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

var myObjectWithEnums = new MyClass()
{
    MyVipStatus = VipStatus.NonVIP
};

var options = new JsonSerializerOptions();

// Configures serialization to allow strings to be accepted and auto-converted to enum values.
options.Converters.Add(new JsonStringEnumConverter());

var json = JsonSerializer.Serialize(myObjectWithEnums, options);
// serialized output is: { "myVipStatus": "IS_NOT_VIP"}

如果您使用的是 ASP.NET Core 5，那么您可以在启动时配置应用程序以使用 JsonStringEnumConverter 序列化所有传入请求：

public async void ConfigureServices(IServiceCollection services) {
    // ...
    services
        .AddControllers()
        .AddJsonOptions(options => {
            // Configures serialization to allow strings to be accepted and auto-converted to enum values.
            options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
        }
    // ...
});

更多阅读：如何在 .NET Core 中序列化和反序列化（编组和解组）JSON。如果您在 ASP.NET 中工作，那么这也很有趣：Web defaults for JsonSerializerOptions。

于 2021-04-21T15:56:01.580 回答
-1

如果是 .NET 5：

services.AddControllers()
    .AddJsonOptions(opts => opts.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()));
于 2020-12-18T10:32:21.413 回答