将ASP.NET MVC验证与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;" })

如果我在将文本框置于验证中的表单上进行提交,则将首先在客户端上执行,然后在service(ModelState.IsValid)上完成。

现在我有几个问题:

  1. 可以将其与jQuery ajax提交一起使用吗?我正在做的就是简单地删除表单,然后单击“提交”按钮,javascript将收集数据,然后运行$.ajax

  2. 服务器端可以ModelState.IsValid工作吗?

  3. 如何将验证问题转发回客户端,并像使用生成int validate(@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/…–
冒险

Answers:


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!谢谢!

3
我不明白为什么这个答案得到这么多选票。它没有回答问题1:使用$ .ajax发布时如何进行客户端验证?我认为@Shyju答案对此有所帮助。
瓦伦丁

2
@Valentin-我的回答确实有帮助,因为数据也已通过服务器端验证。验证插件应在填写表单时启用动态验证,并且在提交表单时(无论OP希望这样做),服务器将提供最终验证,无论如何,这是可取的做法,因为可以绕过客户端验证。
Andrew Burgess 2014年

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(),但是它说form(找到的)没有validate()吗?
常春藤

请参阅Edit1,其中显示网页上包含验证脚本。我还看到使用常规输入类型提交按钮时验证正在运行。
常春藤

我发现了问题(从母版页中删除了Scripts.Render)。但是仍然存在将ModelState验证错误发送回客户端的问题吗?我该怎么想呢?例如,如果用户不在的loggedIn了(ModelState.AddModelError(“CustomError”,“验证文本”)。
常春藤

1
您需要在页面中包含jquery.validate和jquery.validate.unobtrusive js文件。您的HTML输入是否具有验证插件要查找的属性?
Shyju 2012年

1
常春藤:您的返回类型(ActionResult)是JsonResult的基类。因此它可以返回JSON数据。您应该做的是,如果这是一个Ajax调用(请检查Request.IsAjax),请获取验证错误并生成JSON并将其发送回客户端。在$ .post的回调方法中检查json并显示错误消息。
Shyju 2012年

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”:return ModelState.Values.SelectMany(x => x.Errors).Select(x => x.ErrorMessage).ToList();
卡米洛·泰雷文托

1
为什么不简单地将a PartialView渲染返回给Ajax?
Sinjai

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

最后将错误的javascript方法添加到我的Ajax Begin表单中:

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

1

您可以这样操作:

编辑:考虑到你在等待的响应jsondataType: '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验证的内置功能?
常春藤

1-如何运行“ SendPost”功能?2-客户端上的有效数据?
安德烈斯·德斯卡佐

请解释一下?没有得到你的最后一个帖子?
常春藤
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.