Использовать проверку 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 submit? Я просто удаляю форму, и при нажатии кнопки отправки javascript соберет данные, а затем запустит файл $.ajax.

  2. Будет ли ModelState.IsValidработать серверная часть ?

  3. Как я могу передать проблему проверки клиенту и представить ее так, как будто я использую build int validation ( @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/…
Приключение,

Ответы:

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 поможет в этом.
Valentin
2
@Valentin - мой ответ действительно помогает, потому что данные также проверяются на стороне сервера. Плагины проверки должны включать динамическую проверку по мере заполнения формы, и когда форма отправляется (однако OP хочет это сделать), сервер предоставит окончательную проверку, что в любом случае предпочтительнее, поскольку проверку на стороне клиента можно обойти.
Эндрю Берджесс
8
Я использую интервалы проверочных сообщений jQuery, перебирая возвращаемые ошибки и вставляя сообщение об ошибке в правильный интервал:for (var i = 0; i < modelStateErrors.length; i++) { $('span[data-valmsg-for="' + modelStateErrors[i].key + '"]').text(modelStateErrors[i].errors[0]); }
Ян
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
           })
        }

    });

});
Shyju
источник
1
Спасибо! Я пробовал этот $ ("form #" + formId) .validate (), но он говорит, что найденная форма не имеет validate ()?
Ivy
См. Edit1, где я показываю, что сценарий проверки включен на веб-страницу. Я также вижу, что проверка выполняется при использовании кнопки отправки обычного типа ввода.
Ivy
Я нашел проблему (удалил Scripts.Render с главной страницы). Но все еще есть проблемы с отправкой клиенту ошибок проверки ModelState? Как я могу это решить? Например, если пользователь больше не вошел в систему (ModelState.AddModelError ("CustomError", "проверочный текст").
Ivy
1
вам нужно включить на свою страницу файлы jquery.validate и jquery.validate.unobtrusive js. Есть ли у ваших входов HTML атрибут, который ищут плагины проверки?
Shyju
1
Плющ: Ваш возвращаемый тип (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" можно полностью упростить, преобразовав его в более простой однострочный оператор: 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

Сделать это можно так:

( Изменить: учитывая, что вы ждете ответа 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
Я знаю, как выполнить обычный запрос Джейсона, однако это не поможет мне с проверкой различных свойств или даже с использованием встроенной проверки ASP.NET MVC, которую я просил. Я мог бы, вероятно, создать сложный объект Jason, чтобы объяснить ошибки проверки для каждого свойства, но это будет много работы, и я надеюсь, что вы сможете повторно использовать встроенную функциональность проверки ASP.NET MVC для этого?
Ivy
1 - как запустить вашу функцию «SendPost» ?, и 2 - ваши действительные данные на клиенте?
andres descalzo
Мольбы объясните? Не получили свой последний пост?
Ivy