ASP.NET MVC開発者必見！Model Stateを使いこなしてエラー処理をスマートに

2024-04-02

ASP.NET MVCでモデル状態エラーのコレクションを取得する方法

ModelStateプロパティ

Controllerクラスには、ModelStateというプロパティが用意されています。これはDictionary<string, ModelState>型のオブジェクトであり、キーはモデルのプロパティ名、値はModelState型のオブジェクトとなります。ModelStateオブジェクトには、IsValidプロパティやErrorsプロパティなど、エラーに関する情報が含まれています。

public ActionResult Create(Product product)
{
    if (!ModelState.IsValid)
    {
        // エラー処理
        foreach (var error in ModelState.Values.SelectMany(x => x.Errors))
        {
            // エラーメッセージの表示
            ModelState.AddModelError("", error.ErrorMessage);
        }
        return View(product);
    }

    // データベースへの保存処理

    return RedirectToAction("Index");
}

上記の例では、ModelState.IsValidプロパティを使用して、モデル全体にエラーがないかどうかを確認しています。エラーがある場合は、ModelState.Valuesプロパティをループ処理して、各プロパティのErrorsプロパティから個々のエラーメッセージを取得しています。

HtmlHelperクラスには、Model Stateのエラー情報を扱う拡張メソッドが用意されています。これらの拡張メソッドを使用すると、より簡単にエラーメッセージを表示することができます。

@Html.ValidationSummary(true)

@foreach (var error in ModelState.Values.SelectMany(x => x.Errors))
{
    <div class="error-message">@error.ErrorMessage</div>
}

上記の例では、@Html.ValidationSummary(true)を使用して、すべてのエラーメッセージを箇条書きで表示しています。また、@foreachループを使用して、個々のエラーメッセージを任意の形式で表示することができます。

その他の方法

上記以外にも、以下の方法でModel Stateのエラー情報を取得することができます。

ViewDataやTempDataにエラー情報を格納する
カスタムヘルパーを作成する

これらの方法は、より複雑な処理が必要な場合に役立ちます。

ASP.NET MVCでモデル状態エラーのコレクションを取得するには、ModelStateプロパティやHtmlHelper拡張メソッドを使用することができます。これらの方法を理解することで、ユーザーインターフェースでエラー情報を適切に表示することが可能になります。

ModelStateプロパティ

public ActionResult Create(Product product)
{
    if (!ModelState.IsValid)
    {
        // エラー処理
        foreach (var error in ModelState.Values.SelectMany(x => x.Errors))
        {
            // エラーメッセージの表示
            ModelState.AddModelError("", error.ErrorMessage);
        }
        return View(product);
    }

    // データベースへの保存処理

    return RedirectToAction("Index");
}

HtmlHelper拡張メソッド

@Html.ValidationSummary(true)

@foreach (var error in ModelState.Values.SelectMany(x => x.Errors))
{
    <div class="error-message">@error.ErrorMessage</div>
}

ViewData/TempData

public ActionResult Create(Product product)
{
    if (!ModelState.IsValid)
    {
        // エラー処理
        ViewData["Errors"] = ModelState.Values.SelectMany(x => x.Errors).Select(x => x.ErrorMessage);
        return View(product);
    }

    // データベースへの保存処理

    return RedirectToAction("Index");
}

public static class MyHtmlHelperExtensions
{
    public static IHtmlString DisplayErrors(this HtmlHelper helper)
    {
        var errors = helper.ViewData["Errors"] as IEnumerable<string>;
        if (errors != null)
        {
            var builder = new StringBuilder();
            foreach (var error in errors)
            {
                builder.AppendFormat("<div class=\"error-message\">{0}</div>", error);
            }
            return new HtmlString(builder.ToString());
        }
        return new HtmlString("");
    }
}

@Html.DisplayErrors()

上記のコードはあくまでも例であり、実際の使用例に合わせて変更する必要があります。

ModelStateのエラー情報を取得するその他的方法

ModelStateDictionaryクラスには、独自の拡張メソッドを作成することができます。これらの拡張メソッドを使用して、特定のプロパティのエラーメッセージを取得したり、エラーメッセージをフィルタリングしたりすることができます。

public static class ModelStateDictionaryExtensions
{
    public static IEnumerable<string> GetErrorsForProperty(this ModelStateDictionary modelState, string propertyName)
    {
        if (modelState.ContainsKey(propertyName))
        {
            return modelState[propertyName].Errors.Select(x => x.ErrorMessage);
        }
        return Enumerable.Empty<string>();
    }
}

上記の例では、GetErrorsForPropertyという拡張メソッドを作成しています。この拡張メソッドは、指定されたプロパティのエラーメッセージのコレクションを取得します。

FluentValidationのようなライブラリを使用すると、モデルの検証ロジックをより簡単に記述することができます。FluentValidationは、モデル検証の結果をValidationResultオブジェクトに格納します。このオブジェクトから、エラーメッセージを取得することができます。

public class ProductValidator : AbstractValidator<Product>
{
    public ProductValidator()
    {
        RuleFor(x => x.Name).NotEmpty().WithMessage("名前を入力してください");
        RuleFor(x => x.Price).GreaterThan(0).WithMessage("価格は0より大きくする必要があります");
    }
}

public ActionResult Create(Product product)
{
    var validator = new ProductValidator();
    var validationResult = validator.Validate(product);

    if (!validationResult.IsValid)
    {
        // エラー処理
        foreach (var error in validationResult.Errors)
        {
            // エラーメッセージの表示
            ModelState.AddModelError(error.PropertyName, error.ErrorMessage);
        }
        return View(product);
    }

    // データベースへの保存処理

    return RedirectToAction("Index");
}