ASP.NET MVC 2による検証機能

ASP.NET MVC 2入門（中編）

CustomValidation属性の活用

　ここまでは属性指定するだけで実現可能な検証属性を紹介しました。属性の中には、自分で検証メソッドを作成し、それを属性として使用するCustomValidation属性があります。

　さっそくCustomValidation属性の指定例について記載します。

publishers_validation.csファイルの記載例

[CustomValidation(typeof(カスタム検証メソッドを持つクラス), "カスタム検証メソッド名")]

　おすすめのカスタム検証メソッドを記載する場所は、DataAnnotationを記載するPartialクラスの下部です（属性とセットでチェックできるため）。

　今回は汎用的とは言えませんが、先ほどのPartialクラスのcountryプロパティにJPN以外の入力を受けつけないJPNAndUSAOnlyメソッドを作成して、CustomValidation属性に指定します。記載は次のとおりです。

publishers_validation.csファイルの記載例

// countryプロパティ
[DisplayName("国")]
[CustomValidation(typeof(publishers_validation), "JPNAndUSAOnly")]
public string country { get; set; }

// カスタム検証メソッド
public  static ValidationResult JPNAndUSAOnly(string country)
{
  // 入力値がJPNかUSAか判定
  if (country == "JPN"||country == "USA")
  {
    // どちらかの場合検証成功を返す
    return ValidationResult.Success;
  }
  else
  {
    // 異なる場合エラーメッセージを返す
    return new ValidationResult("JPNか、USAで入力してください。");
  }
}

　属性指定部分は前述のとおりです。カスタム検証メソッドのポイントはstaticファンクションメソッドで記載する点です。戻り値は検証結果を格納するValidationResultオブジェクトです。

　パラメタは、リクエスト時に渡されて実際に検証したい値となります。countryプロパティはstring型のため、stringの値をパラメタとして指定しています。

　カスタム検証メソッド内は特筆すべき点はありません。JPN／USAのチェックを行い、どちらかの場合は、成功結果を返すためにValidationResult.Successを記述し、異なる場合は、エラーメッセージを返します。

　以上がCustomValidation属性を使用したカスタム検証メソッドの作成方法です。

　なお、CustomValidation属性は独自の検証メソッドを使用するため、MicrosoftMvcValidation.jsファイル内にクライアントサイドのスクリプトを生成するスクリプトが記述されていません。サーバーサイドにリクエストが届いた時の検証になる点に留意ください。

カスタムの検証属性の作成と検証

　CustomValidation属性を活用すれば大抵の検証は実装できると思います。しかし、さまざまな場所で同様の検証を行いたい場合はカスタムの検証属性そのものを作成することも効果的です。DataAnnotationが提供する検証属性クラスはValidationAttributeクラスをベースとして作られています。このValidationAttributeクラスを継承し、必要な記載を追加することで、簡単にカスタム検証属性が作成できます（図4）。

図4 検証ページの検証例

　また、DataAnnotationが記載されているクラスも、属性のみの宣言の場合はすっきりと見やすくなるというメリットもあります。

カスタム属性の作成

　今回は、CustomValidation属性で使用したJPNAndUSAOnlyメソッドを属性クラス化させてみます。記載は次のとおりです。

JPNAndUSAOnlyAttribute.csファイルの記載例

using System;
using System.ComponentModel.DataAnnotations;
  public sealed class JPNAndUSAOnlyAttribute : ValidationAttribute
  {
    public override bool IsValid(object value)
    {
      // 入力値をstring型にキャスト
      string _value = (string)value;
          
      // 入力値のnull判定
      if(_value == null){
        return true; // 検証成功
      }
      else if (_value == "JPN" || _value == "USA") // 入力値がJPNかUSAか判定
      {
        return true; // 検証失敗
      }
      else
      {
        return false; // 検証失敗
      }
    }
  }

　データの検証を行うIsValidメソッドをオーバーライドし、内部に検証ロジックを記載します。入力必須の設定はないため、入力値のnull判定を最初に記述します。続いて、入力値がJPNかUSAかを判定し検証の成否を判定します。これで属性は完成です。

　実際に宣言してみましょう。publishers_validation.csファイルのcountryプロパティに属性を宣言します。記載は次のとおりです。

publishers_validation.csファイルの記載例

[DisplayName("国")]
[JPNAndUSAOnly(ErrorMessage = "JPNか、USAで入力してください。")]   
public string country { get; set; }

　実行すると、CustomValidation属性同様の結果を取得できます。しかし、このままではサーバーサイドの検証のみの実装です。クライアントサイドの検証はもう少し手を加える必要があります。