WPF Prism episode: 9 ~ ReactiveProperty の Validation は DataAnnotation じゃないと思った? ~

← 前回記事 【WPF Prism episode: 8 ~ ReactiveProperty がバインドできないのはどう考えても Navigation が悪い! ~】

前回は Prism の RequestNavigate に設定したパラメータを遷移先画面で受け取り、パラメータから取り出したデータを ReactiveProperty で View とバインドする方法を紹介しました。
その際、VM ⇔ View 間だけでなく Model ⇔ VM 間も双方向でバインドすることで、View で入力した値が Model までシームレスに伝播する方法も併せて紹介しましたが、episode: 8 のままでは反映されたくない値まで Model へ伝播されてしまいます。

そのため今回は不正な値を Model に反映されるのを防ぐ方法と、View の入力エラーをチェックするための Validation を ReactiveProperty へ設定する方法を紹介します。
今回は WPF 標準の Validation を ReactiveProperty に設定する方法の紹介がメインですが、ReactiveProperty を使用せず Prism の BindableBase 等で実装する場合でもほとんど同じですし、何かの参考にはなるとは思うので読んでもらえると嬉しいです。

このエントリは以前 episode: 9、9′ に分けて公開していましたが、リニューアルして 1 エントリに統合しました。
リニューアル前に episode: 9 で紹介していた Extended WPF Toolkit™ については 新規エントリとして『WPF Prism extra: 4 ~ Extended WPF Toolkit™ で数値と日付を入力 ~』のタイトルで extra シリーズに分割したのでお手数ですが extra: 4 へ移動してください。

尚、この記事は Visual Studio 2017 Community Edition で .NET Framework 4.7.2 以上 と C# + Prism 7.1 + ReactiveProperty を使用して 、WPF アプリケーションを MVVM パターンで作成するのが目的で、C# での基本的なコーディング知識を持っている人が対象です。

WPF の Validation

今までのエントリではあえて触れていませんでしたが、アプリには必須と言える Validation について紹介します。
WPF の Validation は歴史的な経緯から何通りかの方法があって『WPFでの入力値検証・まとめ – SourceChord』が、日本語で書かれた情報としては最もまとまっていると思うので、一通り目を通しておくと WPF の Validation についての概要が把握できると思います。

何通りかある Validation の内、このエントリで紹介するのは DataAnnotations だけなので『WPFでの入力値検証・まとめ – SourceChord』 の中でも特に『WPFでの入力値検証・その3 ~DataAnnotationsを使う~ – SourceChord』だけでも読んでおくとここで紹介する内容も理解し易いと思います。

DataAnnotations を使用した Validation

DataAnnotations は元々 ASP.NET のために用意された機能のようですが、WPF でも ASP.NET と同じように使用できます。
System.ComponentModel.DataAnnotations 名前空間】配下には DataAnnotations に使用するためのクラスが多数用意されていますが、以下の 2 つのクラスでほとんどカバーできると管理人個人的には考えています。

  • RegularExpression 属性
  • Required 属性

中でも特に有用なのが【RegularExpression 属性】で、項目の単体チェックであればこの属性だけでほぼ全てカバーできると言えます。
正規表現が苦手な人や面倒な人には英語サイトですが Regular Expression Library のようなサイトもあるので、似たパターンを探して少し改変すれば整数・小数桁数チェックまで含めた数値チェック等は簡単に設定できると思います。

src. 1 はサンプルアプリの身体測定データ編集 View に DataAnnotations を適用した例です。
測定日は日付型なので後回しにして、まずは数値項目のみに Validation を追加しています。

DataAnnotations とは src. 1 のように Validation を設定したいプロパティへ追加する属性を指し、適用するにはまず【System.ComponentModel.DataAnnotations】を using します。
名前空間を追加する時に IntelliSense へ候補が表示されない場合はプロジェクトへアセンブリ参照の追加も必要です
管理人の場合、参照を自分では追加していませんが using 記述時に候補へ表示されたので ReactiveProperty 等が裏で参照しているからだと思います。

src. 1 では Validation を設定したい Height・Weight プロパティに RegularExpression 属性を追加して整数部 3 桁・小数部 2 桁の正の数値のみが有効になる正規表現パターンを指定しています。
この正規表現も先ほど紹介した Regular Expression Library で見つけたものを流用しています。

RegularExpression 属性の追加と併せて ReactiveProperty の初期化時に【SetValidateAttribute メソッド】も追加することで Validation が有効になります。(50、54 行目)
※ SetValidateAttribute のパラメータのラムダ式へ対象のプロパティを渡します

併せて ToReactivePropertyAsSynchronized メソッドの省略可能第 3 パラメータ【ignoreValidationErrorValue】に true を設定すると Validation でエラーになった場合は値が Model へ反映されなくなります

又、以前紹介した ReactivePropertySlim は Validation の機能が省かれているため Validation を設定するプロパティには使用できません
そのため、Validation を設定するプロパティは Slim 無しの無印 ReactiveProperty で宣言する必要があります。

