FluentValidation验证枚举值

时间:2017-07-10 13:51:59

标签: c# json asp.net-web-api enums fluentvalidation

我有以下型号:

public class ViewDataItem
{
    public string viewName { get; set; }
    public UpdateIndicator updateIndicator { get; set; }
}

使用以下枚举:

public enum UpdateIndicator
{
    Original,
    Update,
    Delete
}

以下验证者:

public class ViewValidator : AbstractValidator<ViewDataItem>
{
    public ViewValidator()
    {
        RuleFor(x => x.viewName).NotEmpty().WithMessage("View name must be specified");
        RuleFor(x => x.updateIndicator).SetValidator(new UpdateIndicatorEnumValidator<UpdateIndicator>());
    }
}

public class UpdateIndicatorEnumValidator<T> : PropertyValidator
{
    public UpdateIndicatorEnumValidator() : base("Invalid update indicator") {}

    protected override bool IsValid(PropertyValidatorContext context)
    {
        UpdateIndicator enumVal = (UpdateIndicator)Enum.Parse(typeof(UpdateIndicator), context.PropertyValue.ToString());

        if (!Enum.IsDefined(typeof(UpdateIndicator), enumVal))
          return false;

        return true;
    }
}

代码在WebAPI中,通过JSON接收数据,将其反序列化为对象然后验证,但出于某种原因,我可以在updateIndicator中发送任何我喜欢的内容,只要我不放在整数值大于枚举中的最大索引(即1,2或3工作正常,但7将产生错误)。

如何验证我收到的数据输入以查看该值是否实际存在于枚举中?

2 个答案:

答案 0 :(得分:26)

尝试使用内置IsInEnum()

RuleFor(x => x.updateIndicator).IsInEnum();

检查提供的枚举值是否在枚举范围内,否则验证将失败:

  

&#34;&#39; updateIndicator&#39;有一系列值不包括&#39; 7&#39;

答案 1 :(得分:7)

问题源于API模型构建器将转换发送到枚举的事实。如果未找到值,则不会填充该值,并使用默认值(与未填充的任何其他属性数据类型一样)。

为了轻松判断发送的值是否为有效的枚举值,您应该使您的属性可以为空。这样,如果无法解析值,则将其设置为null。如果要确保设置属性,只需让验证器不允许空值。

public class ViewDataItem
{
    public string viewName { get; set; }
    public UpdateIndicator? updateIndicator { get; set; }
}

public class ViewValidator : AbstractValidator<ViewDataItem>
{
    public ViewValidator()
    {
        RuleFor(x => x.viewName).NotEmpty().WithMessage("View name must be specified");
        RuleFor(x => x.updateIndicator).NotNull();
    }
}

如果不将该属性设置为null,则在获得该模型时,模型将始终具有有效值。或者,您可以将枚举的第一个值设为虚拟值,但这可能是代码气味。 null模型属性更有意义。

如果您想了解发送到API端点的实际值是什么,您需要查看创建HTTP Handler,这超出了此问题的范围。