.NET ガイドラインに準拠したイベントを発行する方法 (C# プログラミング ガイド)

  • [アーティクル]

ここでは、.NET の標準のパターンに従うイベントをクラスおよび構造体に追加する方法について説明します。 .NET クラス ライブラリ内のすべてのイベントは、次のように定義されている EventHandler デリゲートに基づいています。

public delegate void EventHandler(object sender, EventArgs e);

注意

.NET Framework 2.0 には、このデリゲートのジェネリック バージョンである EventHandler<TEventArgs> が導入されています。 次の例は、両方のバージョンの使用方法を示しています。

ユーザー定義のクラス内のイベントは、値を返すデリゲートを含む、あらゆる有効なデリゲート型に基づいて発行できますが、一般的には、次の例のように EventHandler を使用して、.NET のパターンに基づいて発行することをお勧めします。

名前 EventHandler は、実際にはイベントを処理しないため、混乱を招く可能性があります。 EventHandler、およびジェネリックの EventHandler<TEventArgs> はデリゲート型です。 シグネチャがデリゲート定義と一致するメソッドまたはラムダ式は、"イベント ハンドラー" で、イベントが発生したときに呼び出されます。

EventHandler パターンに基づいてイベントを発行する

  1. (イベントと共にカスタム データを送信する必要がない場合は、この手順を省略して手順 3a. に進んでください。)パブリッシャー クラスとサブスクライバー クラスの両方から参照できるスコープで、カスタム データのクラスを宣言します。 次に、カスタム イベント データを保持する必須メンバーを追加します。 この例では、単純な文字列が 1 つ返されます。

    public class CustomEventArgs : EventArgs
{
    public CustomEventArgs(string message)
    {
        Message = message;
    }

    public string Message { get; set; }
}

  2. (ジェネリック バージョンの EventHandler<TEventArgs> を使用する場合、この手順は省略します。)パブリッシャー クラスでデリゲートを宣言します。 EventHandler で終わる名前を指定します。 2 番目のパラメーターで、カスタムの EventArgs 型を指定します。

    public delegate void CustomEventHandler(object sender, CustomEventArgs args);

  3. 次のいずれかの手順を使用して、パブリッシャー クラスでイベントを宣言します。

    1. カスタムの EventArgs クラスがない場合、Event 型は非ジェネリック バージョンの EventHandler デリゲートになります。 このデリゲートは、C# プロジェクトを作成したときに含まれている System 名前空間で既に宣言されているため、ここで宣言する必要はありません。 パブリッシャー クラスに次のコードを追加します。

      public event EventHandler RaiseCustomEvent;

    2. 非ジェネリック バージョンの EventHandler を使用し、EventArgs から派生したカスタム クラスがある場合は、パブリッシャー クラス内でイベントを宣言し、手順 2 のデリゲートを型として使用します。

      public event CustomEventHandler RaiseCustomEvent;

    3. ジェネリック バージョンを使用する場合、カスタム デリゲートは不要です。 代わりに、パブリッシャー クラスでイベントの種類として EventHandler<CustomEventArgs> を指定します。山かっこの部分は、実際のクラス名で置き換えます。

      public event EventHandler<CustomEventArgs> RaiseCustomEvent;

例

次の例は、前の手順を具体的に示しています。ここでは、カスタムの EventArgs クラスを使用し、イベントの種類として EventHandler<TEventArgs> を使用しています。

using System;

namespace DotNetEvents
{
    // Define a class to hold custom event info
    public class CustomEventArgs : EventArgs
    {
        public CustomEventArgs(string message)
        {
            Message = message;
        }

        public string Message { get; set; }
    }

    // Class that publishes an event
    class Publisher
    {
        // Declare the event using EventHandler<T>
        public event EventHandler<CustomEventArgs> RaiseCustomEvent;

        public void DoSomething()
        {
            // Write some code that does something useful here
            // then raise the event. You can also raise an event
            // before you execute a block of code.
            OnRaiseCustomEvent(new CustomEventArgs("Event triggered"));
        }

        // Wrap event invocations inside a protected virtual method
        // to allow derived classes to override the event invocation behavior
        protected virtual void OnRaiseCustomEvent(CustomEventArgs e)
        {
            // Make a temporary copy of the event to avoid possibility of
            // a race condition if the last subscriber unsubscribes
            // immediately after the null check and before the event is raised.
            EventHandler<CustomEventArgs> raiseEvent = RaiseCustomEvent;

            // Event will be null if there are no subscribers
            if (raiseEvent != null)
            {
                // Format the string to send inside the CustomEventArgs parameter
                e.Message += $" at {DateTime.Now}";

                // Call to raise the event.
                raiseEvent(this, e);
            }
        }
    }

    //Class that subscribes to an event
    class Subscriber
    {
        private readonly string _id;

        public Subscriber(string id, Publisher pub)
        {
            _id = id;

            // Subscribe to the event
            pub.RaiseCustomEvent += HandleCustomEvent;
        }

        // Define what actions to take when the event is raised.
        void HandleCustomEvent(object sender, CustomEventArgs e)
        {
            Console.WriteLine($"{_id} received this message: {e.Message}");
        }
    }

    class Program
    {
        static void Main()
        {
            var pub = new Publisher();
            var sub1 = new Subscriber("sub1", pub);
            var sub2 = new Subscriber("sub2", pub);

            // Call the method that raises the event.
            pub.DoSomething();

            // Keep the console window open
            Console.WriteLine("Press any key to continue...");
            Console.ReadLine();
        }
    }
}

関連項目