Как получить все ошибки из ASP.Net MVC modelState?


455

Я хочу получить все сообщения об ошибках из modelState, не зная значений ключей. Циклически перебирайте все сообщения об ошибках, которые содержит ModelState.

Как я могу это сделать?


5
Если вы просто отображаете ошибки, @Html.ValidationSummary()это быстрый способ отобразить их все как бритва.
Левининя

11
foreach (var error in ViewData.ModelState.Values.SelectMany(modelState => modelState.Errors)) { DoSomething(error); }
Разван Думитру

Ответы:


534
foreach (ModelState modelState in ViewData.ModelState.Values) {
    foreach (ModelError error in modelState.Errors) {
        DoSomethingWith(error);
    }
}

См. Также Как получить коллекцию ошибок состояния модели в ASP.NET MVC? ,


23
Очень полезно. Обратите внимание, что в некоторых сценариях, таких как ошибки привязки и неправильные запросы, будут записи ModelState с пустой строкой для Value.ErrorMessageи вместо этогоValue.Exception.Message
AaronLS

5
Ошибки хороши, но иногда вам также нужен ключ состояния модели (то есть имя поля). вы можете получить , что, изменив первую строку на это: foreach (KeyValuePair<string, ModelState> kvp in htmlHelper.ViewData.ModelState) {и вставить эту строку под ним: var modelState = kvp.Value;. Вы можете получить ключ отkvp.Key
Viggity

536

Используя LINQ :

IEnumerable<ModelError> allErrors = ModelState.Values.SelectMany(v => v.Errors);

70
Модифицировано для возврата IEnumerable <string> только с сообщением об ошибке :: var allErrors = ModelState.Values.SelectMany (v => v.Errors.Select (b => b.ErrorMessage));
Киран

6
Это здорово, но, к сожалению, Windows Watch / Immediate не поддерживает лямбда-
каналы

3
Да! Мне (вам, кому угодно) нужно "использовать System.Linq;" На вершине. В противном случае вы получили сообщение «Значения не содержат определения для выбора многих». Это отсутствовало в моем случае.
Эстевес

2
зачем в аду использование вар ?????? не могли бы вы написать `IEnumerable <ModelError> 'вместо этого ???
Хакан Фыстик

6
@ hakam-fostok @ jb06 вы оба правы. Печатание List<string> errors = new List<string>()вместо того, чтобы var errors = new List<string>()действительно тратить время, но письмо IEnumerable<ModelError> allErrors = ModelState.Values.SelectMany(v => v.Errors);, где тип возвращаемого значения не совсем понятен, действительно лучше с точки зрения читабельности. (даже если Visual Studio может дать его вам при наведении мыши)
aprovent

193

Опираясь на версию LINQ, если вы хотите объединить все сообщения об ошибках в одну строку:

string messages = string.Join("; ", ModelState.Values
                                        .SelectMany(x => x.Errors)
                                        .Select(x => x.ErrorMessage));

5
Другой вариант заключается в следующем: ModelState.Values.SelectMany (x => x.Errors) .Select (x => x.ErrorMessage) .JoinString (";");
Тод Томсон

3
@Tod, IEnumerable.JoinString () ваш собственный метод расширения? См. Stackoverflow.com/q/4382034/188926
Дунк

2
Эй, Дунк - да, я подозреваю, что я добавил этот метод расширения в свою базу кода и забыл об этом, а затем подумал, что это метод фреймворка LOL :(
Тод Томсон

5
или ... ModelState.Values.SelectMany (O => O.Errors) .Select (O => O.ErrorMessage) .Aggregate ((U, V) => U + "," + V)
fordareh

2
Это прекрасно работает, когда вы используете веб-API и возвращаете результат IHttpActionResult. Итак, вы можете просто сделать: return BadRequest (messages); Спасибо, Дунк!
Рич Уорд

32

Я смог сделать это с помощью небольшого LINQ,

public static List<string> GetErrorListFromModelState
                                              (ModelStateDictionary modelState)
{
      var query = from state in modelState.Values
                  from error in state.Errors
                  select error.ErrorMessage;

      var errorList = query.ToList();
      return errorList;
}

Вышеуказанный метод возвращает список ошибок проверки.

Дальнейшее чтение :

Как прочитать все ошибки из ModelState в ASP.NET MVC


17

Во время отладки я считаю полезным поместить таблицу внизу каждой из моих страниц, чтобы показать все ошибки ModelState.

<table class="model-state">
    @foreach (var item in ViewContext.ViewData.ModelState) 
    {
        if (item.Value.Errors.Any())
        { 
        <tr>
            <td><b>@item.Key</b></td>
            <td>@((item.Value == null || item.Value.Value == null) ? "<null>" : item.Value.Value.RawValue)</td>
            <td>@(string.Join("; ", item.Value.Errors.Select(x => x.ErrorMessage)))</td>
        </tr>
        }
    }
</table>

<style>
    table.model-state
    {
        border-color: #600;
        border-width: 0 0 1px 1px;
        border-style: solid;
        border-collapse: collapse;
        font-size: .8em;
        font-family: arial;
    }

    table.model-state td
    {
        border-color: #600;
        border-width: 1px 1px 0 0;
        border-style: solid;
        margin: 0;
        padding: .25em .75em;
        background-color: #FFC;
    }
 </style>

если есть какие-либо крайние случаи здесь, где это терпит неудачу, пожалуйста, просто отредактируйте ответ, чтобы исправить это
Simon_Weaver

12

Как я обнаружил, следуя рекомендациям в приведенных выше ответах, вы можете получить исключения, возникающие без установки сообщений об ошибках, поэтому для выявления всех проблем вам действительно нужно получить и ErrorMessage, и Exception.

String messages = String.Join(Environment.NewLine, ModelState.Values.SelectMany(v => v.Errors)
                                                           .Select( v => v.ErrorMessage + " " + v.Exception));

или как метод расширения

public static IEnumerable<String> GetErrors(this ModelStateDictionary modelState)
{
      return modelState.Values.SelectMany(v => v.Errors)
                              .Select( v => v.ErrorMessage + " " + v.Exception).ToList();

}

зачем вам строка со всеми ошибками? не имеет смысла, когда вы хотите что-то сделать с этим в представлении, массив списков намного лучше imho
Даниэль Тулп

1
Отлаживать. Моей первой проблемой было выяснить, что не так с моим приложением. Я не пытался сказать пользователю просто узнать, что происходит не так. Кроме того, тривиально преобразовать этот пример из создания перечисления строк в перечисление чего-то другого, например, сообщения об ошибке и исключения, поэтому действительно полезно знать, что вам нужны оба бита информации
Алан Макдональд

Кстати, вы понимали, что второй метод расширения возвращает IEnumerable <String>, а не просто одну большую строку?
Алан Макдональд

8

В случае, если кто-то хочет вернуть имя свойства модели для привязки сообщения об ошибке в строго типизированном представлении.

List<ErrorResult> Errors = new List<ErrorResult>();
foreach (KeyValuePair<string, ModelState> modelStateDD in ViewData.ModelState)
{
    string key = modelStateDD.Key;
    ModelState modelState = modelStateDD.Value;

    foreach (ModelError error in modelState.Errors)
    {
        ErrorResult er = new ErrorResult();
        er.ErrorMessage = error.ErrorMessage;
        er.Field = key;
        Errors.Add(er);
    }
}

Таким образом, вы можете связать ошибку с полем, которое выдало ошибку.


7

Вывод только сообщений об ошибках сам по себе был недостаточен, но это помогло.

var modelQuery = (from kvp in ModelState
                  let field = kvp.Key
                  let state = kvp.Value
                  where state.Errors.Count > 0
                  let val = state.Value?.AttemptedValue ?? "[NULL]"

                  let errors = string.Join(";", state.Errors.Select(err => err.ErrorMessage))
                  select string.Format("{0}:[{1}] (ERRORS: {2})", field, val, errors));

Trace.WriteLine(string.Join(Environment.NewLine, modelQuery));

1
В качестве предупреждения пары значений ключа в ModelState могут содержать значения NULL, поэтому в исходный код был включен какой-то симпатичный бизнес на C # 6 с оператором null-coalesce (?.), Отсюда и каррирование в ?? в конце выражения. Исходное выражение, которое должно защищать от нулевых ошибок, было: state.Value.?AttemptedValue ?? "[ЗНАЧЕНИЕ NULL]". Насколько я знаю, код в его текущем состоянии, без хитрой обработки случаев, когда state.Value == null, находится под угрозой.
Джош Саттерфилд

5

На всякий случай, если кому-то это нужно, я сделал и использую следующий статический класс в своих проектах.

Пример использования:

if (!ModelState.IsValid)
{
    var errors = ModelState.GetModelErrors();
    return Json(new { errors });
}

Usings:

using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Web.Mvc;
using WebGrease.Css.Extensions;

Учебный класс:

public static class ModelStateErrorHandler
{
    /// <summary>
    /// Returns a Key/Value pair with all the errors in the model
    /// according to the data annotation properties.
    /// </summary>
    /// <param name="errDictionary"></param>
    /// <returns>
    /// Key: Name of the property
    /// Value: The error message returned from data annotation
    /// </returns>
    public static Dictionary<string, string> GetModelErrors(this ModelStateDictionary errDictionary)
    {
        var errors = new Dictionary<string, string>();
        errDictionary.Where(k => k.Value.Errors.Count > 0).ForEach(i =>
        {
            var er = string.Join(", ", i.Value.Errors.Select(e => e.ErrorMessage).ToArray());
            errors.Add(i.Key, er);
        });
        return errors;
    }

    public static string StringifyModelErrors(this ModelStateDictionary errDictionary)
    {
        var errorsBuilder = new StringBuilder();
        var errors = errDictionary.GetModelErrors();
        errors.ForEach(key => errorsBuilder.AppendFormat("{0}: {1} -", key.Key,key.Value));
        return errorsBuilder.ToString();
    }
}

Спасибо CodeArtist! Я сделал небольшое изменение в коде ниже его реализации.
Альфред Северо

4

И это тоже работает:

var query = from state in ModelState.Values
    from error in state.Errors
    select error.ErrorMessage;
var errors = query.ToArray(); // ToList() and so on...

@Yasser Ты видел ответ Тото?
Маффин Ман

@ TheMuffinMan да, у меня есть. Что насчет этого ?
Ясир Шейх

@Yasser Это лучший ответ. В этом нет ничего плохого, но нет смысла использовать его, когда SelectManyон доступен.
Маффин Ман

4

Полезно для передачи массива сообщений об ошибках в View, возможно, через Json:

messageArray = this.ViewData.ModelState.Values.SelectMany(modelState => modelState.Errors, (modelState, error) => error.ErrorMessage).ToArray();

4

Это расширяется после ответа от @Dunc. Смотрите комментарии в формате XML

// ReSharper disable CheckNamespace
using System.Linq;
using System.Web.Mvc;


public static class Debugg
{
    /// <summary>
    /// This class is for debugging ModelState errors either in the quick watch 
    /// window or the immediate window.
    /// When the model state contains dozens and dozens of properties, 
    /// it is impossible to inspect why a model state is invalid.
    /// This method will pull up the errors
    /// </summary>
    /// <param name="modelState">modelState</param>
    /// <returns></returns>
    public static ModelError[]  It(ModelStateDictionary modelState)
    {
        var errors = modelState.Values.SelectMany(x => x.Errors).ToArray();
        return errors;            
    }
}

3

Кроме того, ModelState.Values.ErrorMessageможет быть пустым, но ModelState.Values.Exception.Messageможет указывать на ошибку.


0

В вашей реализации вам не хватает статического класса, это должно быть.

if (!ModelState.IsValid)
{
    var errors =  ModelStateErrorHandler.GetModelErrors(this.ModelState);
    return Json(new { errors });
}

скорее

if (!ModelState.IsValid)
{
    var errors = ModelState.GetModelErrors();
    return Json(new { errors });
}

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.