CodeGym /コース /C# SELF /サブスクライバーとイベントの安全な呼び出し

サブスクライバーとイベントの安全な呼び出し

C# SELF
レベル 53, レッスン 2
使用可能

1. Введение

コードでこう書くとき、

worker.WorkCompleted += listener.OnWorkCompleted;

実際にはイベントの「呼び出しリスト」(multicast delegate)にメソッドへの参照を追加しているんだ。この「リスト」は、イベントが発生したときに呼ばれるメソッドの並びに過ぎない。C# ではイベントは複数の購読者をサポートする delegate をベースに実装されている。

イメージとしてはメーリングリスト:購読者(メールアドレス)のリストがあって、ニュースレター(イベント)を送ると全員に届く。誰かが退会するとリストから消えて、その人にはもう届かない、みたいな。

Как добавить или убрать подписчика

購読(+=)と解除(-=)はイベント内部の delegate に対して動く。ラムダを登録して解除する例はこんな感じ:

EventHandler<WorkCompletedEventArgs> handler = (sender, e) =>
{
    Console.WriteLine($"[ラムダ] 作業完了: {e.Message}");
};

worker.WorkCompleted += handler; // 登録
worker.WorkCompleted -= handler; // 解除

普通のメソッドの場合の解除も同じ:

worker.WorkCompleted += listener.OnWorkCompleted;
worker.WorkCompleted -= listener.OnWorkCompleted;

注意点:同じメソッドを何度も登録すると、その回数だけ呼ばれるので、解除するときも同じ回数だけ -= を呼ぶ必要があるよ。

2. Зачем вообще управлять им вручную?

Почему важно управлять подписчиками?

実際のアプリケーション、特に長く稼働するもの(デスクトップやサーバーなど)では、購読の管理を怠るとメモリリークにつながる。購読者オブジェクトがもう不要でも、イベントの購読リストに残っていると、delegate からの参照があるためガベージコレクタはそれを回収できないんだ。

Иллюстрация

操作 サブスクライバーへの結果
+= (登録) リストに追加される
-= (解除) リストから削除される
サブスクライバーオブジェクトが破棄された もし 解除 していなければ! — 削除されない。イベントに参照が残るため。
サブスクライバーオブジェクトが破棄された 解除されていれば普通に回収される

Как узнать, кто подписан на событие?

イベントは購読者リストをカプセル化しているので、発行側のクラスの外からそのリストを直接取得することはできない — できるのは追加(+=)か削除(-=)だけだ。

ただし、EventHandler のような delegate ベースで宣言されたイベントと同じクラス内部なら、GetInvocationList() を使って現在の購読者リストを得ることができる:

// 発行者クラス内
if (WorkCompleted != null)
{
    foreach (Delegate subscriber in WorkCompleted.GetInvocationList())
    {
        Console.WriteLine($"ハンドラー: {subscriber.Method.Name}, オブジェクト: {subscriber.Target}");
    }
}

こういう手法は日常的にはあまり必要ないけど、デバッグや全員を一括で解除するメソッドを作るときには便利だよ。

3. Безопасный вызов событий: "мины" и как их обойти

Что может пойти не так при вызове события?

見た目は簡単:こう呼ぶだけだ

WorkCompleted?.Invoke(this, args);

で、ほとんどの場合うまくいく… でも例外がある。主な落とし穴は次のとおり:

1. Многопоточная опасность

マルチスレッドのアプリでは、イベントが null かどうかをチェックしてから呼ぶ間に別スレッドで購読が変わる可能性がある。例えば:

1) スレッドAがチェック: WorkCompleted != null と判断。
2) 同時にスレッドBがイベントを -= して購読リストが空になる。
3) スレッドAが WorkCompleted.Invoke(...) を呼ぼうとして、NullReferenceException が発生する。購読者がもういないからね。

これはイベント操作でよくあるレースコンディションだ。

2. Неожиданные исключения в обработчиках

もし購読者の一つがイベント処理中に例外を投げると、それ以降のハンドラー呼び出しは中断される。つまり最初の例外でイベントの処理が止まってしまい、残りの購読者に通知が行かなくなる。全員に通知したいなら、各ハンドラー呼び出しを try-catch で包むことを検討してね。

3. Нежелательная утечка контекста

イベントハンドラーはしばしばインスタンスメソッドで、購読者オブジェクトへの参照(this)をキャプチャしている。購読者が発行者からアンサブスクライブを忘れると、発行者の delegate リストに参照が残るのでガベージコレクタがそのオブジェクトを回収できず、結果的にメモリリークになる。

Как безопасно вызывать событие?

1) Копировать делегат в локальную переменную

