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

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

安裝FluentValidate

在ASP.NET Web Api中請安裝 FluentValidation.WebApi版本bash

建立一個須要驗證的Model

public class Product 
    {
        public string name { get; set; }
        public string des { get; set; }
        public string place { get; set; }
    }
複製代碼

配置FluentValidation,須要繼承AbstractValidator類,並添加對應的驗證規則ide

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

    }
複製代碼

在Config中配置 FluentValidation

WebApiConfig配置文件中添加ui

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

        FluentValidationModelValidatorProvider.Configure(config);
    }
}
複製代碼

驗證參數

須要在進入Controller以前進行驗證,若是有錯誤就返回,再也不進入Controller,須要使用 ActionFilterAttributespa

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
{
    //具體的邏輯
}
複製代碼
相關文章
相關標籤/搜索