続いて src. 2 は src. 1 の VM とバインドする XAML 側です。

Validation の設定に XAML 側の変更が必須ではありませんが、バインディングのパラメータに『UpdateSourceTrigger=PropertyChanged』を追加して、1 文字単位で Validation を実行するように変更しています。
このパラメータを設定しない場合は【LostFocus】のタイミングで Validation が実行されるので必須の設定ではありませんが、1 文字毎リアルタイムで Validation を実行したい場合に設定します。

ここまでで実行すると下の fig.1 のように不正データを入力するとエラーを示す赤枠で囲まれるようになります。

fig.1 Validation の実行例

src. 1 では DataAnnotation に設定するエラーメッセージを直接 VM のソースコードに埋め込んでいますが、実際のアプリではリテラルな文字列をソースコードへ直接埋め込むより、多言語対応のプロジェクトとして作成してエラーメッセージ部分をリソースに切り出す方が何かと取り回しやすいと思います。

このエントリでは多言語への対応方法等の紹介はしないので、必要な場合は『WPFでの入力値検証・その9 ~エラー表示のローカライズ~ – SourceChord』を参考にしてください。

数値型プロパティを TextBox へバインド

Height プロパティのような数値型で定義されたプロパティをバインドした TextBox へ数値以外の文字を入力すると、TextBox 等の WPF コントロール内部で自動的に Parse してエラーにするようで、VM まで値が渡ってきませんしイミディエイトウィンドウにスタックトレースは出力されますが、例外は Throw されません

fig.2 Validation 実行時のスタックトレース出力

そのため、上で紹介した ReactiveProperty の初期化時の ToReactivePropertyAsSynchronized へ【ignoreValidationErrorValue: true】を指定する・しないに関わらず Model へ数値以外がセットされる事は無いようですが、Model と双方向で接続していて Validation を設定するプロパティには【ignoreValidationErrorValue: true】を常に指定するべきだと思います。

又、double や decimal 等のような小数部のある数値を TextBox とバインドしている場合、小数点の入力に問題がありますが、次回の記事で紹介します。

日付型プロパティを DatePicker へバインド

続いて測定日(日付型)の Validation ですが、測定日に使用している DatePicker コントロールは、TextBox と多少動作が違います。

まず、DatePicker に UpdateSourceTrigger = PropertyChanged を設定しても動作は UpdateSourceTrigger = LostFocus と変わらないので UpdateSourceTrigger を設定する意味はありません。

又、DatePicker へ RegularExpression 属性を設定した場合の動作も TextBox とは違います。
試しに src. 3 のように RegularExpression 属性を設定します。

src. 3 のように Validation を設定しても fig. 3 のような動作になります。

fig.3 DatePicker へ不正な文字を入力

RegularExpression 属性で入力形式を制限しているにもかかわらずエラーを示す赤枠も表示されませんし、直前に設定した値に戻っています。
DatePicker は LostFocus 前に不正な入力を切り捨てて、直前に設定した値に戻るようなので RegularExpression 属性で入力文字種チェックを設定する意味は無いようです。

又、RegularExpression 属性だけでなく Required 属性も無視されるため DatePicker に DataAnnotations は設定できないと言えます。

そして、この連載で紹介しているサンプルアプリで『身体測定データ.測定日』と『試験結果データ.試験日』の 2 項目は『それぞれのリスト内で一意』となる表示上のキー項目と言う仕様なので、リスト内の他メンバの値を参照する必要があります。
今まで紹介した Validation は単項目の Validation でしたが、以降では複数のプロパティが絡む Validationを設定する方法を紹介します。

複数のプロパティが絡む Validation

結論から言うと、ReactiveProperty に複数のプロパティが絡む Validation を 設定したい場合に DataAnnotations は使用できません
WPFでの入力値検証・その7 ~独自の検証ロジックを作成する~ – SourceChord』や『WPFでの入力値検証・その8 ~複数のプロパティが絡むバリデーションを作成する~ – SourceChord』に書かれている方法で ReactiveProperty へ複数のプロパティが絡む Validation を設定しようとしても想定通りの動作をしません。
※ Prism の BindableBase 等で定義したプロパティであれば動作するはずです(管理人は未確認)

上記 SourceChord のエントリに書かれている【ValidationAttribute 派生クラス】、【CustomValidation 属性】の両方で想定通りの動作をしないのは Validation メソッド内で VM が参照できないことが原因です。

ReactiveProperty に CustomValidation 属性を設定した場合

CustomValidation 属性を使用する場合のコンストラクタは以下のように指定します。

CustomValidation(typeof(VM クラス名), 【Validationメソッド名】)

CustomValidation コンストラクタの第 1 パラメータは Validation メソッドを定義したクラスの type 、第 2 パラメータには Validation メソッド名を指定します。

又、第 2 パラメータに指定する CustomValidation メソッドは以下のシグネチャで作成します。

public static ValidationResult【Method Name】(【Propertytype】 value, ValidationContext context)

CustomValidation メソッド内にブレークポイントを設定して実行すると、第 2 パラメータ: ValidationContext.ObjectInstance には null が渡ってくることが確認できます。
又、CustomValidation に指定するメソッドは static で定義する必要があるため、どんなデータでも渡せるとは限りません。
以上の状況から CustomValidation は複数項目が関係する Validation に使用するのは難しいと考えられます。

ReactiveProperty に ValidationAttribute から派生したクラスを設定した場合

ValidationAttribute 派生クラスを設定する場合も同様で、override する IsValid メソッドの第 2 パラメータ: ValidationContext.ObjectInstance は ReactiveProperty に設定している型(ここでは Nullable<DateTime>)が渡ってくるため CustomValidation の場合と同じく VM が取得できません。

Prism の BindableBase 等で定義すれば、ValidationContext.ObjectInstance プロパティから VM が取得できる(管理人は未確認)ようですが、ReactiveProperty で定義した場合、ValidationAttribute 派生クラスと CustomValidation 属性のどちらを使用しても VM のインスタンスを取得出来ないため複数プロパティが絡む Validation には使用出来ないと言えます。

項目単体の Validation であれば RegularExpression 属性で大半をカバーできるため、ReactiveProperty で定義したプロパティに ValidationAttribute 派生クラスや CustomValidation 属性を使用する意味は無いと言えます。

DataAnnotation を使用した Validation を設定する場合、通常は VM へ INotifyDataErrorInfo インタフェースを実装する必要がありますが、ReactiveProperty の場合は ReactiveProperty自身が INotifyDataErrorInfo インタフェースを実装している為、このような動作になっていると考えられます。
そのため、ReactiveProperty へ複数プロパティが絡む Validation を設定するには ReactiveProperty に含まれる SetValidateNotifyError メソッドを呼び出す必要があります。

ReactiveProperty.SetValidateNotifyError で複数項目の Validation を実行する

ReactiveProperty へ複数プロパティが絡む Validation を設定するには ReactiveProperty に含まれる【SetValidateNotifyError】拡張メソッドを使用しますが、 ReactiveProperty は DataAnnotations と SetValidateNotifyError 拡張メソッドを同時に設定できないため、複数プロパティが絡む Validation も項目単位の Validation も SetValidateNotifyError に指定したメソッド内で処理します。

SetValidateNotifyError 拡張メソッドを src. 4 のように呼び出します。

この Validation には身体測定データリスト自体が必要なので、あらかじめデータオブジェクトのインスタンスを Unity からコンストラクタへインジェクションしてもらっています。(68行目)

そして、測定日 ReactiveProperty の初期化時に SetValidateNotifyError() メソッドを呼び出して Validation を実行するデリゲート先を設定しています。
src. 4 ではデリゲート先を指定していますが、ラムダ式で直接記述することもできます。

SetValidateNotifyError メソッドでは戻り値に null 又は string.Empty を返すとエラー無しと判定されるので、正常値の場合は null を返すよう記述します。

又、Validation 内で呼び出している HasPhysicalKey は src. 5 のようにデータオブジェクトへ追加した重複チェックメソッドです。

実行して身体測定結果編集 View を表示します。

fig.4 初回表示

身体測定結果編集 View を表示しただけでエラーを表す赤枠が表示されています。
Validation メソッドの中で『null はエラー』としているので当然ですが、初回起動時でいきなりエラーが表示されているのは UX 的に問題です。

このような初期値エラーを無視するには ReactiveProperty の初期化時に指定している ToReactivePropertyAsSynchronized 拡張メソッドの省略可能第 2 パラメータ:mode へ src. 6 のように初回 Validation エラーを無視する指定を追加します。

src. 6 のように第 2 パラメータの mode をセットすると、初期値エラーの赤枠は表示されなくなります
尚、身長・体重の両プロパティは初期値としてエラーにならない値をセットしているので、測定日プロパティのように第 2 パラメータをセットしなくても初回表示時にエラーは表示されません。

これで、身体測定データ編集 View の全項目へ Validation を設定しましたが、DataAnnotations で指定しているエラーメッセージが表示されていません。
これは WPF 標準のエラーテンプレートがエラーメッセージを表示するようになっていないからなので、エラーメッセージが表示されるように XAML を編集する必要がありますが、今回はここまでにします。

又、前回のエントリで Prism の IConfirmNavigationRequest インタフェースを紹介すると宣言したのに、結局次回以降へ持ち越すことになってしまいました。
そして次回は、Validation の ErrorTemplate を紹介する予定です。

尚、いつもの通り今回のソースコードも GitHub リポジトリ にアップしています。

 

【WPF Prism episode: 10 ~ ErrorTemplate は Resources タグ、時々、ResourceDictionary ファイルのなか。~】次回記事 →

 

 

あわせて読みたい

コメントを残す

メールアドレスが公開されることはありません。

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください

%d人のブロガーが「いいね」をつけました。