C#文法 リフレクション G03_属性を使ったチェック

属性(Attribute)を使ったチェックとは

前回はGetPropertiesを使って、クラスの中にあるプロパティの一覧を取得する方法を扱いました。今回はそれに加えて、プロパティに付けられた「属性(Attribute)」をもとに、特定の属性が付いたプロパティだけを取り出してチェックする方法を紹介します。

たとえばEntity Frameworkでは、キー項目に[Key]を付けたり、[MaxLength(50)]で文字数の上限を指定したり、必須項目には[Required]を付けたりします。ツール側は、こうした属性の定義を読み取ることでチェックを行っています。今回はその仕組みを、自分たちのコードで再現してみます。

図1　StockEntityクラスに設定できる属性（[Key]・[MaxLength(50)]など）

StockEntityクラスに属性を設定する

属性はプロパティの前に角括弧[ ]を付けて指定します。以前メソッドの回で扱ったように、Attributeを継承したクラスを作れば独自の属性を定義できますが、今回はマイクロソフトが標準で提供している属性を使います。System.ComponentModel.DataAnnotations名前空間には、MaxLengthをはじめとする便利な属性が用意されています。

図2　System.ComponentModel名前空間の候補からMaxLengthを選択する

名前空間が長いのでusingに移動しておき、MaxLengthの括弧の中に最大文字数を指定します。今回は説明用に短めの5文字に設定しました。

public int StockId { get; set; } = 999;

public string StockName { get; set; }

図3　StockNameプロパティに[MaxLength(5)]を設定したコード

この状態で前回作成した「GetPropertiesで全プロパティを取得する」コードをそのまま流用して実行すると、以前と同じくStockIdとStockNameの2つのプロパティが取得できます。ここからさらに、属性ごとのチェックを追加していきます。

GetCustomAttributeで属性を取得する

GetPropertiesでループしているvalという1つ1つのプロパティに対して、GetCustomAttribute<T>()を呼び出します。山括弧の中に調べたい属性の型を指定すると、そのプロパティにその属性が付いていればインスタンスが返り、付いていなければnullが返ってきます。

なお、属性クラスの正式名はMaxLengthAttributeのように語尾に「Attribute」が付きますが、山括弧の中では語尾のAttributeを省略して書くことができます。エディタ上でも省略できる部分は文字が薄く表示され、直感的に書けるようになっています。

図4　val.GetCustomAttribute<MaxLengthAttribute>()で属性を取得するコード

var maxLength = val.GetCustomAttribute<MaxLengthAttribute>();

if (maxLength != null)

{

// MaxLengthが設定されているプロパティのみここに入る

}

プロパティの値と属性の定義を比較する

MaxLengthAttributeが取得できたら、次はチェック対象のインスタンスから実際の値を取り出します。インスタンスはActivator.CreateInstanceで生成し、val.GetValue(instance)に渡すことで、そのプロパティの値をobject型で取得できます。値がnullでなければ、文字列に変換した上で長さを比較します。

図5　val.GetValue(instance)でプロパティの値を取得するコード

取得した値の文字数（o.ToString().Length）と、属性側の定義（maxLength.Length）を比較し、値のほうが大きければ上限オーバーということになります。今回は説明のために、通常のExceptionを使って上限オーバーのメッセージを投げるようにしました。

図6　文字数を比較し、上限を超えていればExceptionを投げるコード

if (o.ToString().Length > maxLength.Length)

{

throw new Exception($”オーバーしています {o.ToString().Length} 上限:{maxLength.Length}”);

}

実行結果とtry-catchでの例外処理

StockNameに6文字の値を設定して実行すると、5文字の上限を超えるため例外が発生します。try-catchで囲っていない状態で実行すると、下図のように未処理の例外としてダイアログが表示され、「オーバーしています 6 上限:5」というメッセージが確認できます。

図7　StockNameが6文字のとき、上限5文字を超えて例外が発生した画面

実際の利用場面ではこのまま落とすのではなく、try-catchで例外を捕まえて処理するのが一般的です。catchブロックでMessageBox.Showに例外情報を渡してあげれば、画面上にメッセージとして表示できます。

図8　catch(Exception ex)でMessageBox.Show(ex.ToString())を呼び出すコード

try

{

// 属性チェックの処理

}

catch (Exception ex)

{

MessageBox.Show(ex.ToString());

}

まとめ

1つのプロパティに対してGetCustomAttribute<T>()を呼び出せば、そのプロパティに指定した属性が付いているかどうか、また付いている場合はその定義内容を取得できます。取得した定義とGetValueで取れたインスタンスの実際の値を比較すれば、必須チェックや範囲チェックなど、さまざまな検証ロジックを組み立てることができます。

Entity Frameworkなどのツールが「この属性を付けてください」と説明するとき、裏側ではまさに今回のように、属性の定義を読み取ってチェックを行っています。プロパティの属性を活用したチェックの仕組みを、ぜひ自分のコードでも試してみてください。