Xử lý xác thực trạng thái mô hình trong API web ASP.NET

Tôi đã tự hỏi làm thế nào tôi có thể đạt được xác thực mô hình với ASP.NET Web API. Tôi có mô hình của mình như vậy:

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; }
}

Sau đó, tôi có một hành động Đăng trong Bộ điều khiển API của mình:

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

Làm cách nào để thêm if(ModelState.IsValid)và sau đó xử lý thông báo lỗi để chuyển cho người dùng?

Để tách khỏi mối quan tâm, tôi khuyên bạn nên sử dụng bộ lọc hành động để xác thực mô hình, vì vậy bạn không cần quan tâm nhiều đến cách thực hiện xác thực trong bộ điều khiển api của mình:

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);
        }
    }
}

Có thể không phải những gì bạn đang tìm kiếm, nhưng có lẽ thật tuyệt khi ai đó biết:

Nếu bạn đang sử dụng .net Web Api 2, bạn chỉ có thể làm như sau:

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

Tùy thuộc vào lỗi mô hình, bạn nhận được kết quả này:

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

Ví dụ như thế này:

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);
    }
}

Điều này sẽ trả về một phản hồi như thế này (giả sử là JSON, nhưng cùng một nguyên tắc cơ bản cho 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."]

Tất nhiên, bạn có thể xây dựng đối tượng / danh sách lỗi của mình theo bất kỳ cách nào bạn muốn, ví dụ như thêm tên trường, id trường, v.v.

Ngay cả khi đó là lệnh gọi Ajax "một chiều" giống như POST của một thực thể mới, bạn vẫn nên trả lại một thứ gì đó cho người gọi - điều gì đó cho biết yêu cầu có thành công hay không. Hãy tưởng tượng một trang web mà người dùng của bạn sẽ thêm một số thông tin về họ thông qua yêu cầu AJAX POST. Điều gì sẽ xảy ra nếu thông tin họ đã cố gắng nhập không hợp lệ - làm thế nào họ biết được liệu hành động Lưu của họ có thành công hay không?

Cách tốt nhất để làm điều này là sử dụng Good Old HTTP Status Codes như 200 OKvà như vậy. Bằng cách đó, JavaScript của bạn có thể xử lý đúng các lỗi bằng cách sử dụng các lệnh gọi lại chính xác (lỗi, thành công, v.v.).

Đây là một hướng dẫn hay về phiên bản nâng cao hơn của phương pháp này, sử dụng ActionFilter và jQuery: http://asp.net/web-api/videos/getting-started/custom-validation

Bạn có thể sử dụng các thuộc tính từ System.ComponentModel.DataAnnotationskhông gian tên để đặt các quy tắc xác thực. Tham khảo Xác thực Mô hình - Của Mike Wasson để biết thêm chi tiết.

Cũng tham khảo video ASP.NET Web API, Phần 5: Xác thực tùy chỉnh - Jon Galloway

Tài liệu tham khảo khác

1. Đi dạo về phía khách hàng với WebAPI và WebForms
2. Cách ASP.NET Web API liên kết các thông báo HTTP với các mô hình miền và cách làm việc với các định dạng phương tiện trong Web API.
3. Dominick Baier - Bảo mật các API Web ASP.NET
4. Kết nối xác thực AngularJS để xác thực API Web ASP.NET
5. Hiển thị lỗi ModelState với AngularJS trong ASP.NET MVC
6. Làm thế nào để hiển thị lỗi cho máy khách? AngularJS / WebApi ModelState
7. Xác thực dựa trên sự phụ thuộc trong API Web

Hoặc, nếu bạn đang tìm kiếm bộ sưu tập lỗi đơn giản cho ứng dụng của mình .. đây là cách triển khai của tôi về điều này:

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);
        }
    }

Phản hồi thông báo lỗi sẽ giống như sau:

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

Thêm mã bên dưới vào tệp 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);
                };
           });

Tại đây bạn có thể kiểm tra để hiển thị từng lỗi trạng thái mô hình một

 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)
    {

Javascript

$.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);
};

Tôi đã gặp sự cố khi triển khai mẫu giải pháp được chấp nhận , nơi của tôi ModelStateFiltersẽ luôn trả về false(và sau đó là 400) actionContext.ModelState.IsValidcho các đối tượng mô hình nhất định:

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

Tôi chỉ chấp nhận JSON, vì vậy tôi đã triển khai một lớp chất kết dính mô hình tùy chỉnh:

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;
    }
}

Tôi đăng ký trực tiếp sau mô hình của mình qua

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

Bạn cũng có thể đưa ra các ngoại lệ như được ghi lại tại đây: http://blogs.msdn.com/b/youssefm/archive/2012/06/28/error-handling-in-asp-net-webapi.aspx

Lưu ý, để làm được những gì bài viết đó gợi ý, hãy nhớ đưa vào System.Net.Http