在ASP.NET Web API中处理ModelState验证

我想知道如何使用ASP.NET Web API进行模型验证。我有这样的模型：

public class Enquiry
{
    [Key]
    public int EnquiryId { get; set; }
    [Required]
    public DateTime EnquiryDate { get; set; }
    [Required]
    public string CustomerAccountNumber { get; set; }
    [Required]
    public string ContactName { get; set; }
}

然后，我在API控制器中执行了Post操作：

public void Post(Enquiry enquiry)
{
    enquiry.EnquiryDate = DateTime.Now;
    context.DaybookEnquiries.Add(enquiry);
    context.SaveChanges();
}

如何添加if(ModelState.IsValid)然后处理错误消息以传递给用户？

为了分开关注，我建议您使用动作过滤器进行模型验证，因此您无需过多关心如何在api控制器中进行验证：

using System.Net;
using System.Net.Http;
using System.Web.Http.Controllers;
using System.Web.Http.Filters;

namespace System.Web.Http.Filters
{
    public class ValidationActionFilter : ActionFilterAttribute
    {
        public override void OnActionExecuting(HttpActionContext actionContext)
        {
            var modelState = actionContext.ModelState;

            if (!modelState.IsValid)
                actionContext.Response = actionContext.Request
                     .CreateErrorResponse(HttpStatusCode.BadRequest, modelState);
        }
    }
}

也许不是您想要的东西，但也许对某人知道很高兴：

如果您使用的是.net Web Api 2，则可以执行以下操作：

if (!ModelState.IsValid)
     return BadRequest(ModelState);

根据模型错误，您将得到以下结果：

{
   Message: "The request is invalid."
   ModelState: {
       model.PropertyA: [
            "The PropertyA field is required."
       ],
       model.PropertyB: [
             "The PropertyB field is required."
       ]
   }
}

像这样：

public HttpResponseMessage Post(Person person)
{
    if (ModelState.IsValid)
    {
        PersonDB.Add(person);
        return Request.CreateResponse(HttpStatusCode.Created, person);
    }
    else
    {
        // the code below should probably be refactored into a GetModelErrors
        // method on your BaseApiController or something like that

        var errors = new List<string>();
        foreach (var state in ModelState)
        {
            foreach (var error in state.Value.Errors)
            {
                errors.Add(error.ErrorMessage);
            }
        }
        return Request.CreateResponse(HttpStatusCode.Forbidden, errors);
    }
}

这将返回这样的响应（假设为JSON，但XML的基本原理相同）：

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
(some headers removed here)

["A value is required.","The field First is required.","Some custom errorm essage."]

当然，您可以按照自己喜欢的任何方式构造错误对象/列表，例如添加字段名称，字段ID等。

即使是像新实体的POST这样的“单向” Ajax调用，您也应该向调用者返回一些信息，该信息表明请求是否成功。想象一个站点，您的用户将通过AJAX POST请求添加一些有关自己的信息。如果他们尝试输入的信息无效，该怎么办-他们如何知道自己的“保存”操作是否成功？

最好的方法是使用良好的旧HTTP状态代码，例如200 OK。这样，您的JavaScript可以使用正确的回调（错误，成功等）正确处理失败。

这是有关使用ActionFilter和jQuery的此方法的更高级版本的不错的教程：http : //asp.net/web-api/videos/getting-started/custom-validation

您可以使用System.ComponentModel.DataAnnotations名称空间中的属性来设置验证规则。有关详细信息，请参阅模型验证-Mike Wasson。

另请参阅视频ASP.NET Web API，第5部分：自定义验证-Jon Galloway

其他参考

1. 使用WebAPI和WebForms在客户端上散步
2. ASP.NET Web API如何将HTTP消息绑定到域模型，以及如何在Web API中使用媒体格式。
3. Dominick Baier-保护ASP.NET Web API的安全
4. 将AngularJS验证与ASP.NET Web API验证挂钩
5. 在ASP.NET MVC中使用AngularJS显示ModelState错误
6. 如何将错误呈现给客户端？AngularJS / WebApi模型状态
7. Web API中的依赖注入验证

或者，如果您正在寻找应用程序错误的简单集合。.这是我的实现：

public override void OnActionExecuting(HttpActionContext actionContext)
    {
        var modelState = actionContext.ModelState;

        if (!modelState.IsValid) 
        {

            var errors = new List<string>();
            foreach (var state in modelState)
            {
                foreach (var error in state.Value.Errors)
                {
                    errors.Add(error.ErrorMessage);
                }
            }

            var response = new { errors = errors };

            actionContext.Response = actionContext.Request
                .CreateResponse(HttpStatusCode.BadRequest, response, JsonMediaTypeFormatter.DefaultMediaType);
        }
    }

错误消息响应如下所示：

{
  "errors": [
    "Please enter a valid phone number (7+ more digits)",
    "Please enter a valid e-mail address"
  ]
}

在startup.cs文件中添加以下代码

services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2).ConfigureApiBehaviorOptions(options =>
            {
                options.InvalidModelStateResponseFactory = (context) =>
                {
                    var errors = context.ModelState.Values.SelectMany(x => x.Errors.Select(p => new ErrorModel()
                   {
                       ErrorCode = ((int)HttpStatusCode.BadRequest).ToString(CultureInfo.CurrentCulture),
                        ErrorMessage = p.ErrorMessage,
                        ServerErrorMessage = string.Empty
                    })).ToList();
                    var result = new BaseResponse
                    {
                        Error = errors,
                        ResponseCode = (int)HttpStatusCode.BadRequest,
                        ResponseMessage = ResponseMessageConstants.VALIDATIONFAIL,

                    };
                    return new BadRequestObjectResult(result);
                };
           });

在这里您可以检查以显示模型状态错误

 public HttpResponseMessage CertificateUpload(employeeModel emp)
    {
        if (!ModelState.IsValid)
        {
            string errordetails = "";
            var errors = new List<string>();
            foreach (var state in ModelState)
            {
                foreach (var error in state.Value.Errors)
                {
                    string p = error.ErrorMessage;
                    errordetails = errordetails + error.ErrorMessage;

                }
            }
            Dictionary<string, object> dict = new Dictionary<string, object>();



            dict.Add("error", errordetails);
            return Request.CreateResponse(HttpStatusCode.BadRequest, dict);


        }
        else
        {
      //do something
        }
        }

}

C＃

    public class ValidateModelAttribute : ActionFilterAttribute
    {
        public override void OnActionExecuting(HttpActionContext actionContext)
        {
            if (actionContext.ModelState.IsValid == false)
            {
                actionContext.Response = actionContext.Request.CreateErrorResponse(
                    HttpStatusCode.BadRequest, actionContext.ModelState);
            }
        }
    }

...

    [ValidateModel]
    public HttpResponseMessage Post([FromBody]AnyModel model)
    {

Java脚本

$.ajax({
        type: "POST",
        url: "/api/xxxxx",
        async: 'false',
        contentType: "application/json; charset=utf-8",
        data: JSON.stringify(data),
        error: function (xhr, status, err) {
            if (xhr.status == 400) {
                DisplayModelStateErrors(xhr.responseJSON.ModelState);
            }
        },
....


function DisplayModelStateErrors(modelState) {
    var message = "";
    var propStrings = Object.keys(modelState);

    $.each(propStrings, function (i, propString) {
        var propErrors = modelState[propString];
        $.each(propErrors, function (j, propError) {
            message += propError;
        });
        message += "\n";
    });

    alert(message);
};

我在实现可接受的解决方案模式时遇到问题，对于某些模型对象，我ModelStateFilter将始终返回false（随后返回400）actionContext.ModelState.IsValid：

public class ModelStateFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        if (!actionContext.ModelState.IsValid)
        {
            actionContext.Response = new HttpResponseMessage { StatusCode = HttpStatusCode.BadRequest};
        }
    }
}

我只接受JSON，因此实现了一个自定义模型绑定程序类：

public class AddressModelBinder : System.Web.Http.ModelBinding.IModelBinder
{
    public bool BindModel(HttpActionContext actionContext, System.Web.Http.ModelBinding.ModelBindingContext bindingContext)
    {
        var posted = actionContext.Request.Content.ReadAsStringAsync().Result;
        AddressDTO address = JsonConvert.DeserializeObject<AddressDTO>(posted);
        if (address != null)
        {
            // moar val here
            bindingContext.Model = address;
            return true;
        }
        return false;
    }
}

我通过模型直接注册后

config.BindParameter(typeof(AddressDTO), new AddressModelBinder());

您还可以按照此处记录的方式抛出异常：http : //blogs.msdn.com/b/youssefm/archive/2012/06/28/error-handling-in-asp-net-webapi.aspx

注意，要执行该文章建议的操作，请记住包括System.Net.Http