CodeGym /コース /C# SELF /標準的なイベントパターン( EventHandler/ EventArgs)

標準的なイベントパターン( EventHandler/ EventArgs)

C# SELF
レベル 52, レッスン 3
使用可能

1. はじめに

思い出してみましょう:イベントとはパブリックな契約で、何か重要なことが起きたときに購読者を「呼ぶ」ことを約束するものです。過去の講義の例ではこんな宣言に出会ったかもしれません:


public event Action<string> MessageSent;

あるいは:


public delegate void MyHandler(int value);
public event MyHandler SomethingHappened;

これでも動きますが、このアプローチはシグネチャのバラつきや、イベントが誰から来たのか・何が起きたのか分からないといった問題を生みます。もしキーボードの各キー押下が毎回ランダムに違う動作をするようなものを想像してみてください。同じプログラム、同じタスクなのに、たとえばスペースを押したら一瞬前はジャンプだったのに突然インベントリが開く、なんて。カオスですよね。

.NET にはイベントに関する一種の憲法のようなものがあります — ハンドラーのシグネチャとイベントで渡される情報の構造に関する慣例です。典型的なスタイルはこうなります:


void Handler(object sender, EventArgs args);

見覚えありますか?WinForms のボタンクリックから ASP.NET のシステムイベント、サードパーティのライブラリまで、どこでもこの形を目にします。

2. EventHandler と EventArgs とは何か

主な考え方:各イベントは二つのことを伝えるということです:

  • 誰がイベントを発行したか? sender
  • 何が起きたか? EventArgs — 追加データ

C# の世界ではこう表現します:


public delegate void EventHandler(object sender, EventArgs e);
  • object sender — イベントの発行者への参照。普通は this です。
  • EventArgs e — イベントに関する追加情報を持つオブジェクト。単純なケースでは EventArgs.Empty を使い、複雑な場合は EventArgs を継承したカスタムクラスを使います。

ちょっとしたトリビア

公式の .NET ガイドラインでは、公開 API のイベントには (object sender, EventArgs e) のシグネチャを使うことが推奨されています。もし sender や EventArgs がないイベントを見かけたら、それは簡略化された独自スタイルで、典型的な .NET スタイルではない可能性が高いです。

統一フォーマットの大きな利点

統一された標準のおかげでイベントのログ取り、テスト、汎用的な購読、システムの拡張が楽になります。WinForms、WPF、ASP.NET のソースを見れば同じパターンが繰り返されているのが分かります。

3. 標準イベントパターンの使い方

1. 組み込みのデリゲート EventHandler を使う

自分でデリゲートを定義する代わりに既成のものを使えます:


public event EventHandler SmthHappened;

これでハンドラーは常に同じ形になります:


private void OnSmthHappened(object sender, EventArgs e)
{
    // イベントに対する反応のロジック
}

購読は従来通りシンプルです:


myObj.SmthHappened += OnSmthHappened;

重要:追加データが無いイベントでは EventArgs.Empty を使ってください。

2. 独自のイベント引数を作る

計算結果やファイル名、エラーなど情報を渡す必要があるなら、EventArgs を継承したクラスを作ります:


public class CalculationEventArgs : EventArgs
{
    public double Result { get; }
    public CalculationEventArgs(double result) => Result = result;
}

そしてジェネリックなデリゲート EventHandler<TEventArgs> を使います:


public event EventHandler<CalculationEventArgs> CalculationFinished;

ハンドラーはあなたの型を受け取ります:


private void OnCalculationFinished(object sender, CalculationEventArgs e)
{
    Console.WriteLine($"計算が完了しました。結果: {e.Result}");
}

4. アプリケーションの例

学習用プロジェクトを進めましょう — 単純な電卓があり、加算や減算をして操作完了をイベントで通知するという想定です。

最小限の例


public class Calculator
{
    public event EventHandler<CalculationEventArgs> CalculationPerformed;

    public void Add(int a, int b)
    {
        int result = a + b;
        // イベントを "発射" する
        CalculationPerformed?.Invoke(this, new CalculationEventArgs(result));
    }
}

public class CalculationEventArgs : EventArgs
{
    public int Result { get; }
    public CalculationEventArgs(int result) => Result = result;
}

購読して使う例:


var calc = new Calculator();
calc.CalculationPerformed += (sender, e) =>
{
    Console.WriteLine($"操作の結果: {e.Result}");
};
calc.Add(10, 20);
// 出力: 操作の結果: 30

これが「標準」の全てです:ハンドラーは常に送信者オブジェクトと引数オブジェクトを受け取り、汎用的で分かりやすい形になります。

5. 便利なポイント

イベント呼び出しのカプセル化:良いスタイル

.NET ではイベントを呼ぶロジックを protected メソッド(接頭辞は On)に切り出すのが一般的です:


protected virtual void OnCalculationPerformed(CalculationEventArgs e)
{
    CalculationPerformed?.Invoke(this, e);
}

そして実際のロジック(Add や Subtract 内)ではこのメソッドを呼びます:


public void Add(int a, int b) => OnCalculationPerformed(new CalculationEventArgs(a + b));

このスタイルなら派生クラスでイベント呼び出しの挙動をオーバーライドでき、イベントを呼び忘れるリスクも減ります。

図:.NET 標準イベントの仕組み

graph LR
    A[発行オブジェクト] -- "event EventHandler/ EventHandler<TEventArgs>" --> B[購読者一覧]
    B -- "ハンドラ (object sender, EventArgs e)" --> C[イベントへの反応]
    A -- "this (送信者)" --> C
    A -- "EventArgs (データ)" --> C

イベント宣言のバリエーション比較

アプローチ 発行者の伝達 (sender) 引数の伝達 汎用性 .NET での使用
public event Action<int> MyEvent;
なし あり 低い なし
public delegate void MyHandler(object, int); event MyHandler ...
あり あり 中くらい ほとんど使われない
public event EventHandler;
あり なし (EventArgs) 高い はい、標準
public event EventHandler<MyArgs>;
あり あり (MyArgs) 非常に高い はい、標準

面接や実運用での実益

標準的なイベントパターンの利用は .NET 開発者にとって必須です。面接ではほぼ確実に EventHandler と sender/EventArgs について聞かれます。Action<T> 型のイベントは簡易化されたものと見なされることが多いです。

実プロジェクトではこの方法がチーム開発、テスト、拡張、保守を楽にします。ログやプロファイラなどのサードパーティツールも標準形の方が統合しやすいです。

イベント呼び出しのフローチャート

flowchart TD
    subgraph A[発行クラス]
        C1((オブジェクト))
        C2[イベントを呼ぶメソッド]
        C3["event EventHandler<MyArgs>"]
    end
    subgraph B[購読クラス]
        D1((購読))
        D2["イベントハンドラ (object sender, MyArgs args)"]
    end
    C1 -- 呼ぶ --> C2
    C2 -- "Invoke(this, args)" --> C3
    C3 -- "通知する" --> D1
    D1 -- "呼ぶ" --> D2

6. アドバイス、注意点、よくあるミス

1. ハンドラーのシグネチャ。 Action<int> 型のイベントにしたくなるのは誘惑ですが、その場合 sender を失い、エコシステムとの互換性も落ちます。

2. 引数の渡し方。 EventArgs と通常のパラメータを混同しないでください。必要なデータはすべて引数オブジェクトに入れて渡します。

3. null の代わりに。 引数が無い場合は null ではなく EventArgs.Empty を使いましょう。

4. 弱い型付け。 何でも突っ込める EventHandler を乱用しないでください。イベントごとに専用の継承クラスを作ると可読性と信頼性が上がります。

5. イベント呼び出しのミス。 購読者がいるかチェックする: SomeEvent?.Invoke(this, e)。購読者がいないとイベント参照は null になります。

6. カプセル化の破壊。 発行クラスの外からイベントを呼ばないでください。イベントは購読/購読解除のためのもので、発火は内部で On... メソッドを通して行いましょう。

2
タスク
C# SELF, レベル 52, レッスン 3
ロック未解除
EventHandlerとカスタムEventArgsを使ったイベントの作成
EventHandlerとカスタムEventArgsを使ったイベントの作成
コメント
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION