C#文法 リフレクション H01_FieldInfo

今回はFieldInfoについて解説していきます。FieldInfoは、以前解説したPropertyInfoと同じように、Reflectionを使ってフィールドにアクセスするための仕組みです。

基本的にはpublicなフィールドにアクセスすることになりますが、コーディングルールとしてpublicなメンバーはプロパティやメソッドとして公開するのが一般的です。カプセル化を考えると、publicなフィールドをそのまま持つクラスというのはほとんど存在しません。ただし、constやstatic readonlyといった変更されない値については、フィールドとして公開することもあります。そういったケースを想定しつつ、FieldInfoの使い方を確認していきます。

図8-1　constやstatic readonlyのようなケースではフィールドを使うこともある

8.2 デモ用のフィールドを用意する

まずはアクセス対象となるフィールドを用意します。MailServiceクラスに、public string MailTextというフィールドを追加します。通常であればプロパティにするところですが、今回はFieldInfoの使い方を解説する目的で、あえてpublicなフィールドとして定義します。

図8-2　MailServiceクラスにpublic string MailTextフィールドを追加する

8.3 Assembly・Type・インスタンスを取得する

フィールドにアクセスする手順は、これまでのConstructorInfoやMethodInfo、PropertyInfoのときと同様です。まずAssemblyとTypeを取得し、そこからインスタンスを生成します。前回までに使ってきた3行をそのまま持ってきて、クラス名の部分だけMailServiceに変更します。

var a = Assembly.Load("Anderson.Domain");
var t = a.GetType("Anderson.Domain.MailService");
var instance = Activator.CreateInstance(t);

8.4 GetFieldとGetFields

Typeクラスには、フィールド情報を取得するためのメソッドとしてGetFieldとGetFieldsが用意されています。GetFields（複数形）を使うと、そのクラスが持つフィールドの一覧をFieldInfo配列として取得できます。一方、GetField（単数形）を使うと、文字列で指定した名前に一致するフィールドのFieldInfoを1つだけ取得できます。

図8-3　GetField（単数）とGetFields（複数）の候補が表示される

今回はMailTextという名前を指定して、対応するFieldInfoを1つ取得します。戻り値の型はFieldInfoで、該当するフィールドが見つからない場合はnullが返ってきます。実際にコードを書くときは、このNULLチェックを忘れずに行うようにしてください。

図8-4　t.GetField(“MailText”)で名前を指定してFieldInfoを取得する

var a = Assembly.Load("Anderson.Domain");
var t = a.GetType("Anderson.Domain.MailService");
var instance = Activator.CreateInstance(t);

FieldInfo f = t.GetField("MailText");

図8-5　Assembly・Type・インスタンス取得の3行とGetFieldの呼び出し

8.5 値を取得する（GetValue）

FieldInfoを取得できたら、値の取得・設定を行います。これはPropertyInfoのときと同じで、値を取得するときはGetValue、値を設定するときはSetValueを使います。まずはGetValueにインスタンスを渡して、現在の値を取得してみます。あらかじめMailTextの初期値を”BBB”にしておきます。

図8-6　f.GetValue(instance)でフィールドの値を取得する

var a = Assembly.Load("Anderson.Domain");
var t = a.GetType("Anderson.Domain.MailService");
var instance = Activator.CreateInstance(t);

FieldInfo f = t.GetField("MailText");
var value = f.GetValue(instance);

図8-7　GetValueまでを実装したコード全体

これを実行してブレークポイントで確認すると、valueに”BBB”が取得できていることが分かります。

図8-8　valueに初期値”BBB”が取得されている

8.6 値を設定する（SetValue）

次に、値を設定してみます。設定するときはSetValueを使い、1つ目の引数にインスタンス、2つ目の引数に設定したい値を渡します。ここではMailTextの値を”CCC”に変更してみます。

図8-9　f.SetValue(instance, “CCC”)で値を設定する

設定した値がきちんと反映されているかを確認するために、もう一度GetValueを呼び出してvalue2に取得します。

var a = Assembly.Load("Anderson.Domain");
var t = a.GetType("Anderson.Domain.MailService");
var instance = Activator.CreateInstance(t);

FieldInfo f = t.GetField("MailText");
var value = f.GetValue(instance);
f.SetValue(instance, "CCC");
var value2 = f.GetValue(instance);

実行すると、1つ目のvalueは”BBB”のまま、SetValueで”CCC”に変更した後のvalue2は”CCC”になっていることが確認できます。

図8-10　SetValue実行後、value2が”CCC”に変わっていることを確認する

8.7 まとめ

FieldInfoを使うと、PropertyInfoと同じ感覚でフィールドに対してもリフレクション経由でアクセスできます。GetFieldsで一覧を取得する、GetFieldで名前を指定して1つだけ取得する、GetValue/SetValueで値の取得・設定を行うという流れは、これまで見てきたPropertyInfoの使い方とほぼ同じです。実際にpublicなフィールドを使う場面は多くありませんが、constやstatic readonlyなフィールドにアクセスしたい場合などに、この仕組みを活用してみてください。