枚举作为 ASP.NET Core WebAPI 中的必填字段

Question

当 JSON 请求没有为枚举属性提供正确的值时，是否可以返回 [Required] 属性错误消息？

例如，我有一个 POST 消息模型，其中包含一个枚举类型的 AddressType 属性：

public class AddressPostViewModel
{
    [JsonProperty("addressType")]
    [Required(ErrorMessage = "Address type is required.")]
    public AddressType AddressType { get; set; }
}

AddressType 枚举接受两个值：

[JsonConverter(typeof(StringEnumConverter))]
public enum AddressType
{
    [EnumMember(Value = "Dropship")]
    Dropship,
    [EnumMember(Value = "Shipping")]
    Shipping
}

我注意到（或者实际上我的 QA 团队注意到）如果请求消息 JSON 包含空字符串或 AddressType 的 null，则错误消息不是预期的 Address type is required. 消息。相反，错误消息是一个有点不友好的解析错误。

例如，如果请求 JSON 如下所示：

{  "addressType": "" }

那么验证框架自动生成的错误是这样的：

{
    "message": "Validation Failed",
    "errors": [
        {
            "property": "addressType",
            "message": "Error converting value \"\" to type 'MyNamespace.AddressType'. Path 'addressType', line 4, position 19."
        }
    ]
}

如果有人没有包含有效的枚举值，是否有办法确保返回 [Required] 属性的错误消息？

Answer 1

选项1：使用自定义RequiredEnum属性并避免JsonConverter属性

不要将 JsonConverter 放在 AddressType 枚举上。此 StringToEnum 无法将 string.Empty 映射到枚举值，并抛出此错误消息。

除此之外，您可以编写一个自定义的必需枚举验证器，如下所示。

    using System;
    using System.ComponentModel.DataAnnotations;

    public class RequiredEnumFieldAttribute: RequiredAttribute
    {
        public override bool IsValid(object value)
        {
            if (value == null)
            {
                 return false;
            }

            var type = value.GetType();
            return type.IsEnum && Enum.IsDefined(type, value);
        }
   }

然后你就可以像下面这样使用它了：

public class AddressPostViewModel
{
    [JsonProperty("addressType")]
    [RequiredEnumField(ErrorMessage = "Address type is required.")]
    public AddressType AddressType { get; set; }
}

选项 2：为 AddressType 使用自定义 JsonConverter

添加一个从 StringEnumConverter 派生的自定义 CustomStringToEnumConverter。

如果 JSON 中的值为空，此方法会抛出错误。

public class CustomStringToEnumConverter : StringEnumConverter
{
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (string.IsNullOrEmpty(reader.Value.ToString()))
            throw new Exception("Address not provided");

        return base.ReadJson(reader, objectType, existingValue, serializer);
    }
}

如下所示，使用这个 jsonConverter 代替默认的 StringEnumConverter

[JsonConverter(typeof(CustomStringToEnumConverter))]
public enum AddressType
{
}

Answer 2

我想出了一个满足我要求的解决方案，尽管代码让我有点畏缩。

我在视图模型的AddressType 属性上保留了[Required] 属性。令人畏惧的部分是我必须将属性设为nullable：

public class AddressPostViewModel
{
    [JsonProperty("addressType")]
    [Required(ErrorMessage = "Address type is required.")]
    public AddressType? AddressType { get; set; }
}

在AttributeType 枚举本身上，我用@Manoj Choudhari 建议的自定义JsonConverter 替换了StringEnumConverter 属性：

[JsonConverter(typeof(CustomStringToEnumConverter))]
public enum AddressType
{
    [EnumMember(Value = "Dropship")]
    Dropship,
    [EnumMember(Value = "Shipping")]
    Shipping
}

这是CustomStringToEnumConverter：

public class CustomStringToEnumConverter : StringEnumConverter
{
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (string.IsNullOrEmpty(reader.Value?.ToString()))
        {
            return null;
        }

        object parsedEnumValue;

        var isValidEnumValue = Enum.TryParse(objectType.GenericTypeArguments[0], reader.Value.ToString(), true, out parsedEnumValue);

        if (isValidEnumValue)
        {
            return parsedEnumValue;
        }
        else
        {
            return null;
        }
    }
}

CustomStringToEnumConverter 可以处理空字符串、空值和无效字符串。如果遇到无效的枚举值，则返回null，然后在发生必填字段验证（魔术）并在 JSON 响应中显示RequiredAttribute 错误消息时捕获该值。

虽然我不喜欢将 AttributeType 类型设为可为空，但如果请求 JSON 中的 AttributeType 值错误，我的 API 使用者将看到一致的验证消息。

Answer 3

我认为没有现成的数据注释来验证枚举值。

您可以从所需的属性派生：

using System;
using System.ComponentModel.DataAnnotations;

    public class RequiredEnumAttribute : RequiredAttribute
    {
        public override bool IsValid(object value)
        {
            if (value == null) return false;
            var type = value.GetType();
            return type.IsEnum && Enum.IsDefined(type, value);
        }
}

Enum.IsDefined 方法检查给定value 是否存在于给定type 的枚举中。

用法：

[RequiredEnum(ErrorMessage = "Your error message.")]
public YourEnum EnumProperty { get; set; }

参见this 文章。

Answer 4

（在此处查看完整的文章：https://mtarleton.medium.com/enum-as-required-field-in-asp-net-core-webapi-a79b697ef270）

这里面临的问题是将正文转换为 JSON 和验证模型验证的操作顺序。

首先，.NET 将正文反序列化为 JSON具有默认值。这意味着如果您为不可为空的 ENUM 传入一个空值，则会为其设置默认值（通常是 ENUM 中的第一项）。基元也会发生同样的事情。

[JsonProperty(Required = Required.Always)]