ใช้ ASP.NET MVC validation กับ jquery ajax?


119

ฉันมีแอคชั่น ASP.NET MVC ง่ายๆดังนี้:

public ActionResult Edit(EditPostViewModel data)
{

}

EditPostViewModelมีแอตทริบิวต์การตรวจสอบเช่นนี้

[Display(Name = "...", Description = "...")]
[StringLength(100, MinimumLength = 3, ErrorMessage = "...")]
[Required()]
public string Title { get; set; }

ในมุมมองฉันกำลังใช้ตัวช่วยต่อไปนี้:

 @Html.LabelFor(Model => Model.EditPostViewModel.Title, true)

 @Html.TextBoxFor(Model => Model.EditPostViewModel.Title, 
                        new { @class = "tb1", @Style = "width:400px;" })

หากฉันส่งแบบฟอร์มที่กล่องข้อความนี้อยู่ในการตรวจสอบความถูกต้องจะดำเนินการก่อนบนไคลเอนต์จากนั้นจึงใช้บริการ ( ModelState.IsValid)

ตอนนี้ฉันมีคำถามสองสามข้อ:

  1. ใช้กับ jQuery ajax submit แทนได้ไหม สิ่งที่ฉันกำลังทำคือเพียงแค่ลบแบบฟอร์มและเมื่อคลิกปุ่มส่งจาวาสคริปต์จะรวบรวมข้อมูลจากนั้นเรียกใช้ไฟล์$.ajax.

  2. ฝั่งเซิร์ฟเวอร์จะModelState.IsValidทำงานหรือไม่

  3. ฉันจะส่งต่อปัญหาการตรวจสอบความถูกต้องกลับไปยังไคลเอนต์และนำเสนอเหมือนกับว่าฉันใช้การตรวจสอบความถูกต้องของ build int ( @Html.ValidationSummary(true)) ได้อย่างไร

ตัวอย่างการโทร Ajax:

function SendPost(actionPath) {
    $.ajax({
        url: actionPath,
        type: 'POST',
        dataType: 'json',
        data:
        {
            Text: $('#EditPostViewModel_Text').val(),
            Title: $('#EditPostViewModel_Title').val() 
        },
        success: function (data) {
            alert('success');
        },
        error: function () {
            alert('error');
        }
    });
}

แก้ไข 1:

รวมอยู่ในหน้า:

<script src="/Scripts/jquery-1.7.1.min.js"></script>
<script src="/Scripts/jquery.validate.min.js"></script>
<script src="/Scripts/jquery.validate.unobtrusive.min.js"></script>

คำตอบที่ดีด้านล่าง นี่คือคำถามที่เกี่ยวข้อง คำตอบช่วยให้สามารถตรวจสอบความถูกต้องฝั่งไคลเอ็นต์หรือฝั่งเซิร์ฟเวอร์ ฉันชอบรหัส JQuery ที่มีให้ (ไม่มันไม่ใช่คำตอบของฉัน) stackoverflow.com/questions/28987752/…
Adventure

คำตอบ:


155

ด้านลูกค้า

การใช้jQuery.validateไลบรารีควรตั้งค่าได้ง่าย

ระบุการตั้งค่าต่อไปนี้ในWeb.configไฟล์ของคุณ:

<appSettings>
    <add key="ClientValidationEnabled" value="true"/> 
    <add key="UnobtrusiveJavaScriptEnabled" value="true"/> 
</appSettings>

เมื่อคุณสร้างมุมมองของคุณคุณจะกำหนดสิ่งต่างๆดังนี้:

@Html.LabelFor(Model => Model.EditPostViewModel.Title, true)
@Html.TextBoxFor(Model => Model.EditPostViewModel.Title, 
                                new { @class = "tb1", @Style = "width:400px;" })
@Html.ValidationMessageFor(Model => Model.EditPostViewModel.Title)

หมายเหตุ:จำเป็นต้องกำหนดสิ่งเหล่านี้ภายในองค์ประกอบฟอร์ม

จากนั้นคุณจะต้องรวมไลบรารีต่อไปนี้:

<script src='@Url.Content("~/Scripts/jquery.validate.js")' type='text/javascript'></script>
<script src='@Url.Content("~/Scripts/jquery.validate.unobtrusive.js")' type='text/javascript'></script>

สิ่งนี้จะสามารถตั้งค่าให้คุณสำหรับการตรวจสอบความถูกต้องฝั่งไคลเอ็นต์

ทรัพยากร

ฝั่งเซิร์ฟเวอร์

หมายเหตุ:นี่เป็นเพียงการตรวจสอบฝั่งเซิร์ฟเวอร์เพิ่มเติมที่ด้านบนของjQuery.validationไลบรารี

บางทีสิ่งนี้อาจช่วยได้:

