Question

我有一个带POST方法的简单控制器我的模型具有enum类型的属性当我发送有效值时，一切都按预期工作

{  "MyProperty": "Option2"}

或

{  "MyProperty": 2}

如果我发送无效字符串

{  "MyProperty": "Option15"}

它正确获取默认值（Option1）但如果我发送一个无效的int，它会保留无效值

{  "MyProperty": 15}

我可以避免这种情况并获取默认值或抛出错误吗？

由于

public class ValuesController : ApiController
{
    [HttpPost]
    public void Post(MyModel value) {}
}

public class MyModel
{
    [JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
    public MyEnum MyProperty { get; set; }
}

public enum MyEnum
{
    Option1 = 0,
    Option2,
    Option3
}

更新
我知道我可以将任何int转换为enum，这不是问题 @ AakashM的建议解决了我的一半问题，我不知道 AllowIntegerValues

现在我在发布无效的int

时正确地收到错误

{  "MyProperty": 15}

现在唯一有问题的情况是当我发布一个数字的字符串时（这很奇怪，因为当我发送一个无效的非数字字符串时它正确地失败了）

{  "MyProperty": "15"}

Answer 1

我通过扩展StringEnumConverter并使用@ AakashM的建议解决了我的问题

public class OnlyStringEnumConverter : StringEnumConverter
{
    public OnlyStringEnumConverter()
    {
        AllowIntegerValues = false;
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (!AllowIntegerValues && reader.TokenType == JsonToken.String)
        {
            string s = reader.Value.ToString().Trim();
            if (!String.IsNullOrEmpty(s))
            {
                if (char.IsDigit(s[0]) || s[0] == '-' || s[0] == '+')
                {
                    string message = String.Format(CultureInfo.InvariantCulture, "Value '{0}' is not allowed for enum '{1}'.", s, objectType.FullName);
                    string formattedMessage = FormatMessage(reader as IJsonLineInfo, reader.Path, message);
                    throw new JsonSerializationException(formattedMessage);
                }
            }
        }
        return base.ReadJson(reader, objectType, existingValue, serializer);
    }

    // Copy of internal method in NewtonSoft.Json.JsonPosition, to get the same formatting as a standard JsonSerializationException
    private static string FormatMessage(IJsonLineInfo lineInfo, string path, string message)
    {
        if (!message.EndsWith(Environment.NewLine, StringComparison.Ordinal))
        {
            message = message.Trim();
            if (!message.EndsWith("."))
            {
                message += ".";
            }
            message += " ";
        }
        message += String.Format(CultureInfo.InvariantCulture, "Path '{0}'", path);
        if (lineInfo != null && lineInfo.HasLineInfo())
        {
            message += String.Format(CultureInfo.InvariantCulture, ", line {0}, position {1}", lineInfo.LineNumber, lineInfo.LinePosition);
        }
        message += ".";
        return message;
    }

}

Answer 2

MyEnum _myProperty;
[JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
public MyEnum MyProperty 
{ 
    get
    {
        return _myProperty;
    }
    set
    {
        if (Enum.IsDefined(typeof(MyEnum), value))
            _myProperty = value;
        else
            _myProperty = 0;
    }
}

StringEnumConverter无效的int值

2 个答案: