134

如何获得所有 ModelState 错误消息的列表?我找到了这段代码来获取所有键:(返回带有 ModelState 错误的键列表

var errorKeys = (from item in ModelState
        where item.Value.Errors.Any() 
        select item.Key).ToList();

但是我如何将错误消息作为 IList 或 IQueryable 获取?

我可以去:

foreach (var key in errorKeys)
{
    string msg = ModelState[error].Errors[0].ErrorMessage;
    errorList.Add(msg);
}

但那是手动完成的——肯定有办法使用 LINQ 来完成吗?.ErrorMessage 属性在链条的下游,我不知道如何编写 LINQ ......

4

14 回答 14

202

您可以在子句中放入任何您想要的内容:select

var errorList = (from item in ModelState
        where item.Value.Errors.Any() 
        select item.Value.Errors[0].ErrorMessage).ToList();

编辑from:您可以通过添加子句将多个错误提取到单独的列表项中,如下所示:

var errorList = (from item in ModelState.Values
        from error in item.Errors
        select error.ErrorMessage).ToList();

或者:

var errorList = ModelState.Values.SelectMany(m => m.Errors)
                                 .Select(e => e.ErrorMessage)
                                 .ToList();

第二次编辑您正在寻找Dictionary<string, string[]>

var errorList = ModelState.ToDictionary(
    kvp => kvp.Key,
    kvp => kvp.Value.Errors.Select(e => e.ErrorMessage).ToArray()
);
于 2010-05-16T23:11:08.737 回答
77

这是所有部分放在一起的完整实现:

首先创建一个扩展方法:

public static class ModelStateHelper
{
    public static IEnumerable Errors(this ModelStateDictionary modelState)
    {
        if (!modelState.IsValid)
        {
            return modelState.ToDictionary(kvp => kvp.Key,
                kvp => kvp.Value.Errors
                                .Select(e => e.ErrorMessage).ToArray())
                                .Where(m => m.Value.Any());
        }
        return null;
    }
}

然后调用该扩展方法并将控制器操作中的错误(如果有)作为 json 返回:

if (!ModelState.IsValid)
{
    return Json(new { Errors = ModelState.Errors() }, JsonRequestBehavior.AllowGet);
}

最后,在客户端显示这些错误(以 jquery.validation 样式,但可以轻松更改为任何其他样式)

function DisplayErrors(errors) {
    for (var i = 0; i < errors.length; i++) {
        $("<label for='" + errors[i].Key + "' class='error'></label>")
        .html(errors[i].Value[0]).appendTo($("input#" + errors[i].Key).parent());
    }
}
于 2010-05-17T03:25:07.360 回答
23

我喜欢在Hashtable这里使用,以便我以字符串数组的形式获取 JSON 对象,其中属性作为键,错误作为值。

var errors = new Hashtable();
foreach (var pair in ModelState)
{
    if (pair.Value.Errors.Count > 0)
    {
        errors[pair.Key] = pair.Value.Errors.Select(error => error.ErrorMessage).ToList();
    }
}
return Json(new { success = false, errors });

这样你会得到以下响应:

{
   "success":false,
   "errors":{
      "Phone":[
         "The Phone field is required."
      ]
   }
}
于 2013-09-04T21:09:27.240 回答
9

最简单的方法是只返回BadRequest带有 ModelState 本身的 a :

例如在一个PUT

[HttpPut]
public async Task<IHttpActionResult> UpdateAsync(Update update)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    // perform the update

    return StatusCode(HttpStatusCode.NoContent);
}

如果我们在类中使用例如手机号码的数据注释,如下所示Update

public class Update {
    [StringLength(22, MinimumLength = 8)]
    [RegularExpression(@"^\d{8}$|^00\d{6,20}$|^\+\d{6,20}$")]
    public string MobileNumber { get; set; }
}

这将在无效请求上返回以下内容:

{
  "Message": "The request is invalid.",
  "ModelState": {
    "update.MobileNumber": [
      "The field MobileNumber must match the regular expression '^\\d{8}$|^00\\d{6,20}$|^\\+\\d{6,20}$'.",
      "The field MobileNumber must be a string with a minimum length of 8 and a maximum length of 22."
    ]
  }
}
于 2015-11-24T08:24:52.950 回答
8

有很多不同的方法可以做到这一点,所有这些都有效。这就是我现在做的......

if (ModelState.IsValid)
{
    return Json("Success");
}
else
{
    return Json(ModelState.Values.SelectMany(x => x.Errors));
}
于 2013-11-29T12:11:25.363 回答
6

通过使用内置功能实现此目的的简单方法

[HttpPost]
public IActionResult Post([FromBody]CreateDoctorInput createDoctorInput) {
    if (!ModelState.IsValid) {
        return BadRequest(ModelState);
    }

    //do something
}

JSON 结果将是

于 2018-08-15T04:34:23.513 回答
5

@JK 它对我帮助很大,但为什么不:

 public class ErrorDetail {

        public string fieldName = "";
        public string[] messageList = null;
 }

        if (!modelState.IsValid)
        {
            var errorListAux = (from m in modelState 
                     where m.Value.Errors.Count() > 0 
                     select
                        new ErrorDetail
                        { 
                                fieldName = m.Key, 
                                errorList = (from msg in m.Value.Errors 
                                             select msg.ErrorMessage).ToArray() 
                        })
                     .AsEnumerable()
                     .ToDictionary(v => v.fieldName, v => v);
            return errorListAux;
        }