ローカル変数にコピーしてから呼ぶと、呼び出し中に購読リストが変わることはなくなる:

// 昔ながらの方法
var handler = WorkCompleted;
if (handler != null)
{
    handler(this, args);
}

あるいは null-conditional 演算子を使ってもっとモダンに:

WorkCompleted?.Invoke(this, args);

大抵の場合これで十分。C# のコンパイラはこの構文を理解して内部的にコピーしてくれる(公式ドキュメント参照: официальная документация)。

2) Защита от исключений обработчиков

全てのハンドラーを呼びたい(たとえ一つが落ちても)場合は、手動で列挙して各呼び出しを try/catch で保護する:

var handler = WorkCompleted;
if (handler != null)
{
    foreach (EventHandler<WorkCompletedEventArgs> subscriber in handler.GetInvocationList())
    {
        try
        {
            subscriber(this, args);
        }
        catch (Exception ex)
        {
            // ログに残すけど、イベント全体を止めない
            Console.WriteLine($"ハンドラーのエラー: {ex.Message}");
        }
    }
}

UI の普通のシナリオではあまり必要ないけど、ライブラリやロギング、複雑なシステムでは有用だよ。

3) Предотвращаем утечки памяти

購読者のライフタイムが発行者より短い(例:ウィンドウがアプリのイベントを購読している)場合、必ずアンサブスクライブする:

worker.WorkCompleted -= listener.OnWorkCompleted;

そうしないと garbage collector は listener を回収できない、たとえ他に「明示的な」参照が無くても。

4. Практический пример: менеджер массовых подписок и отписок

学習用アプリを拡張してみよう。複数のリスナーがいて、プログラムの実行中に動的に登録・解除をしたいとする。

public class WorkListener
{
    private readonly string _name;

    public WorkListener(string name)
    {
        _name = name;
    }

    public void OnWorkCompleted(object sender, WorkCompletedEventArgs e)
    {
        Console.WriteLine($"Listener {_name}: {e.Message}");
    }
}

メインプログラムでは:

var worker = new Worker();

var listeners = new List<WorkListener>
{
    new WorkListener("イワン"),
    new WorkListener("マリア"),
    new WorkListener("デニス")
};

// 全員を登録
foreach (var listener in listeners)
    worker.WorkCompleted += listener.OnWorkCompleted;

// イベントを発生させる
worker.DoWork();

// 一括解除
foreach (var listener in listeners)
    worker.WorkCompleted -= listener.OnWorkCompleted;

// もう誰も反応しないことを確認
worker.DoWork();

最初の作業後にはコンソールに3つのメッセージが出て、2回目は何も出ないはずだよ。

5. Советы по безопасной работе с событиями

  • 購読者のライフサイクルが発行者より短いなら、適切なタイミングでアンサブスクライブする。
  • 「長生きする発行者 — 一時的な購読者」パターンを実装するなら、常に Dispose() やウィンドウのクローズ時などで解除を行うこと。
  • ワンショットのイベントには匿名ハンドラー(ラムダ)を使い、その中で自分自身を解除するやり方が便利:
EventHandler<WorkCompletedEventArgs> handler = null;
handler = (s, e) => 
{
    Console.WriteLine("イベントは一度だけ処理された!");
    worker.WorkCompleted -= handler;
};
worker.WorkCompleted += handler;
  • 「誰が購読しているか」をチェックするために購読者やハンドラーへの参照を保存しないこと — 普通のビジネスロジックでは不要。デバッグ目的だけにしてね。

6. Частые ошибки и как их избежать

ミスその1: アンサブスクライブを忘れる — メモリリーク。
購読者が解除されないと、特に多数のイベントや購読者がある大規模アプリでは、オブジェクトが必要以上にメモリに残り続ける。すぐに顕在化しないことが多いけど、メモリ使用量の増加や性能低下につながる。

ミスその2: null チェックなしでイベントを呼ぶ。
イベントに購読者がいない状態で直接呼ぶと NullReferenceException が発生する。新しい C# では安全呼び出し演算子 ?. が助けになるけど、古いコードや手動でハンドラーを列挙する場合は null チェックを忘れないこと。

ミスその3: あるハンドラーの例外で他が呼ばれなくなる。
もし一つのハンドラーが例外を投げると以降のハンドラー呼び出しは実行されない。全ての購読者に確実に通知したいなら、ハンドラーをループで回して各呼び出しを try/catch で保護しよう。

2
タスク
C# SELF, レベル 53, レッスン 2
ロック未解除
例外処理付きの安全なイベント呼び出し
例外処理付きの安全なイベント呼び出し
コメント
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION