CodeGym /コース /C# SELF /イベントの購読解除( -=)とメモリリーク

イベントの購読解除( -=)とメモリリーク

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

1. はじめに

ある意味で、C#のイベント購読は友達のミーム配信に登録するようなものです:あなたが「もういい」と言って購読解除するまでニュース(通知)が届き続けます。プログラミングではこれが特に重要で、購読を忘れるとそれはただの「もう一つのミーム」ではなく、メモリリークになります!

例えば、アプリに設定用のフォーム(例:設定ウィンドウ)があるとします。これはメインウィンドウのイベントに登録して、変更に反応します。ユーザーはフォームを閉じてオブジェクトが破棄されたと思っていても、ハンドラがまだ購読されたまま! そのためフォームはメモリ上に残り続けます。なぜなら発行者(publisher)がイベントを通してフォームへの参照を保持しているからです。

結論:サブスクライバ(購読者)が発行者のイベントに登録して、購読解除を忘れると、発行者が生きている間はGCはそのオブジェクトを回収しません。

演算子 += を復習して -= を示す

  • += — 購読: イベントの呼び出しリストにハンドラを追加する。
  • -= — 購読解除: 呼び出しリストからハンドラを取り除く。

だいたいこんな感じです:


worker.WorkCompleted += handler; // 購読
worker.WorkCompleted -= handler; // 購読解除

同じハンドラが2回追加されたなら、確実にリストから消すには同じ回数だけ削除する必要があります。

内部の仕組みを少しだけ

裏側では、C#のイベントはdelegateフィールド(あるいはデリゲートのリスト)で、+=は実際には Delegate.Combine を呼び、-= は Delegate.Remove を呼びます。イベントに登録したオブジェクトは参照グラフの一部になります。だから購読を忘れる=メモリリーク、というわけです。

2. イベント経由のメモリリーク:仕組み

典型的な状況


class Window
{
    public event EventHandler Updated;

    public void SimulateUpdate()
    {
        // 模擬: すべての購読者に通知を送る
        Updated?.Invoke(this, EventArgs.Empty);
    }
}

class SettingsForm
{
    public void OnWindowUpdated(object sender, EventArgs e)
    {
        Console.WriteLine("SettingsForm はウィンドウの更新に反応した");
    }
}

ステップで見てみましょう:


var window = new Window();
var settingsForm = new SettingsForm();

window.Updated += settingsForm.OnWindowUpdated;

window.SimulateUpdate(); // SettingsForm が反応する

// ユーザーがフォームを閉じた。フォームへの参照を失う:
settingsForm = null;

// しかし SettingsForm オブジェクトは window が生きている限り
// ガベージコレクタに回収されない。
// なぜなら window.Updated が OnWindowUpdated メソッドへの参照を保持しており,
// それが SettingsForm インスタンスを参照しているから。

対処法は?
購読解除すること:


// そのためにはハンドラやオブジェクトへの参照が必要
window.Updated -= settingsForm.OnWindowUpdated;
settingsForm = null; // これでオブジェクトは回収可能になる

誰が誰を参照しているかの表

動作 誰が参照を保持しているか メモリを解放できるか
イベント購読(+=) 発行者が購読者を保持 発行者が生きている限りいいえ
購読解除(-=) 参照はない 全ての外部参照が削除されたらはい
購読なし 参照はない はい

3. 正しい購読解除のやり方

明示的にハンドラを削除する

例えばウィンドウやフォームを閉じるタイミングでこうします:


class SettingsForm
{
    private readonly Window _window;

    public SettingsForm(Window window)
    {
        _window = window;
        _window.Updated += OnWindowUpdated;
    }

    public void Close()
    {
        _window.Updated -= OnWindowUpdated; // 購読解除!
        // ここに閉じる処理(例えば Dispose, GC.SuppressFinalize など)
    }

    public void OnWindowUpdated(object sender, EventArgs e)
    {
        // イベント処理
    }
}

