C#文法 リフレクション G04_汎用的なチェックメソッド

属性を使ったチェックを汎用化する

前回のレクチャーでは、独自属性を使ったチェックを実装しました。GetCustomAttributeで属性を取得し、値をチェックするという流れです。ただし、前回のコードではチェック対象のインスタンスをその場で生成していました。

しかし、実際の開発シナリオでは、すでに存在するインスタンスをチェックする形になることがほとんどです。そこで今回は、インスタンスを渡してチェックするメソッドとして汎用化していきます。

CheckStockEntityメソッドを作成する

まず、private void CheckStockEntity(StockEntity entity) というメソッドを新たに作成します。StockEntity型のインスタンスentityを受け取り、そのメソッドの中でチェックを行うという設計です。

使う側は、何らかのStockEntityのインスタンスを自分で持っていて、StockNameなどのプロパティに値をセットした状態でこのメソッドを呼び出し、チェックしてもらうという流れになります。例外が発生した場合は、呼び出し側でcatchして処理する想定です。

CheckStockEntity(StockEntity entity)メソッドを新規に作成する

属性チェックのロジックを移植する

前回実装した属性を使ったチェックの中身をすべてコピーし、CheckStockEntityメソッドに貼り付けます。

前回実装した、属性を使ったチェックのコード

try catchはイベント側、つまり呼び出し側でかけてもらう想定のため、メソッド側では不要になります。まずはこの部分を削除します。

貼り付け直後のコード。まだAssemblyやTypeの取得部分が残っている

続いて、Entityを受け取って処理する流れに変わったため、メソッド内でインスタンスを生成していた部分は不要になります。AssemblyもTypeも、すでにEntityから分かっているため、これらの行も削除します。

すると、これまでインスタンスを参照していた箇所がコンパイルエラーになるので、渡されてきたentityに置き換えます。同様に、変数tやTypeを参照していた箇所もコンパイルエラーになるため、entity.GetType()に置き換えます。entityの型はStockEntityなので、StockEntityが持つすべてのプロパティを順番にチェックしていく処理になります。

entityとentity.GetType()に置き換えた、汎用的なチェックメソッド

呼び出し側から利用する

実際に使う側のコードでは、StockEntityのインスタンスを生成し、StockNameプロパティに値をセットしたうえで、CheckStockEntity(entity)を呼び出します。例外が発生した場合はcatch (Exception ex)でMessageBox.Show(ex.Message)によりメッセージを表示します。

呼び出し側でCheckStockEntityメソッドを利用するコード

実行結果を確認する

実際にStockNameへ11文字の文字列を設定して実行してみます。StockNameプロパティに設定されているMaxLengthAttributeの上限は5文字のため、実行するとチェックに引っかかり、「オーバーしています11 上限:5」というメッセージが表示されます。

実行結果。11文字のStockNameが上限5文字を超えていることを検出している

既存のインスタンスを渡すだけでチェックが行えることが確認できました。

まとめ

このように、何らかの作業中のインスタンスが渡されてきて、それをチェックするというイメージのメソッドにすることで、前回の属性ベースのチェックロジックを、実際の開発シナリオにより近い形で再利用できるようになります。