ASP.NET MVC ModelState hatalarını json'a dönüştürme


127

Tüm ModelState hata mesajlarının bir listesini nasıl alırsınız? Tüm anahtarları almak için bu kodu buldum: ( ModelState hataları olan anahtarların bir listesini döndürme )

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

Ancak hata mesajlarını IList veya IQueryable olarak nasıl alırım?

Gidebilirdim:

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

Ama bunu manuel olarak yapmak - tabii ki LINQ kullanarak yapmanın bir yolu var mı? .ErrorMessage özelliği, zincirin o kadar aşağısında ki LINQ'yi nasıl yazacağımı bilmiyorum ...

Yanıtlar:


192

Maddenin içine istediğiniz her şeyi koyabilirsiniz select:

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

DÜZENLEME : Aşağıdaki fromgibi bir cümle ekleyerek birden fazla hatayı ayrı liste öğelerine ayıklayabilirsiniz :

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

Veya:

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

2 nd DÜZENLEME : Bir arıyorsanız Dictionary<string, string[]>:

var errorList = ModelState.ToDictionary(
    kvp => kvp.Key,
    kvp => kvp.Value.Errors.Select(e => e.ErrorMessage).ToArray()
);

Bu hızlı bir cevap :)! İyi görünüyor, ama ya ModelState [item.Key] birden fazla hata içeriyorsa? Hatalar [0] yalnızca tek bir hata mesajı için çalışır
JK.

Onları nasıl birleştirmek istersiniz?
SLaks

Neredeyse teşekkürler - ama hiç hata olmasa bile her anahtarı seçiyor - anahtarları hatasız nasıl filtreleyebiliriz?
JK.

4
Ekle.Where(kvp => kvp.Value.Errors.Count > 0)
SLaks

3
Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState);Sizinle aynı çıktıyı almak için kullanmalısınız var errorList = modelState.Where(elem => elem.Value.Errors.Any()) .ToDictionary( kvp => kvp.Key, kvp => kvp.Value.Errors.Select(e => string.IsNullOrEmpty(e.ErrorMessage) ? e.Exception.Message : e.ErrorMessage).ToArray());Aksi takdirde ExceptionMessages
Silvos

74

İşte tüm parçaların bir araya getirildiği tam uygulama:

Önce bir uzantı yöntemi oluşturun:

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

Ardından bu uzantı yöntemini çağırın ve denetleyici eyleminden (varsa) hataları json olarak döndürün:

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

Ve son olarak, bu hataları istemci tarafında gösterin (jquery.validation stilinde, ancak başka bir stile kolayca değiştirilebilir)

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

Bu ilginç bir yöntem gibi görünüyor ancak yardımcı sınıf benim için çalışmıyor. Bu belki MVC 2'deki değişikliklerden mi kaynaklanıyor? ToDictionary yönteminin modelState üzerinde bulunmadığına dair bir hata alıyorum.
Cymen

@Cymen System.Linq'e başvurmayı unuttunuz mu? ToDictionary (), bir LINQ genişletme yöntemidir.
Nathan Taylor

8
Tercihlerinize tabi olarak .Where(m => m.Value.Count() > 0)da yazılabilir .Where(m => m.Value.Any()).
Manfred

Bu, hataları Grid'e döndürmek ve düzenleme sırasında hata mesajlarını görüntülemek için Kendo.Mvc'den ModelState.ToDataSourceResult () ile benzer şekilde kullanılabilir.
malnosna

22

HashtableBurada kullanmayı seviyorum , böylece anahtar olarak özelliklere sahip JSON nesnesi ve dize dizisi biçiminde değer olarak hatalar elde ediyorum.

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

Bu şekilde aşağıdaki yanıtı alırsınız:

{
   "success":false,
   "errors":{
      "Phone":[
         "The Phone field is required."
      ]
   }
}

8

Tüm işe yarayan bunu yapmanın birçok farklı yolu vardır. İşte şimdi yapıyorum ...

if (ModelState.IsValid)
{
    return Json("Success");
}
else
{
    return Json(ModelState.Values.SelectMany(x => x.Errors));
}

2
Ayrıca geri dönebilirsiniz BadRequest(ModelState)ve sizin için JSON'a seri hale getirecektir.
Fred

6

Bunu yapmanın en kolay yolu BadRequest, ModelState'in kendisiyle birlikte bir döndürmektir :

Örneğin PUT:

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

    // perform the update

    return StatusCode(HttpStatusCode.NoContent);
}

UpdateSınıfta bunun gibi bir cep telefonu numarasında veri ek açıklamalarını kullanırsak :

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

Bu, geçersiz bir istek üzerine aşağıdakileri döndürür:

{
  "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."
    ]
  }
}

1
BadRequest WebAPI'ye özeldir ve bu soru MVC ile ilgilidir.
rgripper

5

@JK bana çok yardımcı oldu ama neden olmasın:

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

3

System.Web.Http.Results.OkNegotiatedContentResult'a bir göz atın.

İçine attığınız her şeyi JSON'a dönüştürür.

Bu yüzden yaptım

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

return Ok(errorList);

Bu sonuçlandı:

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

Her alan için birden fazla hata olduğunda ne olacağını henüz kontrol etmedim, ancak önemli olan OkNegoriatedContentResult harika!

Linq / lambda fikrini @SLaks'tan aldım


3

Yerleşik işlevselliği kullanarak bunu başarmanın basit yolu

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

    //do something
}

JSON sonucu olacak


2

ToDictionary, System.Web.Extensions dll http://msdn.microsoft.com/en-us/library/system.linq.enumerable.todictionary.aspx paketinde bulunan System.Linq içinde bulunan bir Numaralandırılabilir uzantıdır . İşte tüm sınıf benim için neye benziyor.

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

    }

}

2

Neden orijinal ModelStatenesneyi istemciye iade etmiyorsunuz ve ardından değerleri okumak için jQuery kullanmıyorsunuz? Bana göre çok daha basit görünüyor ve ortak veri yapısını kullanıyor (.net'ler ModelState)

dönmek için ModelStateJson olarak , Json sınıf yapıcısına geçirmeniz yeterlidir (HERHANGİ bir nesneyle çalışır)

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

1

IEnumerable döndürmek yerine dönüş türüne sahip varyasyon

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

0

"" Ayırıcı ile dize döndüren bir uzantı yaptım (kendi uzantınızı kullanabilirsiniz):

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

-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 kullanıyorsanız geri dönün

return Json(Errors);

veya basitçe modelStateErrors'ı iade edebilirsiniz, henüz denemedim. Yaptığım, Errors koleksiyonunu ViewModel'ime atamak ve sonra döngüye sokmaktı ... Bu durumda, Hatalarımı json aracılığıyla döndürebilirim. Bir sınıfım / modelim var, kaynağı / anahtarı almak istedim ama yine de anlamaya çalışıyorum.

    public class ErrorList
{
    public string ErrorMessage;
}
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.