无法使用 Json.NET 将枚举正确转换为 json [英] Can't get enum to convert to json properly using Json.NET

问题描述

我有一个枚举:

public enum Animal 
{ 
    Dog, 
    Cat, 
    BlackBear 
}

我需要将其发送到第三方 API.此 API 要求我发送的枚举值必须小写，并且偶尔需要下划线.一般来说，他们需要的名称与我使用的枚举命名约定不匹配.

I need to send it to a third-party API. This API requires that the enum values I send be lower case and occasionally require underscores. In general, the names they require don't match the enum naming convention I use.

使用 https 中提供的示例://gooddevbaddev.wordpress.com/2013/08/26/deserializing-c-enums-using-json-net/，我尝试使用自定义的JsonConverter:

Using the example provided at https://gooddevbaddev.wordpress.com/2013/08/26/deserializing-c-enums-using-json-net/, I tried to use a custom JsonConverter:

public class AnimalConverter : JsonConverter {
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) {
        var animal = (Animal)value;
        switch (animal)
        {
            case Animal.Dog:
            {
                writer.WriteValue("dog");
                break;
            }
            case Animal.Cat:
            {
                writer.WriteValue("cat");
                break;
            }
            case Animal.BlackBear:
            {
                writer.WriteValue("black_bear");
                break;
            }
        }
    }
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) {
        var enumString = (string)reader.Value;
        Animal? animal = null;
        switch (enumString)
        {
            case "cat":
            {
                animal = Animal.Cat;
                break;
            }
            case "dog":
            {
                animal = Animal.Dog;
                break;
            }
            case "black_bear":
            {
                animal = Animal.BlackBear;
                break;
            }
        }
    }

    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(string);
    }
}

回到类的属性，我把属性放在 Animal 上:

Back in the properties of a class, I put the attributes on the Animal as so:

[JsonProperty("animal")]
[JsonConverter(typeof(AnimalConverter))]
public Animal ZooAnimals { get; set; }

但是，当我运行程序时，它似乎完全忽略了 JsonConverter，而不是看到像black_bear"或dog"这样的预期值，而是看到了BlackBear"和Dog".如何让 JsonConverter 实际执行从枚举值的名称到我指定替换该值的字符串的转换?

When I run the program though, it seems to completely ignore the JsonConverter and rather than seeing expected values like "black_bear" or "dog", I see "BlackBear" and "Dog". How can I get the JsonConverter to actually do the conversion from the name of the enum value to the string I specify to replace that value with?

谢谢！

推荐答案

您不需要编写自己的转换器.Json.NET 的 StringEnumConverter 将读取 <一个 href="http://msdn.microsoft.com/en-us/library/system.runtime.serialization.enummemberattribute.aspx" rel="noreferrer">EnumMember 属性.如果您将 enum 更改为此，它将序列化到您想要的值.

You don't need to write your own converter. Json.NET's StringEnumConverter will read the EnumMember attribute. If you change your enum to this, it will serialize from and to the values you want.

[JsonConverter(typeof(StringEnumConverter))]
public enum Animals 
{
    [EnumMember(Value = "dog")]
    Dog, 
    [EnumMember(Value = "cat")]
    Cat, 
    [EnumMember(Value = "black_bear")]
    BlackBear 
}

(作为一个小提示，由于 Animals 不是标志枚举，它 应该是单数:Animal.你应该考虑改成这个.)

(As a minor note, since Animals isn't a flags enum, it should be singular: Animal. You should consider changing it to this.)

这篇关于无法使用 Json.NET 将枚举正确转换为 json的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！