[ValidateAjax]
public JsonResult Edit(EditPostViewModel data)
{
    //Save data
    return Json(new { Success = true } );
}

ValidateAjaxแอตทริบิวต์กำหนดไว้ที่ไหน:

public class ValidateAjaxAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        if (!filterContext.HttpContext.Request.IsAjaxRequest())
            return;

        var modelState = filterContext.Controller.ViewData.ModelState;
        if (!modelState.IsValid)
        {
            var errorModel = 
                    from x in modelState.Keys
                    where modelState[x].Errors.Count > 0
                    select new
                           {
                               key = x,
                               errors = modelState[x].Errors.
                                                      Select(y => y.ErrorMessage).
                                                      ToArray()
                           };
            filterContext.Result = new JsonResult()
                                       {
                                           Data = errorModel
                                       };
            filterContext.HttpContext.Response.StatusCode = 
                                                  (int) HttpStatusCode.BadRequest;
        }
    }
}

สิ่งนี้ส่งคืนออบเจ็กต์ JSON ที่ระบุข้อผิดพลาดของโมเดลทั้งหมดของคุณ

ตัวอย่างคำตอบจะเป็น

[{
    "key":"Name",
    "errors":["The Name field is required."]
},
{
    "key":"Description",
    "errors":["The Description field is required."]
}]

สิ่งนี้จะถูกส่งกลับไปยังข้อผิดพลาดในการจัดการการโทรกลับของการ$.ajaxโทร

