Bagaimana untuk Menentukan Nama Tersuai untuk Nilai Enum dalam System.Text.Json?

System.Text.Json: Bagaimanakah cara untuk saya menentukan nama tersuai untuk nilai enum?

Keupayaan ini tidak tersedia daripada kotak dalam .NET Core 3.0, .NET 5, .NET 6.0, .NET 7.0, atau .NET 8.0. Oleh itu, anda perlu mencipta JsonConverterFactory anda sendiri yang menyerikan enum dengan nama nilai tersuai yang ditentukan oleh atribut atau menggunakan pakej NuGet yang melakukan perkara yang sama, seperti Macross.Json.Extensions.

Jika anda bekerja di .NET 7 atau lebih baru, atau hanya perlu menyiri tetapi tidak menyahsiri enum dengan nama tersuai dalam versi terdahulu, nama tersuai boleh disokong dengan mudah dengan mencipta JsonConverterFactory yang menyesuaikan JsonStringEnumConverter dengan membina JsonNamingPolicy tersuai untuk setiap enum dengan [EnumMember(Value = "xxx")] digunakan pada sebarang nilai enum.

Berikut ialah langkah-langkah yang terlibat:

1. Buat adat penukar:

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. Hias enum anda:

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

3. Gunakan penukar berdiri sendiri:

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

4. Daftar penukar dengan Teras ASP.NET:

Rujuk jawapan untuk ini soalan oleh Mani Gandham untuk panduan bagaimana untuk melakukannya ini.

Nota:

• Dalam .NET 6 dan lebih awal, JsonStringEnumConverter mengabaikan dasar penamaannya semasa penyahserikatan; isu ini telah dibetulkan dalam permintaan tarik 73348.
• Dalam .Net Core 3.x, penukar mungkin tidak berfungsi seperti yang dikehendaki dengan enum [Bendera]. Isu ini telah dibetulkan dalam Isu #31622 dalam .NET 5.
• Jika anda perlu pergi balik enum dengan nama nilai tersuai dalam .NET 6 atau lebih awal, anda perlu mencipta kilang penukar penukar generik daripada scratch.
• Penyelesaian alternatif ialah menggunakan JsonStringEnumMemberConverter daripada pakej Macross.Json.Extensions. Pasang pakej dan kemudian hiasi enum anda dengan atribut [JsonConverter(typeof(System.Text.Json.Serialization.JsonStringEnumMemberConverter))].

Saya harap penjelasan ini membantu! Beritahu saya jika anda mempunyai sebarang soalan lain.

Atas ialah kandungan terperinci Bagaimana untuk Menentukan Nama Tersuai untuk Nilai Enum dalam System.Text.Json?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!