👨🏾‍🏫 🧚🏼 🚃 .NETイベントの詳細 😻 🥡 ❕

.NETプログラマーの場合は、コードでイベントを宣言して使用する必要があります。それにもかかわらず、イベントが内部でどのように機能し、どの機能がアプリケーションに関連付けられているかを誰もが知っているわけではありません。この記事では、イベントの操作を可能な限り詳細に説明しようとしました。これには、ほとんど対処する必要のない特殊なケースも含まれますが、それについて知ることは重要であり、興味深いことです。

イベントとは何ですか？

C＃のイベントは、2つの可能性を提供するエンティティです：クラスに対して、変更を報告するため、およびユーザーに対して、それらに応答するために。

イベント発表の例：

public event EventHandler Changed;

広告の構成を検討してください。イベント修飾子が最初に来て、次にイベントキーワードが続き、イベントタイプが続きます。イベントタイプはデリゲートタイプである必要があり、イベント識別子、つまりその名前です。イベントキーワードは、これがパブリックフィールドではなく、イベントメカニズムの実装のプログラマの詳細を隠す特別に設計された構造であることをコンパイラに伝えます。このメカニズムがどのように機能するかを理解するには、代表者の仕事の原則を研究する必要があります。

イベントワークベンチ-デリゲート

.NETのデリゲートは、C ++の関数参照の一種であると言えます。ただし、この定義は不正確です。なぜなら、各デリゲートは1つではなく、デリゲートの呼び出しリストに格納されている任意の数のメソッドを参照できます。デリゲート型は、参照できるメソッドのシグネチャを記述します;この型のインスタンスには、独自のメソッド、プロパティ、および演算子があります。 Invoke（）メソッドを呼び出すと、各リストメソッドへの順次呼び出しが実行されます。デリゲートは関数として呼び出すことができ、コンパイラはそのような呼び出しをInvoke（）呼び出しに変換します。

C＃には、デリゲート用に、.NET環境には存在しない+および-演算子があり、それぞれ言語の構文糖質であり、それぞれDelegate.CombineおよびDelegate.Removeメソッドの呼び出しに拡張されます。これらのメソッドを使用すると、呼び出しリストでメソッドを追加および削除できます。もちろん、代入（+ =および-=）を持つ演算子の形式は、他の型の.NET環境で定義された演算子だけでなく、デリゲート演算子にも適用できます。デリゲートから減算するときに、彼の呼び出しリストが空の場合、nullが割り当てられます。

簡単な例を考えてみましょう。

 Action a = () => Console.Write("A"); //Action   public delegate void Action(); Action b = a; Action c = a + b; Action d = a - b; a(); // A b(); // A c(); // AA d(); //  NullReferenceException, .. d == null

イベント-デフォルトの実装

C＃のイベントは、次の2つの方法で定義できます。

イベントの暗黙的な実装（フィールドのようなイベント）。
明示的なイベント実装。

この場合の「明示的な」および「暗黙的な」という言葉は、仕様で定義されている用語ではなく、意味内の実装方法を単に説明していることを明確にします。

最も一般的に使用されるイベント実装-暗黙的を検討してください。 C＃4に次のソースコードがあると仮定します（これは重要です。以前のバージョンでは、少し異なるコードが生成されますが、これについては後で説明します）。

 class Class { public event EventHandler Changed; }

これらの行は、コンパイラによって次のようなコードに変換されます。

 class Class { EventHandler hanged; public event EventHandler Changed { add { EventHandler eventHandler = this.changed; EventHandler comparand; do { comparand = eventHandler; eventHandler = Interlocked.CompareExchange<EventHandler>(ref this.changed, comparand + value, comparand); } while(eventHandler != comparand); } remove { EventHandler eventHandler = this.changed; EventHandler comparand; do { comparand = eventHandler; eventHandler = Interlocked.CompareExchange<EventHandler>(ref this.changed, comparand - value, comparand); } while (eventHandler != comparand); } } }

イベントのサブスクライブ時にaddブロックが呼び出され、サブスクライブ解除時にremoveブロックが呼び出されます。これらのブロックは、一意の名前を持つ個別のメソッドにコンパイルされます。これらのメソッドは両方とも、1つのパラメーター（イベントのタイプに対応するタイプのデリゲート）を受け取り、戻り値を持ちません。パラメータ名は常に「値」です。この名前でローカル変数を宣言しようとすると、コンパイルエラーが発生します。イベントキーワードの左側に示されているスコープは、これらのメソッドのスコープを定義します。デリゲートは、常にプライベートなイベントの名前で作成されます。そのため、クラス継承から暗黙的な方法で実装されたイベントを呼び出すことはできません。

Interlocked.CompareExchangeは、最初の引数を3番目の引数と比較し、等しい場合は、最初の引数を2番目の引数に置き換えます。このアクションはスレッドセーフです。ループは、デリゲートをイベントの被比較変数に割り当てた後、比較を実行する前に、別のスレッドがこのデリゲートを変更する場合に使用されます。この場合、Interlocked.CompareExchangeは置き換えられず、ループ境界条件は満たされず、次の試行が行われます。

追加と削除のある広告

イベントが明示的に実装されると、プログラマーはイベントのデリゲートフィールドを宣言し、add / removeブロックを使用してサブスクライバーを手動で追加または削除します。両方とも存在する必要があります。このような広告は、多くの場合、独自のイベントメカニズムを作成するために使用され、C＃の利便性を維持しながらそれらを操作します。

たとえば、一般的な実装の1つは、イベントデリゲートのディクショナリを個別に格納することです。ディクショナリには、イベントサブスクリプションが作成されたデリゲートのみが含まれます。ディクショナリは、キーを使用してアクセスされます。キーは通常、オブジェクト型の静的フィールドであり、参照の比較にのみ使用されます。これは、クラスのインスタンスが占有するメモリの量を減らすために行われます（多数の非静的イベントが含まれる場合）。この実装は、WinFormsで使用されます。

イベントはどのようにサブスクライブされ、呼び出されますか？

すべてのサブスクリプションおよびサブスクライブ解除アクション（+ =および-=で示され、デリゲート演算子と混同されやすい）は、addおよびremoveメソッドの呼び出しにコンパイルされます。上記以外のクラス内の呼び出しは、デリゲートを使用して単純な作業にコンパイルされます。暗黙の（そして正しい明示的な）イベント実装では、クラスの外部からデリゲートにアクセスすることは不可能であり、署名としてイベントを取り消すことでのみイベントを操作できることに注意してください。（リフレクションを使用しない場合）イベントにサブスクライブしているかどうかを判断する方法がないため、それからサブスクライブ解除してもエラーが発生しないことは論理的に思えます-イベントデリゲートが空であっても、安全にサブスクライブ解除できます。

イベント修飾子

スコープ修飾子（パブリック、保護、プライベート、内部）はイベントに使用でき、オーバーラップ（仮想、オーバーライド、シール）することも、実装しない（抽象、外部）こともできます。イベントは、基本クラスからの同じ名前のイベントと重複することも（新規）、またはクラスのメンバーになることもできます（静的）。イベントがオーバーライド修飾子と抽象修飾子の両方で同時に宣言された場合、クラスの相続人はそれをオーバーライドする必要があります（これらの2つの修飾子を持つメソッドまたはプロパティも同様）。

どんな種類のイベントがありますか？

既に述べたように、イベントのタイプは常にデリゲートのタイプでなければなりません。イベントの標準タイプは、EventHandlerおよびEventHandler <TEventArgs>タイプで、TEventArgsはEventArgsの子孫です。 EventHandler型は、イベント引数が提供されていない場合に使用され、EventHandler <TEventArgs>型は、イベント引数がある場合に使用され、それらに対して個別のクラス（EventArgsからの継承）が作成されます。他の種類のデリゲートも使用できますが、型指定されたEventHandler <TEventArgs>を使用すると、より論理的で美しく見えます。

C＃3のすべてはどうですか？

上記のフィールドのようなイベントの実装は、C＃4言語（.NET 4.0）に対応しています。以前のバージョンでは、非常に大きな違いがあります。

暗黙的な実装では、ループを使用したInterlocked.CompareExchangeの代わりにロック（これ）を使用してスレッドセーフを提供します。静的イベントの場合、ロック（typeof（クラス））が使用されます。 C＃3のコンパイラの暗黙的なイベント定義に似たコードは次のとおりです。

 class Class { EventHandler changed; public event EventHandler Changed { add { lock(this) { changed = changed + value; } } remove { lock(this) { changed = changed - value; } } } }

さらに、クラス内のイベントの処理は、デリゲートと同様に実行されます。 + =および-=追加/削除メソッドをバイパスして、Delegate.CombineおよびDelegate.Removeを直接呼び出します。この変更により、C＃4でプロジェクトをビルドできなくなる可能性があります！ C＃3では、+ =と-=の結果はデリゲートでした。なぜなら、変数を割り当てた結果は、常に割り当てられた値です。 C＃4では、結果は無効です。追加/削除メソッドは値を返しません。

言語の異なるバージョンでの作業の変更に加えて、さらにいくつかの機能があります。

機能＃1-サブスクライバーライフエクステンション

イベントをサブスクライブするとき、イベントデリゲートの呼び出しリストに、イベントが呼び出されたときに呼び出されるメソッドへの参照を追加します。したがって、イベントにサブスクライブしているオブジェクトが占有しているメモリは、イベントからサブスクライブが解除されるか、イベントを含むオブジェクトが破棄されるまで解放されません。この機能は、アプリケーションのメモリリークの一般的な原因の1つです。

この欠点を修正するために、弱いイベントがしばしば使用されます、弱いイベント。このトピックはすでにHabréで取り上げられています。

機能＃2-明示的なインターフェイスの実装

このインターフェイスが明示的に実装されている場合、インターフェイスの一部であるイベントはフィールドとして実装できません。そのような場合、標準イベント実装をプロパティとして実装するためにコピーするか、インターフェイスのこの部分を暗黙的に実装する必要があります。また、このイベントのスレッドセーフが不要な場合は、最も単純で効果的な定義を使用できます。

 EventHandler changed; event EventHandler ISomeInterface.Changed { add { changed += value; } remove { changed -= value; } }

機能＃3-セーフコール

呼び出し前のイベントのnullをチェックする必要があります。これは、上記のデリゲートの作業から得られます。コードはこれから成長し、少なくとも2つの方法があることを回避します。最初の方法は、ジョンスキートの著書C＃in depthで説明されています。

 public event EventHandler Changed = delegate { };

短く簡潔。イベントデリゲートを空のメソッドで初期化するため、nullになることはありません。デリゲートからこのメソッドを減算することは不可能です。なぜならデリゲートの初期化中に定義され、プログラム内のどこからでも名前もリンクもありません。

2番目の方法は、必要なnullチェックを含むメソッドを記述することです。この手法は、拡張メソッドが利用可能な.NET 3.5以降で特にうまく機能します。拡張メソッドを呼び出すとき、それが呼び出されるオブジェクトはこのメソッドの単なるパラメーターであるため、このオブジェクトはこの場合に使用される空の参照にすることができます。

 public static class EventHandlerExtensions { public static void SafeRaise(this EventHandler handler, object sender, EventArgs e) { if(handler != null) handler(sender, e); } public static void SafeRaise<TEventArgs>(this EventHandler<TEventArgs> handler, object sender, TEventArgs e) where TEventArgs : EventArgs { if(handler != null) handler(sender, e); } }

したがって、Changed.SafeRaise（this、EventArgs.Empty）などのイベントをトリガーでき、コード行を節約できます。 EventArgs.Emptyがある場合、明示的に渡さないように、拡張メソッドの3番目のバリアントを定義することもできます。その後、コードはChanged.SafeRaise（これ）に削減されますが、このアプローチはお勧めしません。チームの他のメンバーの場合、空の引数を渡すほど明示的ではない場合があります。

微妙な番号4-標準実装の何が問題になっていますか？

ReSharperをお持ちの場合は、彼の次のメッセージを見ることができます。リゾルバチームは、すべてのユーザーがイベント/デリゲートの作業についてサブスクリプション解除/減算の観点から十分に知らされているわけではないが、それでも、イベントはユーザーに対してではなく、。。そのような機能があり、それはあなたのコードに残っているはずです。

ボーナス：コントライベントを作成するマイクロソフトの試み

C＃4の最初のベータ版では、Microsoftはイベントに矛盾を追加しようとしました。これにより、EventHandler <EventArgs>シグネチャを持つメソッドを使用してEventHandler <MyEventArgs>イベントをサブスクライブでき、異なる（ただし適切な）シグネチャを持ついくつかのメソッドがイベントデリゲートに追加されるまですべてが機能しました。このようなコードはコンパイルされましたが、実行時エラーでクラッシュしました。どうやら、彼らはこれを回避することができず、C＃4のリリースでは、EventHandlerの矛盾が無効になりました。

サブスクライブ時にデリゲートの明示的な作成を省略した場合、これはそれほど顕著ではありません。たとえば、次のコードは正常にコンパイルされます。

 public class Tests { public event EventHandler<MyEventArgs> Changed; public void Test() { Changed += ChangedMyEventArgs; Changed += ChangedEventArgs; } void ChangedMyEventArgs(object sender, MyEventArgs e) { } void ChangedEventArgs(object sender, EventArgs e) { } }

これは、コンパイラ自体が新しいEventHandler <MyEventArgs>（...）を両方のサブスクリプションに置き換えるためです。少なくとも1つの場所で新しいEventHandler <EventArgs>（...）を使用すると、コンパイラーはエラーを報告します-EventHandler <System.EventArgs>のタイプをEventHandler <Events.MyEventArgs>に変換することはできません（ここでEventsはテストの名前空間です）プロジェクト）。

ソース

以下はソースのリストであり、その一部は記事の作成に使用されました。 Jon Skeet（Jon Skeet）の本を読むことをお勧めします。この本では、デリゲートだけでなく、他の多くの言語ツールについても詳しく説明しています。

.NETイベントの詳細