คุณสามารถวนซ้ำข้อมูลที่ส่งคืนเพื่อตั้งค่าข้อความแสดงข้อผิดพลาดได้ตามต้องการตามคีย์ที่ส่งคืน (ฉันคิดว่าบางอย่าง$('input[name="' + err.key + '"]')จะพบองค์ประกอบอินพุตของคุณ


1
คำตอบที่ดีโดยเฉพาะอย่างยิ่งกับ ValidateAjaxAttribute ที่ยอดเยี่ยม! ขอบคุณ!
René

3
ฉันไม่เข้าใจว่าทำไมคำตอบนี้ถึงได้รับการโหวตมากมาย ไม่ตอบคำถามที่ 1: จะตรวจสอบความถูกต้องของไคลเอนต์อย่างไรเมื่อโพสต์ด้วย $ .ajax? ฉันคิดว่าคำตอบของ @Shyju ช่วยได้
Valentin

2
@ วาเลนติน - คำตอบของฉันช่วยได้เพราะข้อมูลได้รับการตรวจสอบความถูกต้องทางฝั่งเซิร์ฟเวอร์เช่นกัน ปลั๊กอินการตรวจสอบความถูกต้องควรเปิดใช้งานการตรวจสอบความถูกต้องแบบไดนามิกเมื่อกรอกแบบฟอร์มและเมื่อส่งแบบฟอร์ม (อย่างไรก็ตาม OP ต้องการทำเช่นนั้น) เซิร์ฟเวอร์จะให้การตรวจสอบขั้นสุดท้ายซึ่งเป็นที่นิยมมากกว่าเนื่องจากสามารถข้ามการตรวจสอบความถูกต้องฝั่งไคลเอ็นต์ได้
Andrew Burgess

8
ฉันใช้ประโยชน์จากข้อความตรวจสอบความถูกต้องของ jQuery โดยการวนรอบข้อผิดพลาดที่ส่งคืนและแทรกข้อความแสดงข้อผิดพลาดลงในช่วงที่ถูกต้อง:for (var i = 0; i < modelStateErrors.length; i++) { $('span[data-valmsg-for="' + modelStateErrors[i].key + '"]').text(modelStateErrors[i].errors[0]); }
Ian

7
คำตอบนี้ดีมาก! แต่ฉันยังคิดว่าเฟรมเวิร์ก ASP.NET MVC ควรมีวิธีการทำเช่นนั้นในตัว
Zignd

40

สิ่งที่คุณควรทำคือจัดลำดับข้อมูลในฟอร์มของคุณและส่งไปยังการดำเนินการของคอนโทรลเลอร์ ASP.NET MVC จะผูกข้อมูลแบบฟอร์มกับEditPostViewModelวัตถุ (พารามิเตอร์วิธีการดำเนินการของคุณ) โดยใช้คุณลักษณะการผูกโมเดล MVC

คุณสามารถตรวจสอบความถูกต้องของแบบฟอร์มได้ที่ฝั่งไคลเอ็นต์และหากทุกอย่างเรียบร้อยดีให้ส่งข้อมูลไปยังเซิร์ฟเวอร์ valid()วิธีจะมาในสะดวก

$(function () {

    $("#yourSubmitButtonID").click(function (e) {

        e.preventDefault();
        var _this = $(this);
        var _form = _this.closest("form");

        var isvalid = _form .valid();  // Tells whether the form is valid

        if (isvalid)
        {           
           $.post(_form.attr("action"), _form.serialize(), function (data) {
              //check the result and do whatever you want
           })
        }

    });

});

1
ขอบคุณ! ฉันลองใช้ $ ("form #" + formId) .validate () แต่มันบอกว่าแบบฟอร์ม (ที่พบ) ไม่มี validate ()?
Ivy

ดูแก้ไข 1 ที่ฉันแสดงว่าสคริปต์ตรวจสอบถูกรวมอยู่ในหน้าเว็บ ฉันยังเห็นว่าการตรวจสอบกำลังทำงานเมื่อใช้ปุ่มส่งประเภทอินพุตปกติ
Ivy

ฉันพบปัญหา (ลบ Scripts.Render จาก masterpage) แต่ยังคงมีปัญหาในการส่งข้อผิดพลาดการตรวจสอบ ModelState กลับไปยังไคลเอนต์? ฉันจะจัดการกับสิ่งนั้นได้อย่างไร? ตัวอย่างเช่นหากผู้ใช้ไม่ได้ล็อกอินอีกต่อไป (ModelState.AddModelError ("CustomError", "validation text")
Ivy

1
คุณต้องรวมไฟล์ jquery.validate และ jquery.validate.unobtrusive js ไว้ในเพจของคุณ อินพุต HTML ของคุณมีแอตทริบิวต์ที่ปลั๊กอินการตรวจสอบความถูกต้องมองหาหรือไม่
Shyju

1
Ivy: ประเภทการส่งคืนของคุณ (ActionResult) เป็นคลาสพื้นฐานของ JsonResult เพื่อให้สามารถส่งคืนข้อมูล JSON สิ่งที่คุณควรทำคือหากเป็นการโทรแบบ ajax (ตรวจสอบ Request.IsAjax) รับข้อผิดพลาดในการตรวจสอบความถูกต้องและสร้าง JSON และส่งกลับไปยังไคลเอนต์ ตรวจสอบ json ในวิธีการโทรกลับของ $ .post และแสดงข้อความแสดงข้อผิดพลาด
Shyju

9

นี่เป็นวิธีที่ค่อนข้างง่าย:

ในคอนโทรลเลอร์เราแสดงข้อผิดพลาดดังนี้:

if (!ModelState.IsValid)
        {
            return Json(new { success = false, errors = ModelState.Values.SelectMany(x => x.Errors).Select(x => x.ErrorMessage).ToList() }, JsonRequestBehavior.AllowGet);
        }

นี่คือสคริปต์ไคลเอนต์บางส่วน:

function displayValidationErrors(errors)
{
    var $ul = $('div.validation-summary-valid.text-danger > ul');

    $ul.empty();
    $.each(errors, function (idx, errorMessage) {
        $ul.append('<li>' + errorMessage + '</li>');
    });
}

นั่นคือวิธีที่เราจัดการกับ ajax:

$.ajax({
    cache: false,
    async: true,
    type: "POST",
    url: form.attr('action'),
    data: form.serialize(),
    success: function (data) {
        var isSuccessful = (data['success']);

        if (isSuccessful) {
            $('#partial-container-steps').html(data['view']);
            initializePage();
        }
        else {
            var errors = data['errors'];

            displayValidationErrors(errors);
        }
    }
});

นอกจากนี้ฉันแสดงมุมมองบางส่วนผ่าน ajax ด้วยวิธีต่อไปนี้:

var view = this.RenderRazorViewToString(partialUrl, viewModel);
        return Json(new { success = true, view }, JsonRequestBehavior.AllowGet);

วิธี RenderRazorViewToString:

public string RenderRazorViewToString(string viewName, object model)
    {
        ViewData.Model = model;
        using (var sw = new StringWriter())
        {
            var viewResult = ViewEngines.Engines.FindPartialView(ControllerContext,
                                                                     viewName);
            var viewContext = new ViewContext(ControllerContext, viewResult.View,
                                         ViewData, TempData, sw);
            viewResult.View.Render(viewContext, sw);
            viewResult.ViewEngine.ReleaseView(ControllerContext, viewResult.View);
            return sw.GetStringBuilder().ToString();
        }
    }

3
"GetModelStateErrors" ของคุณสามารถทำให้ง่ายขึ้นอย่างสมบูรณ์โดยการแปลงเป็นคำสั่งบรรทัดเดียวที่ง่ายกว่า: ส่งคืน ModelState.Values.SelectMany (x => x.Errors) เลือก (x => x.ErrorMessage) .ToList ();
Camilo Terevinto

1
ทำไมไม่เพียงแค่ส่งกลับPartialViewไปที่ Ajax?
สินจัย

4

เพิ่มตรรกะเพิ่มเติมในการแก้ปัญหาโดย @Andrew Burgess นี่คือวิธีแก้ปัญหาทั้งหมด:

สร้างตัวกรองการดำเนินการเพื่อรับข้อผิดพลาดสำหรับคำขอ ajax:

public class ValidateAjaxAttribute : ActionFilterAttribute
    {
        public override void OnActionExecuting(ActionExecutingContext filterContext)
        {
            if (!filterContext.HttpContext.Request.IsAjaxRequest())
                return;

            var modelState = filterContext.Controller.ViewData.ModelState;
            if (!modelState.IsValid)
            {
                var errorModel =
                        from x in modelState.Keys
                        where modelState[x].Errors.Count > 0
                        select new
                        {
                            key = x,
                            errors = modelState[x].Errors.
                                                          Select(y => y.ErrorMessage).
                                                          ToArray()
                        };
                filterContext.Result = new JsonResult()
                {
                    Data = errorModel
                };
                filterContext.HttpContext.Response.StatusCode =
                                                      (int)HttpStatusCode.BadRequest;
            }
        }
    }

เพิ่มตัวกรองในวิธีการควบคุมของฉันเป็น:

[HttpPost]
// this line is important
[ValidateAjax]
public ActionResult AddUpdateData(MyModel model)
{
    return Json(new { status = (result == 1 ? true : false), message = message }, JsonRequestBehavior.AllowGet);
}

เพิ่มสคริปต์ทั่วไปสำหรับการตรวจสอบ jquery:

function onAjaxFormError(data) {
    var form = this;
    var errorResponse = data.responseJSON;
    $.each(errorResponse, function (index, value) {
        // Element highlight
        var element = $(form).find('#' + value.key);
        element = element[0];
        highLightError(element, 'input-validation-error');

        // Error message
        var validationMessageElement = $('span[data-valmsg-for="' + value.key + '"]');
        validationMessageElement.removeClass('field-validation-valid');
        validationMessageElement.addClass('field-validation-error');
        validationMessageElement.text(value.errors[0]);
    });
}

$.validator.setDefaults({
            ignore: [],
            highlight: highLightError,
            unhighlight: unhighlightError
        });

var highLightError = function(element, errorClass) {
    element = $(element);
    element.addClass(errorClass);
}

var unhighLightError = function(element, errorClass) {
    element = $(element);
    element.removeClass(errorClass);
}

ในที่สุดก็เพิ่มเมธอด error javascript ลงในฟอร์ม Ajax Begin ของฉัน:

@model My.Model.MyModel
@using (Ajax.BeginForm("AddUpdateData", "Home", new AjaxOptions { HttpMethod = "POST", OnFailure="onAjaxFormError" }))
{
}

1

คุณสามารถทำได้ด้วยวิธีนี้:

( แก้ไข:พิจารณาว่าคุณกำลังรอการตอบกลับjsonด้วยdataType: 'json')

.สุทธิ

public JsonResult Edit(EditPostViewModel data)
{
    if(ModelState.IsValid) 
    {
       // Save  
       return Json(new { Ok = true } );
    }

    return Json(new { Ok = false } );
}

JS:

success: function (data) {
    if (data.Ok) {
      alert('success');
    }
    else {
      alert('problem');
    }
},

หากคุณต้องการฉันสามารถอธิบายวิธีทำได้โดยส่งคืนข้อผิดพลาด 500 และรับข้อผิดพลาดในข้อผิดพลาดของเหตุการณ์ (ajax) แต่ในกรณีของคุณนี่อาจเป็นทางเลือก


1
ฉันรู้วิธีส่งคำขอ Jason ปกติ แต่สิ่งนี้จะไม่ช่วยฉันในการตรวจสอบคุณสมบัติที่แตกต่างกันหรือแม้แต่ใช้การตรวจสอบ ASP.NET MVC ในตัวที่ฉันขอ ฉันอาจจะสร้างวัตถุ Jason ที่ซับซ้อนเพื่ออธิบายข้อผิดพลาดในการตรวจสอบความถูกต้องสำหรับทุกครั้งที่เหมาะสม แต่นี่จะใช้งานได้มากและฉันหวังว่าคุณจะสามารถใช้ฟังก์ชันการทำงานในตัวของการตรวจสอบ ASP.NET MVC ซ้ำได้หรือไม่
Ivy

1 - จะเรียกใช้ฟังก์ชัน "SendPost" ของคุณอย่างไรและ 2 - ข้อมูลที่ถูกต้องของคุณบนไคลเอนต์?
andres descalzo

กรุณาอธิบาย? ไม่ได้รับโพสต์ล่าสุดของคุณ?
Ivy
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.