ASP.NET MVC ModelStateエラーをjsonに変換する方法


127

すべての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の記述方法がわかりません...

回答:


191

句の中に好きなものを入れることができます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();

2 回目 EDIT:あなたが探していますDictionary<string, string[]>

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

それは迅速な返信です:)!よさそうですが、ModelState [item.Key]に複数のエラーがある場合はどうでしょうか。エラー[0]のみ、単一のエラーメッセージのために働く
JK。

それらをどのように組み合わせたいですか?
SLaks、

ほぼありがとうございます。ただし、エラーがなくてもすべてのキーが選択されます。エラーのないキーを除外するにはどうすればよいですか。
JK。

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

3
同じ出力を得るには、次のようにRequest.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState);使用する必要があります。 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());そうしないと、ExceptionMessagesが表示されません
Silvos

74

以下は、すべての要素を組み合わせた完全な実装です。

まず、拡張メソッドを作成します。

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

これは興味深いメソッドのように見えますが、ヘルパークラスが機能していません。これはおそらくMVC 2の変更によるものですか?ToDictionaryメソッドがmodelStateに存在しないというエラーが発生します。
Cymen

@CymenはSystem.Linqを参照するのを忘れていますか?ToDictionary()はLINQ拡張メソッドです。
ネイサンテイラー

8
あなたの好みに応じて、.Where(m => m.Value.Count() > 0)と書くこともできます.Where(m => m.Value.Any())
Manfred

これは、Kendo.MvcのModelState.ToDataSourceResult()と同様に使用して、グリッドにエラーを返し、編集中にエラーメッセージを表示できます。
マルノスナ2018

22

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

8

これを行うにはさまざまな方法がたくさんあり、すべてが機能します。これが今やります...

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

2
返すこともできBadRequest(ModelState)、JSONにシリアル化されます。
フレッド

6

これを行う最も簡単な方法はBadRequest、ModelState自体で単にを返すことです。

上の例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."
    ]
  }
}

1
BadRequestはWebAPI固有であり、この質問はMVCに関するものです。
rgripper 2016

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

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のアイデアを得た


3

組み込み機能を使用してこれを実現する簡単な方法

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

    //do something
}

JSONの結果は


2

ToDictionaryは、System.Web.Extensions dll http://msdn.microsoft.com/en-us/library/system.linq.enumerable.todictionary.aspxにパッケージされているSystem.LinqにあるEnumerable拡張機能です。完全なクラスは次のようになります。

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

元のModelStateオブジェクトをクライアントに返してから、jQueryを使用して値を読み取ってみませんか。私にはそれははるかに単純に見え、一般的なデータ構造(.netの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);
        }

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

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

-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を返すことができます、私は試していません。ErrorsコレクションをViewModelに割り当ててループします。この場合、jsonを介してErrorsを返すことができます。クラス/モデルがあり、ソース/キーを取得したかったのですが、それを理解しようとしています。

    public class ErrorList
{
    public string ErrorMessage;
}
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.