如何制作JSON。网络转换器使用连字符分隔的外壳

Question

我使用一个API，它返回如下字符串值：

一些枚举值

我尝试将这些值放入enum中，因为默认的StringEnumConverter不符合我的要求，也就是用一些额外的逻辑来装饰这个转换器。

我如何确保这些值被正确反序列化？

以下代码是我完成这项工作的试用版<然而，这条线

Reader=new JsonTextReader（new StringReader（已清理））；

打破了自基以来的整个事情。ReadJson无法将字符串识别为JSON。

有没有更好的方法可以做到这一点，而不必在StringEnumConverter中实现所有现有的逻辑<我怎样才能修正我的方法？

public class BkStringEnumConverter : StringEnumConverter
{
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.String)
        {
            var enumString = reader.Value.ToString();
            if (enumString.Contains("-"))
            {
                var cleaned = enumString.Split('-').Select(FirstToUpper).Aggregate((a, b) => a + b);
                reader = new JsonTextReader(new StringReader(cleaned));
            }
        }
        return base.ReadJson(reader, objectType, existingValue, serializer);
    }

    private static string FirstToUpper(string input)
    {
        var firstLetter = input.ToCharArray().First().ToString().ToUpper();
        return string.IsNullOrEmpty(input)
            ? input
            : firstLetter + string.Join("", input.ToCharArray().Skip(1));
    }
}

Answer 1

这在Json中变得更容易。NET 12.0.1将NamingStrategy添加到StringEnumConverter：

新功能-添加了对NamingStrategy到StringENumConzer的支持

还有Json。NET 12.0.3为连字符分隔的烤肉串外壳添加了KebabCaseNamingStrategy，比如一些枚举值：

新功能-添加KebabCaseNamingStrategy

使用这种方法，MyEnum不需要任何注释。

具体来说，在12.0.3及更高版本中，当构造转换器并将其添加到JsonSerializerSettings时，可以将KebabCaseNamingStrategy传递到StringEnumConverter的多个构造函数中的任意一个。转换器：

var settings = new JsonSerializerSettings
{
    Converters = { new StringEnumConverter(new KebabCaseNamingStrategy()) },
};
var json = JsonConvert.SerializeObject(MyEnum.SomeEnumValue, settings);

Assert.IsTrue(json == "\"some-enum-value\""); // Passes successfully

这样做之后，您的序列化枚举值现在将变成烤羊肉串大小写。这里是演示小提琴#1。

在JsonNET 12.0.1和12.0.2您可以通过子类化SnakeCaseNamingStrategy来定义您自己的kebab案例命名策略：

public class KebabCaseNamingStrategy : SnakeCaseNamingStrategy
{
    protected override string ResolvePropertyName(string name)
    {
        return base.ResolvePropertyName(name).Replace('_', '-');
    }
}

这里是演示小提琴#2。

Answer 2

您也可以使用以下代码：

[JsonConverter(typeof(StringEnumConverter))]
public enum ResposeStatus
{
    [EnumMember(Value = "success value")]
    Success,
    [EnumMember(Value = "fail value")]
    Fail,
    [EnumMember(Value = "error value")]
    Error
};

当序列化JsonConverts.Seriize（），将使用ENum成员内的文本。

Answer 3

我通过在枚举值上添加EnumMember属性解决了这个问题。Json。NET defaultStringEnumConverter完美地处理了这些属性。

示例：

public enum MyEnum
{
    [EnumMember(Value = "some-enum-value")]
    SomeEnumValue,
    Value,
    [EnumMember(Value = "some-other-value")]
    SomeOtherValue
}

请注意，如果在枚举中不能使用破折号或其他特殊字符，则只需指定属性。大小写由StringEnumConverter处理。因此，如果服务返回一个类似于someenumvalue的值，那么应该在enumsomeenumvalue中这样使用它。如果您更喜欢SomeEnumValue，则应使用EnumMember属性。如果服务像这样返回someEnumValue，您可以像这样使用someEnumValue（当您使用CamelCaseText属性时，它是现成的）。

您可以在JsonSerializerSettings中轻松指定转换器和其他设置。

以下是我自己使用的设置示例。

new JsonSerializerSettings
{
    ContractResolver = new CamelCasePropertyNamesContractResolver(),
    Converters = new List<JsonConverter> { new StringEnumConverter { CamelCaseText = true } },
    NullValueHandling = NullValueHandling.Ignore
};