MVC モデルのバリデーションについて

Question

モデルでアノテーション（Required）を指定しているプロパティが4つあります。

 [Required]
       public string A { get; set; }
  [Required]
       public string B { get; set; }
  [Required]
       public string C { get; set; }
  [Required]
       public string D { get; set; }

条件によってこのアノテーションを無効にしたり有効にしたりする方法はありますでしょうか？(Dだけは必ず有効）

FLGというプロパティがあるとして、その値が1の時はRequiredを有効0の時は無効みたいな事が出来ればいいと思っています。

カスタムバリデーションなどで下記のようなことも考えましたが、「m.A」の所をABCすべてに対応させる方法がわかりませんでした。

  public static ValidationResult CheckRequired(Test m)
    {
        if (m.FLG=="1" && m.A == null)
        {
            return new ValidationResult("エラー");
        }
        return ValidationResult.Success;
    }

Comments

[SurferOnWww]

ASP.NET MVC の話ですよね？　であれば、ASP.NET とか ASP.NET MVC Framework というタグがありますのでそちらを使っていただければと思います。

[SurferOnWww]

「条件によって」とは具体的にどういうことでしょう？　また、できれば全体的なやりたいことのシナリオ・ストーリーも書いていただけませんか。局所的な部分を切り出して質問すると、真にやりたいことの解決にはなかなかつながりにくいケースが多いので。また、こうした方が良いという代案が出てくるかもしれませんし。

[ShouOkada]

タグの編集しました。A,B,C,D４つのテキストボックスとFLGというチェックボックスがあるときに、FLGのチェックボックスがONのときのみテキストボックスA、B、Cの必須チェックを行いたいと思っています。（チェックボックスがOFFの時はABCは非活性でDだけは常に入力チェックを行う）

[SurferOnWww]

クライアント側での検証は行わず、サーバー側だけで検証するなら比較的簡単にできそうな気がしますが（未検証なので今のところ気がするだけです）、それで OK ですか？

Answer 1

条件付きの必須ということは、その条件のロジックを実装する必要があります。
つまりアノテーション１行では表現できないはずです。
従って、モデルにIValidatableObjectインターフェイスを実装してValidateメソッドで行うのが普通ではないでしょうか。

質問者様の追記を見て下記仕様と想定し、ソースコードを記載します。

• FLGのチェックボックスがONのときのみテキストボックスA、B、Cの必須チェックを行う
• チェックボックスがOFFの時はABCは非活性
• Dだけは常に必須チェックを行う

[Serializable]
public class TestModel : IValidatableObject
{
    public string Flg { get; set; }
    public string A { get; set; }
    public string B { get; set; }
    public string C { get; set; }
    [Required]
    public string D { get; set; }

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        if (this.Flg == "1")
        {
            if (string.IsNullOrEmpty(this.A))
            {
                yield return new ValidationResult("Aは入力が必須です。", new string[] { "A" });
            }
            if (string.IsNullOrEmpty(this.B))
            {
                yield return new ValidationResult("Bは入力が必須です。", new string[] { "B" });
            }
            if (string.IsNullOrEmpty(this.C))
            {
                yield return new ValidationResult("Cは入力が必須です。", new string[] { "C" });
            }
        }
    }
}

Comments

[SurferOnWww]

> アノテーション１行では表現できないはずです

今回の質問者さんのケースでは CustomValidation 属性一行を付与すれば検証できます。詳細は私の回答を見てください。

[workaholist]

アノテーションを有効無効に切り替えるという方向で行こうとすると、どうしても条件分岐等を記述する必要がある、という意味で書きました。
IValidatableObjectインターフェースにしろCustomValidation属性にしろ、結局は切替えるロジックをどこかに書く必要がありますよね。
ちなみにCustomValidation属性はValidationResultが１つしか返せないので私はいつもIValidatableObjectインターフェースを使用しています・・・。

[workaholist]

ソースコードを追記しました。

[SurferOnWww]

マイクロソフト公式解説書「プログラミング ASP.NET MVC」に書いてあったことですが、そのまま抜粋すると・・・

"IValidatableObject インターフェイスを実装すると、クラスレベルで CustomValidation 属性を使用するのと機能的には同じになります。"

・・・中略・・・

"クラスレベルの検証を実装するにあたって、クラスレベルで IValidatableObject インターフェイスと CustomrValitdation 属性のどちらを使用するかは、完全にあなた次第です。"

・・・だそうです。

自分的に気になるのは、DB　First で既存の SQL Server データベースから Entity Data Model (EDM) を生成して ASP.NET MVC アプリで使用する場合にどうするかです。

ユーザー入力を検証するためのデータアノテーション属性を付与するのは、以下の記事の「Entity Framework でのデータ アノテーション検証コントロールの使用」のセクションに書いてあるようにすれば可能ですが、IValidatableObject を使った場合はどうするのでしょう？

[C#] #21. データ アノテーション検証コントロールでの検証
https://technet.microsoft.com/ja-jp/subscriptions/ff642519.aspx

あと、IValidatableObject インターフェイスする場合、Validate メソッドが呼び出されない可能性を排除するため、データアノテーションを完全に削除することがお勧めだそうです。

それは普通のケースではちょっと大変ですよね。なので、自分はデータアノテーション派です。

[ShouOkada]

わかりました、ありがとうございますm(__)m

Answer 2

私のコメント（サーバー側だけの検証で OK か？）に返事がないですが、それで OK と勝手に理解して回答します。

質問者さんが考えたように CustomValidationAttribute を使うのが正解だと思います。

FLG プロパティも Model 定義に含めてテキストボックスの文字列と一緒に View から POST するようにすれば、検証メソッドの引数に FLG およびテキストボックス A ～ D のユーザー入力すべてがモデルバインドされますので、そこで検証できます。

具体的には以下のような感じです。

Controller と Model

Controller と Model を一緒にしたのは単に分けるのが面倒だったから。CustomValidation 属性は各プロパティではなくクラスに設定。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using AdventureWorksLT;
using Mvc5App.Extensions;
using System.ComponentModel.DataAnnotations;

namespace Mvc5App.Controllers
{
    [CustomValidation(typeof(SampleModel), "ValidateSampleModel")]
    public class SampleModel
    {
        public bool Flg { get; set; }
        public string A { get; set; }
        public string B { get; set; }
        public string C { get; set; }
        public string D { get; set; }

        public static ValidationResult ValidateSampleModel(SampleModel model)
        {
            if (model == null)
            {
                throw new NullReferenceException();
            }

            if (model.Flg)
            {
                // 事前に Trim した方がよさそうだが省略
                if (String.IsNullOrEmpty(model.A) || String.IsNullOrEmpty(model.B) ||
                    String.IsNullOrEmpty(model.C) || String.IsNullOrEmpty(model.D))
                {
                    return new ValidationResult("Flg = 1 and one or more of TextBox(es) A, B, C & D empty");
                }
            }
            else
            {
                if (String.IsNullOrEmpty(model.D))
                {
                    return new ValidationResult("Flg = 0 and TextBox D empty");
                }
            }

            return ValidationResult.Success;
        }
    }


    public class HomeController : Controller
    {        
        public ActionResult Create()
        {
            return View();
        }

        [HttpPost]
        public ActionResult Create(SampleModel sample)
        {
            if (!ModelState.IsValid)
            {
                return View(sample);
            }

            return RedirectToAction("Index", "Home");
        }
    }
}

View

エラーメッセージは ValidationSummary を利用して表示。

@model Mvc5App.Controllers.SampleModel

@{
    ViewBag.Title = "Create";
    Layout = "~/Views/Shared/_Layout.cshtml";
}

<h2>Create</h2>

@using (Html.BeginForm())
{
    @Html.ValidationSummary(true)

    <fieldset>
        <legend>SampleModel</legend>

        <div class="editor-label">
            @Html.LabelFor(model => model.Flg)
        </div>
        <div class="editor-field">
            @Html.EditorFor(model => model.Flg)
        </div>

        <div class="editor-label">
            @Html.LabelFor(model => model.A)
        </div>
        <div class="editor-field">
            @Html.EditorFor(model => model.A)
        </div>

        <div class="editor-label">
            @Html.LabelFor(model => model.B)
        </div>
        <div class="editor-field">
            @Html.EditorFor(model => model.B)
        </div>

        <div class="editor-label">
            @Html.LabelFor(model => model.C)
        </div>
        <div class="editor-field">
            @Html.EditorFor(model => model.C)
        </div>

        <div class="editor-label">
            @Html.LabelFor(model => model.D)
        </div>
        <div class="editor-field">
            @Html.EditorFor(model => model.D)
        </div>

        <p>
            <input type="submit" value="Create" />
        </p>
    </fieldset>
}

<div>
    @Html.ActionLink("Back to List", "Index")
</div>

@section Scripts {
    @Scripts.Render("~/bundles/jqueryval", "~/bundles/inarray")
}

Comments

[ShouOkada]

只今帰宅しました。
返事が遅くなり申し訳ありません。
サーバー側だけの検証で大丈夫です。
回答ありがとうございました。上記の方法を試してみたいと思いますm(__)m