จัดการ ModelState Validation ใน ASP.NET Web API

ฉันสงสัยว่าฉันจะตรวจสอบโมเดลด้วย 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 ของฉัน:

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."]

แน่นอนคุณสามารถสร้างวัตถุ / รายการข้อผิดพลาดของคุณในแบบที่คุณต้องการตัวอย่างเช่นการเพิ่มชื่อเขตข้อมูลรหัสเขตข้อมูลเป็นต้น

แม้ว่าจะเป็นการเรียก Ajax แบบ "ทางเดียว" เหมือนโพสต์ของเอนทิตีใหม่คุณก็ยังควรส่งคืนบางอย่างให้กับผู้โทรซึ่งเป็นสิ่งที่บ่งบอกว่าคำขอนั้นสำเร็จหรือไม่ ลองนึกภาพไซต์ที่ผู้ใช้ของคุณจะเพิ่มข้อมูลเกี่ยวกับตัวเองผ่านคำขอ AJAX POST จะเกิดอะไรขึ้นหากข้อมูลที่พยายามป้อนไม่ถูกต้องพวกเขาจะรู้ได้อย่างไรว่าการดำเนินการบันทึกสำเร็จหรือไม่

วิธีที่ดีที่สุดคือการใช้รหัสสถานะ HTTP แบบเก่าที่ดีเช่น200 OKและอื่น ๆ ด้วยวิธีนี้ JavaScript ของคุณสามารถจัดการกับความล้มเหลวได้อย่างเหมาะสมโดยใช้การเรียกกลับที่ถูกต้อง (ข้อผิดพลาดความสำเร็จ ฯลฯ )

นี่คือบทช่วยสอนที่ดีเกี่ยวกับวิธีการนี้ในเวอร์ชันขั้นสูงโดยใช้ ActionFilter และ jQuery: http://asp.net/web-api/videos/getting-started/custom-validation

คุณสามารถใช้แอตทริบิวต์จากSystem.ComponentModel.DataAnnotationsเนมสเปซเพื่อตั้งกฎการตรวจสอบความถูกต้อง อ้างอิงModel Validation - โดย 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. การแสดงข้อผิดพลาด ModelState ด้วย AngularJS ใน ASP.NET MVC
6. จะสร้างข้อผิดพลาดให้กับลูกค้าได้อย่างไร? AngularJS / WebApi ModelState
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
        }
        }

}

ค#

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

ฉันมีปัญหาในการใช้รูปแบบโซลูชันที่ยอมรับซึ่งฉัน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 ดังนั้นฉันจึงใช้คลาส Binder แบบกำหนดเอง:

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