如何為 System.Text.Json 中的枚舉值指定自訂名稱？

System.Text.Json：如何為枚舉值指定自訂名稱？

此功能不可用.NET Core 3.0、.NET 5、.NET 6.0、.NET 7.0 或 .NET 中的框8.0。因此，您需要建立自己的 JsonConverterFactory 來序列化具有屬性指定的自訂值名稱的枚舉，或使用具有相同功能的 NuGet 包，例如 Macross.Json.Extensions。

如果您正在使用.NET 7或更高版本，或者早期版本中只需要序列化而不需要反序列化具有自訂名稱的枚舉，可以透過建立JsonConverterFactory 透過為每個枚舉建構自訂的JsonNamingPolicy 來適應JsonStringEnumConverter，並將[EnumMember(Value = "xxx")] 套用於任何枚舉值。

以下是涉及的步驟：

1. 建立自訂轉換器：

public class JsonEnumMemberStringEnumConverter : JsonConverterFactory
{
    public JsonEnumMemberStringEnumConverter() : this(null, true) { }

    public JsonEnumMemberStringEnumConverter(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 &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);
    }
}

public class JsonNamingPolicyDecorator : JsonNamingPolicy
{
    readonly JsonNamingPolicy? underlyingNamingPolicy;

    public JsonNamingPolicyDecorator(JsonNamingPolicy? underlyingNamingPolicy) => this.underlyingNamingPolicy = underlyingNamingPolicy;
    public override string ConvertName(string name) => underlyingNamingPolicy?.ConvertName(name) ?? 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);
}

2. 裝飾你的列舉：

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

3. 使用轉換器Standalone:

var options = new JsonSerializerOptions
{
    Converters = { new JsonEnumMemberStringEnumConverter() },
    // Set other options as required:
    WriteIndented = true,
};
var json = JsonSerializer.Serialize(values, options);

4. 使用ASP.NET Core 註冊轉換器：

參考此答案Mani Gandham 提出問題，尋求如何做的指導

註釋：

• 註釋：
• 註釋：

註釋：

註釋： 在.NET 6 及更早版本中，JsonStringEnumConverter在反序列化期間忽略其命名策略；此問題已在拉取請求 73348 中修正。 在 .Net Core 3.x 中，轉換器可能無法依照 [Flags] 列舉的要求運作。此問題已在 .NET 5 中的問題 #31622 中修復。 如果您需要在.NET 6 或更早版本中使用自訂值名稱來回傳枚舉，則需要從以下位置建立通用轉換器轉換器工廠另一種解決方案是使用Macross.Json.Extensions 套件中的JsonStringEnumMemberConverter。安裝包，然後使用屬性 [JsonConverter(typeof(System.Text.Json.Serialization.JsonStringEnumMemberConverter))].我希望這個解釋有所幫助！如果您還有其他問題，請告訴我。

以上是如何為 System.Text.Json 中的枚舉值指定自訂名稱？的詳細內容。更多資訊請關注PHP中文網其他相關文章！