在 WEB API 上使用 Fluent Validation 进行模型验证

Question

我正在尝试在 Web API 项目中对我的模型使用流畅的验证。我有两个班级名称 OrderHeader 和 Items 。我在 Items 类上的属性名称为OrderQty，它是一个整数，我已经为 OrderQty 应用了一个规则，因为它应该是数字（即 0-9）。每当我收到对 OrderQty 的 JSON 请求作为字母数字（如 1A）时，我无法序列化 JSON，也无法从 Modelstate 上的流利验证中获取错误消息。如何实现这一点有人可以帮助我吗？提前致谢 ！！！

我尝试将 OrderQty 转换为 ToString() 并应用了规则，但在序列化 JSON 时无法收到错误消息。

我的模态类：

public class OrderHeader
{
    public string OrderNumber { get; set; }
    public string Address1 { get; set; }
    public string Address2 { get; set; }
    public string City { get; set; }
    public string State { get; set; }
    public string Zip { get; set; }
    public string Phone { get; set; }
    public string Created { get; set; }
    public List<Items> Items { get; set; }
}

public class Items
{
   public string ItemNumber { get; set; }
   public string Description { get; set; }
   public int OrderQty { get; set; }
   public double Weight { get; set; }
   public double Price { get; set; }
   public string Status { get; set; }
}

流利的验证

public class OrderHeaderValidator : AbstractValidator<OrderHeader>
{

    public OrderHeaderValidator()
    {
        RuleFor(x => x.OrderNumber.Trim()).NotEmpty().WithMessage("OrderNumber : cannot be blank.").Length(1, 6).WithMessage("OrderNumber : cannot be more than 6 characters.").Matches("^[0-9]*$").WithMessage("OrderNumber : must contains only numbers");
        RuleFor(x => x.Items).SetCollectionValidator(new ItemValidator());
    }
}


public class ItemsValidator : AbstractValidator<Items>
{

    public ItemsValidator()
    {
        RuleFor(x => x.OrderQty.ToString()).NotNull().WithMessage("TotalOrderQuantity : cannot be blank").Matches("^[0-9]*$").WithMessage("TotalOrderQuantity : must contains only numbers");
        RuleFor(x => x.Status.ToUpper()).NotEmpty().WithMessage("Status : Provide the Status").Length(0, 1).WithMessage("Status : cannot be more than 1 character").Matches("O").WithMessage("Status : Must be 'O'");

    }

}

序列化并获取错误消息：

 string errors = JsonConvert.SerializeObject(ModelState.Values
                .SelectMany(state => state.Errors)
                .Select(error => error.ErrorMessage));

我希望输出应该是如果来自 JSON 请求的值为 1A，那么它会显示错误消息：

TotalOrderQuantity : 必须只包含数字

Answer 1

您不能将1A 反序列化为int OrderQty。请改用string OrderQty 并在验证器中检查.Must(x => int.TryParse(x.OrderQty, out _))。

您的 API 具有像 OrderQty must be integer - int OrderQty 这样的规范是可以的。如果有人尝试发送字符串而不是整数 - 您可以捕获反序列化异常并使用 invalid request: ... 之类的消息拒绝请求