于 2012-11-25T04:47:51.653 回答
3

看看 System.Web.Http.Results.OkNegotiatedContentResult。

它将您投入其中的任何内容转换为 JSON。

所以我做了这个

var errorList = ModelState.ToDictionary(kvp => kvp.Key.Replace("model.", ""), kvp => kvp.Value.Errors[0].ErrorMessage);

return Ok(errorList);

这导致:

{
  "Email":"The Email field is not a valid e-mail address."
}

我还没有检查当每个字段有多个错误时会发生什么,但关键是 OkNegoriatedContentResult 非常棒!

从@SLaks 得到了 linq/lambda 的想法

于 2015-10-14T09:01:25.187 回答
2

ToDictionary 是在 System.Linq 中找到的可枚举扩展,打包在 System.Web.Extensions dll http://msdn.microsoft.com/en-us/library/system.linq.enumerable.todictionary.aspx中。这是我的完整课程的样子。

using System.Collections;
using System.Web.Mvc;
using System.Linq;

namespace MyNamespace
{
    public static class ModelStateExtensions
    {
        public static IEnumerable Errors(this ModelStateDictionary modelState)
        {
            if (!modelState.IsValid)
            {
                return modelState.ToDictionary(kvp => kvp.Key,
                    kvp => kvp.Value.Errors.Select(e => e.ErrorMessage).ToArray()).Where(m => m.Value.Count() > 0);
            }
            return null;
        }

    }

}
于 2010-09-10T18:31:01.050 回答
2

为什么不将原始ModelState对象返回给客户端,然后使用 jQuery 读取值。对我来说它看起来更简单,并使用通用数据结构(.net's ModelState

要返回ModelStateJson,只需将其传递给 Json 类构造函数(适用于任何对象)

C#:

return Json(ModelState);

js:

        var message = "";
        if (e.response.length > 0) {
            $.each(e.response, function(i, fieldItem) {
                $.each(fieldItem.Value.Errors, function(j, errItem) {
                    message += errItem.ErrorMessage;
                });
                message += "\n";
            });
            alert(message);
        }
于 2013-09-20T12:12:22.237 回答
1

返回类型的变化而不是返回 IEnumerable

public static class ModelStateHelper
{
    public static IEnumerable<KeyValuePair<string, string[]>> Errors(this ModelStateDictionary modelState)
    {
        if (!modelState.IsValid)
        {
            return modelState
                .ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Errors.Select(e => e.ErrorMessage).ToArray())
                .Where(m => m.Value.Any());
        }

        return null;
    }
}
于 2013-01-31T16:41:52.800 回答
1

我遇到了同样的障碍,想控制我的 400 Bad Request 输出格式,但又不想弄脏序列化ModelState. 我会使用密封的(但谢天谢地是公开的)SerializableError类。

var errorDetails = new SerializableError(ModelState);

var errorResponse = new YourCustomResponseType
{
    ModelValidationErrors = errorDetails,
    LogMessages = new []
    {
        new LogMessage("Error", "Invalid model - see modelValidationErrors for detail")
    }
};
return BadRequest(errorResponse);

哪里YourCustomResponseType可能看起来像这样:

public class YourCustomResponseType
{
        public LogMessage[] LogMessages { get; set; }
        public Dictionary<string, object> ModelValidationErrors { get; set; }
}

SerializableErrorDictionary<string, object>这样的,所以效果很好。您的回复可能如下所示:

{
    "logMessages": [
        {
            "category": "Error",
            "message": "Invalid model - see modelValidationErrors for detail"
        }
    ],
    "modelValidationErrors": {
        "aSettingsType.someEnumField": [
            "The input was not valid."
        ]
    }
}
于 2020-12-22T18:35:42.540 回答
0

我做了一个扩展,它返回带有分隔符“”的字符串(你可以使用你自己的):

   public static string GetFullErrorMessage(this ModelStateDictionary modelState) {
        var messages = new List<string>();

        foreach (var entry in modelState) {
            foreach (var error in entry.Value.Errors)
                messages.Add(error.ErrorMessage);
        }

        return String.Join(" ", messages);
    }
于 2018-10-15T06:39:08.700 回答
-1
  List<ErrorList> Errors = new List<ErrorList>(); 


        //test errors.
        var modelStateErrors = this.ModelState.Keys.SelectMany(key => this.ModelState[key].Errors);

        foreach (var x in modelStateErrors)
        {
            var errorInfo = new ErrorList()
            {
                ErrorMessage = x.ErrorMessage
            };
            Errors.Add(errorInfo);

        }

如果你使用 jsonresult 然后返回

return Json(Errors);

或者你可以简单地返回modelStateErrors,我没试过。我所做的是将错误集合分配给我的 ViewModel,然后循环它。在这种情况下,我可以通过 json 返回我的错误。我有一个类/模型,我想获取源/密钥,但我仍在试图弄清楚。

    public class ErrorList
{
    public string ErrorMessage;
}
于 2017-02-06T16:16:24.117 回答