在.Net Web Api中使用FluentValidate進行引數驗證

CoderMiner發表於2018-06-14
WebAPI

在.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
{
    //具體的邏輯
}
複製程式碼

相關文章