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

前回は AddEventHandler を使ってイベントハンドラを動的に追加する方法を解説しました。今回はその逆、イベントハンドラを解除する RemoveEventHandler の使い方を見ていきます。

図1　前回作成した AddEventHandler のコード。EventInfo 経由でイベントに AAA メソッドを登録し、Send() を Invoke で呼び出している

イベントが発火する仕組みのおさらい

MailService クラスの Send() メソッドの中では OnSend?.Invoke() が呼ばれており、AddEventHandler で登録したハンドラ（AAA）がここで実行される仕組みになっています。

図2　MailService.cs 側のコード。Send() の中で OnSend?.Invoke() が呼ばれ、登録済みのハンドラに通知される

RemoveEventHandler でハンドラを解除する

イベントの解除も、これまでと同じ流れです。EventInfo（ei）に対して RemoveEventHandler を呼び出し、対象のインスタンスと解除したいメソッドを渡します。書き方は AddEventHandler のときとまったく同じで、メソッド名だけが変わる形です。

ei.RemoveEventHandler(instance, AAA);

図3　AddEventHandler と同じ書き方で RemoveEventHandler(instance, AAA) を追加する

ここで指定している AAA は、AddEventHandler のときに登録したメソッドと同じものです。「OnSend に登録されている AAA を解除する」という意味になります。

図4　AddEventHandler と RemoveEventHandler、どちらも同じ AAA メソッドを指定している点に注目

もう一度 Invoke して解除を確認する

解除できているかどうかを確認するために、これまでと同じ書き方で MethodInfo の Invoke をもう一度呼び出します。1回目の Invoke と同じコードなので、新しく覚えることはありません。

ei.RemoveEventHandler(instance, AAA);
m.Invoke(instance, null);

図5　RemoveEventHandler の直後にもう一度 m.Invoke(instance, null) を呼び出すコードを追加する

1回目の Invoke（Send の呼び出し）と2回目の Invoke（解除後の呼び出し）の間にブレークポイントを置き、それぞれの実行結果を見比べていきます。

図6　2回目の Invoke 行にブレークポイントを設定し、そこで一時停止させる

実行結果で解除を確認する

1回目の Invoke（RemoveEventHandler より前）を実行すると、出力ウィンドウには Send と aaa call!!!! の両方が表示されます。Send() の中身が実行され、登録済みの AAA ハンドラにも通知されていることが分かります。

図7　1回目の Invoke 実行結果。send!!!! と aaa call!!!! の両方が出力されている

続けて RemoveEventHandler を通過し、2回目の Invoke を実行すると、出力ウィンドウには send!!!! だけが追加され、aaa call!!!! は出力されません。Send() 自体は変わらず実行されますが、ハンドラが解除されているため AAA 側には通知が届かなくなっていることが確認できます。

図8　2回目の Invoke 実行結果。send!!!! のみが追加され、aaa call!!!! は出力されない＝ハンドラが解除されたことが分かる

まとめ

EventInfo を使ったイベントの登録・解除は、次のようにまとめられます。

// 登録
ei.AddEventHandler(instance, AAA);

// 解除
ei.RemoveEventHandler(instance, AAA);

AddEventHandler と RemoveEventHandler は書き方が完全に対応しており、通常の += / -= による登録・解除を Reflection 経由で行っているイメージです。EventInfo を使えば、イベントの照会（GetEvents / GetEvent）に加えて、登録・解除まで動的に操作できることが分かりました。