SettingsForm が「閉じる」ボタンで破棄されるなら、購読解除を行うメソッド(例:Close())を忘れずに呼ぶことが重要です。

IDisposableインターフェイスの利用

イベントに登録しライフサイクルを管理する複雑なオブジェクトには、IDisposable を実装するのが便利です。Dispose() 内で必要な購読解除を行います。


class SettingsForm : IDisposable
{
    private readonly Window _window;

    public SettingsForm(Window window)
    {
        _window = window;
        _window.Updated += OnWindowUpdated;
    }

    public void OnWindowUpdated(object sender, EventArgs e)
    {
        // ...
    }

    public void Dispose()
    {
        _window.Updated -= OnWindowUpdated;
        // 他のリソースもここで解放
    }
}

こうすれば SettingsForm を using ブロックで使ったり、明示的に Dispose() を呼んでリソース解放を自動化できます(必要ならファイナライズ可能な型で GC.SuppressFinalize を使うなど)。

4. ラムダ式との関わり:危険とちょっとしたコツ

ラムダ式でイベントに登録して、ラムダを変数に保存しておかないと、購読解除できません!


// 購読 — 匿名ラムダ
window.Updated += (s, e) => Console.WriteLine("ラムダが呼ばれた!");

// どうやって解除する? — できない!
window.Updated -= (s, e) => Console.WriteLine("ラムダが呼ばれた!"); // これは別のデリゲート!

対策:
ラムダをデリゲート変数に保持する:


EventHandler handler = (s, e) => Console.WriteLine("ラムダが呼ばれた!");
window.Updated += handler;

// ... これで解除できる!
window.Updated -= handler;

5. 便利な注意点

オブジェクトのライフサイクルとイベントの特徴

もう一つよくある問題は、二つの「長寿命」オブジェクト間で相互にイベントを購読してしまうことです。例えば一つのウィンドウが別のウィンドウのイベントに登録していて、両方とも長く使われ続けるとメモリ使用量が増え続けます。

推奨:誰が誰に購読しているか、いつ解除する必要があるかを常に意識してください。購読者のライフサイクルが発行者と同じなら問題ありません。購読者が発行者より短命である可能性があるなら、明示的な購読解除を実装しましょう。

普遍的ルール:「購読したら解除しろ!」

  • 長寿命の発行者(例えばグローバルなシングルトンやメインウィンドウ)に対しては、購読者側で必ず購読解除を実装すること。
  • 一時的オブジェクト(使い捨て通知や、購読者が発行者より長く生きるケース)では多少緩くても良いが、文脈には常に注意すること。
  • 手動で購読解除したくない場合は、WeakEvent(弱参照イベント)や専用のフレームワークなどを検討する。

6. 購読解除でよくあるミス

間違った購読解除:ハンドラは同一でなければならない

購読解除の際には、購読時とまったく同じハンドラを指定することが非常に重要です。そうしないと解除は失敗します。

誤りの例:


window.Updated += settingsForm.OnWindowUpdated;
// ...
window.Updated -= new SettingsForm().OnWindowUpdated; // 効かない!これは別のインスタンスで別のデリゲート!

正しいやり方:


window.Updated -= settingsForm.OnWindowUpdated;

匿名ラムダを保存せずに購読した場合、購読解除は不可能です。なぜなら解除時に渡すラムダは既に別のデリゲートインスタンスになるからです:


// 購読
window.Updated += (s, e) => Console.WriteLine("ラムダ!");

// 購読解除しようとしても — 効かない!
window.Updated -= (s, e) => Console.WriteLine("ラムダ!");

「忘れられた」購読解除

購読解除を単純に忘れてしまうケースは非常に多いです。特に購読者が発行者より長く生きる場合や、開発者がイベントの仕組みを完全に理解していない場合に起こります。その結果、購読者オブジェクトが必要以上に長くメモリに残り、メモリリークやパフォーマンス低下を招きます。

2
タスク
C# SELF, レベル 53, レッスン 1
ロック未解除
イベントの購読と購読解除
イベントの購読と購読解除
コメント
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION