ASP.NET MVC 3における検証まわりの改善点

ASP.NET MVC3入門（3）

MVC 3におけるプロパティ間検証について

　MVC 2ではモデル全体の状態やモデルのプロパティを利用した検証は実現できませんでしたが、MVC 3ではモデル（コードファーストのクラスやメタデータクラスなど）に対してIValidatableObjectインターフェースを実装することで、複数のプロパティの値を利用した検証も簡単に実現できるようになりました。

図3 MVC 2から3への検証機能の強化

　IValidatableObjectインターフェースはIvalidatableObject.Validateメソッドだけを定義しています。このValidateメソッド内で複数のプロパティ値を参照できます。

　今回はユーザーにパートナーが居るかどうかのチェック項目と、パートナー名を入力する項目を基に、どちらか片方のみの入力にはをエラーを返すサンプルを作成します。

　実行結果は図4～5のとおりです。

図4 複数のプロパティ値を利用した検証例（チェックボックスチェック時）

図5 複数のプロパティ値を利用した検証例（チェックボックス未チェック時）

　処理は以下のとおりです。

IValidatableObjectの実装とValidateメソッドの実装（User.cs）

public class User:IValidatableObject
{
<中略...>

    public bool CheckPartner { get; set; }
    public string PartnerName { get; set; }


    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        // チェックボックスにチェックがあり、パートナーの名前が未入力の場合
        if (CheckPartner && string.IsNullOrEmpty(PartnerName))
        {
            yield return new ValidationResult("パートナーが居る場合は名前を入力してください。", new[] { "PartnerName" });
        }
        // チェックボックスにチェックがないが、パートナーの名前が入力されている場合
        else if (!CheckPartner && (string.IsNullOrEmpty(PartnerName) == false)) 
        {
            yield return new ValidationResult("パートナーの名前を入力する場合はパートナーの有無にチェックを付けてください。", new[] { "CheckPartner" });
        }
    }
}

　冒頭で解説した通り、コードファーストクラスでIValidatableObjectインターフェースを実装して、IValidatableObject.Validateメソッドを実装しています。ValidateメソッドはEntity FrameworkのSaveChangesメソッドを呼び出した際にValidateメソッドをインターセプトし、検証を実施する仕組みですので、必ず検証が実施されます。

　内部的にはCheckPartnerとPartnerNameプロパティの入力状況をチェックしています。判定後、IEnumerable<ValidationResult>オブジェクトの値として返すためにyield returnステートメントを使います（yield returnステートメントは列挙子オブジェクトを返すため）。ValidationResultオブジェクトは第一パラメータにエラーメッセージを、第二パラメータにエラーメッセージを表示させるプロパティ名を指定します。

　実行結果は図4～5のとおりです。ご覧の通り、MVC 2よりも細かな検証が実現できることが確認できます。