如何在 System.Text.Json 中自定义枚举值名称？

System.Text.Json：自定义枚举值名称

System.Text.Json 不提供内置方法来指定自定义枚举成员的值。但是，有多种选择可以实现此目的：

使用自定义 JsonConverterFactory：

创建一个继承自 JsonConverterFactory 的自定义转换器类并实现 CanConvert 和 CreateConverter 方法。在CanConvert中，检查要转换的类型是否为枚举。在 CreateConverter 中，创建一个处理自定义值的自定义 JsonEnumConverter 实例。

使用第三方库：

Macross.Json.Extensions 等库提供支持的转换器自定义枚举值名称。安装库并使用 [JsonConverter(typeof(JsonStringEnumMemberConverter))] 装饰您的枚举。

在 .NET 6 或更早版本中创建自定义转换器和工厂：

中在 .NET 6 或更早版本中，具有自定义名称的往返枚举需要自定义转换器和转换器工厂。这涉及处理整数和字符串值的解析、[Flags] 枚举组件的重命名以及转换所有可能的基础类型的枚举。

使用通用枚举转换器：

可以创建通用枚举转换器来处理 [Flags] 和非 [Flags] 枚举，并在以下情况下使用自定义覆盖进行名称转换需要。这比为每种类型使用特定转换器更复杂。

使用自定义转换器工厂的代码示例：

public class JsonEnumMemberStringEnumConverter : JsonConverterFactory
{
    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 &amp;&amp; attr.Value != 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);
    }
}

附加说明：

• 在 .NET 6 及更早版本中，JsonStringEnumConverter 忽略反序列化期间的命名策略。此问题已在 .NET 7 中修复。
• 在 .NET Core 3.x 中，自定义转换器可能无法按照需要重命名单个值的 [Flags] 枚举工作。
• 在 .NET 中5，此问题已修复。
• 对于 .NET 6 或更早版本，通用转换器转换器工厂方法可能是必要的。
• 像 Macross.Json.Extensions 这样的第三方库简化了这个过程。

以上是如何在 System.Text.Json 中自定义枚举值名称？的详细内容。更多信息请关注PHP中文网其他相关文章！