在.Net Web Api中使用FluentValidate进行参数验证

在.Net Web Api中使用FluentValidate进行参数验证

安装FluentValidate

在ASP.NET Web Api中请安装 FluentValidation.WebApi版本

创建一个需要验证的Model

    public class Product 
    {
        public string name { get; set; }
        public string des { get; set; }
        public string place { get; set; }
    }
复制代码

配置FluentValidation，需要继承AbstractValidator类，并添加对应的验证规则

    public class ProductValidator : AbstractValidator<Product>
    {
        public ProductValidator()
        {
            RuleFor(product => product.name).NotNull().NotEmpty();//name 字段不能为null,也不能为空字符串
        }

    }
复制代码

在Config中配置 FluentValidation

在 WebApiConfig配置文件中添加

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API routes
        ...

        FluentValidationModelValidatorProvider.Configure(config);
    }
}
复制代码

验证参数

需要在进入Controller之前进行验证，如果有错误就返回，不再进入Controller，需要使用 ActionFilterAttribute

public class ValidateModelStateFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        if (!actionContext.ModelState.IsValid)
        {
            actionContext.Response = actionContext.Request.CreateErrorResponse(HttpStatusCode.BadRequest, actionContext.ModelState);
        }
    }
}
复制代码

• 如果要让这个过滤器对所有的Controller都起作用，请在WebApiConfig中注册

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API configuration and services
        config.Filters.Add(new ValidateModelStateFilter());

        // Web API routes
        ...

        FluentValidationModelValidatorProvider.Configure(config);
    }
}
复制代码

• 如果指对某一个Controller起作用，可以在Controller注册

[ValidateModelStateFilter]
public class ProductController : ApiController
{
    //具体的逻辑
}
复制代码