CodeGym /コース /C# SELF /イベント駆動プログラミングの例 ( event)

イベント駆動プログラミングの例 ( event)

C# SELF
レベル 54, レッスン 4
使用可能

1. はじめに

初心者はよくこう質問します:「実際のところイベントはどこで使うの?クラス間のやり取りは全部イベントでやるの?」 答えはシンプル:イベントとデリゲートは魔法ではないが、使わないとアプリがすぐにきつく結合した(tightly coupled)状態になり、コンポーネントを1つ変えるだけで他の多くを直す羽目になります。イベント/デリゲートを使うと、拡張しやすく保守しやすい設計が作れます。

  • UIプログラミング(WinForms、WPF、Xamarin、MAUI):クリック、ホバー、テキスト入力などのユーザー操作の処理。
  • 非同期操作:ファイルのダウンロード完了、ネットワークからのデータ受信、タイマの発火。
  • プラグインや拡張可能なシステムのアーキテクチャ:新しいモジュールをメインコードに強く統合せずに接続できる。
  • シグナル/ブロードキャストシステム:発生したイベントを多数の関心コンポーネントに通知する。
  • 状態の監視(「オブザーバ」):新しいメッセージの到着、データの変更、UIの更新に反応する。

それでは本題に入ろう!

2. アーキテクチャの骨組み

小さなコンソールアプリ「ミニチャット」を作っていると想像してみてください(社内トレーニング用や練習用)。エンティティは User、Chat(ここでは ChatRoom) と、たぶん Bot。ユーザーがメッセージを送ると、チャットは接続中の全ユーザーとボットに通知し、彼らは画面にメッセージを出すか、ボットなら自動応答を生成します。典型的なシナリオ:パブリッシャがイベント(event)を発生させ、ハンドラは EventHandler/EventHandler<TEventArgs> に登録され、OnMessageReceived のようなメソッドが通知に反応します。

// ユーザークラス(購読者)
public class User
{
    public string Name { get; }

    public User(string name)
    {
        Name = name;
    }

    // イベントのハンドラとなるメソッド
    public void OnMessageReceived(object? sender, MessageEventArgs e)
    {
        Console.WriteLine($"[{Name}] 新しいメッセージを受信しました: {e.MessageText}");
    }
}

// イベント引数
public class MessageEventArgs : EventArgs
{
    public string MessageText { get; }

    public MessageEventArgs(string text) => MessageText = text;
}

// チャットクラス(イベントの発行者)
public class ChatRoom
{
    public event EventHandler<MessageEventArgs>? MessageReceived;

    public void SendMessage(string text)
    {
        // イベントを発生させる(全サブスクライバに通知)
        MessageReceived?.Invoke(this, new MessageEventArgs(text));
    }
}

使用例:

var chat = new ChatRoom();
var user1 = new User("アントン");
var user2 = new User("マリア");

chat.MessageReceived += user1.OnMessageReceived;
chat.MessageReceived += user2.OnMessageReceived;

chat.SendMessage("みんな、こんにちは! 😊");

コンソールには2つのメッセージが出力されます — 両ユーザーが新しいメッセージを受け取りました。

3. 動的な登録と解除

実際にはユーザーがチャットを離れてメッセージを受け取りたくない場合があります。ユーザーが正しく退会(アンsubscribe)する方法を実装しましょう(演算子 -= を使います):

// User クラスに「チャットを退会する」メソッドを追加できる
public void Unsubscribe(ChatRoom chat)
{
    chat.MessageReceived -= OnMessageReceived;
}

例を展開します:

var chat = new ChatRoom();
var user1 = new User("アントン");
var user2 = new User("マリア");

chat.MessageReceived += user1.OnMessageReceived;
chat.MessageReceived += user2.OnMessageReceived;

chat.SendMessage("最初のニュース");

user2.Unsubscribe(chat); // マリアがチャットを離れる

chat.SendMessage("マリアはもうこのメッセージを見ません");

動的な登録/解除はあらゆる場所にあります:ウィンドウが閉じられたり、タブが閉じられたり、短命なサービスがグローバルなイベントソースから解除されたり。解除を忘れるとサブスクライバはゾンビになり、アプリはメモリリークします!

4. メッセージ処理と応答の生成

次に、すべてのメッセージに反応するボットを追加します。メッセージに「бот」という単語が含まれていればボットが自動で「Привет!」ではなく日本語で反応するようにしましょう(ここでは例としてキーワード検出を行います)。また複数登録や多重デリゲートの挙動も見てみます。

public class Bot
{
    public string Name { get; }

    public Bot(string name) => Name = name;

    public void OnMessageReceived(object? sender, MessageEventArgs e)
    {
        // ボットはキーワードに反応する
        if (e.MessageText.Contains("бот", StringComparison.OrdinalIgnoreCase))
        {
            if (sender is ChatRoom chatRoom)
            {
                Console.WriteLine($"[ボット {Name}]: こんにちは!何を手伝いましょう?");
                // ボットが応答メッセージを送信する
                chatRoom.SendMessage($"ボット {Name} が対応します。");
            }
        }
    }
}

使い方:

var chat = new ChatRoom();
var user = new User("エフゲニー");
var bot = new Bot("ヘルパー");

chat.MessageReceived += user.OnMessageReceived;
chat.MessageReceived += bot.OnMessageReceived;

// エフゲニーがボットをトリガーするメッセージを書く
chat.SendMessage("こんにちは、 бот、元気?");

コンソール出力の例(呼び出し順は保証されません!):

[エフゲニー] 新しいメッセージを受信しました: こんにちは、 бот、元気?
[ボット ヘルパー]: こんにちは!何を手伝いましょう?
[エフゲニー] 新しいメッセージを受信しました: ボット ヘルパー が対応します。
[ボット ヘルパー]: こんにちは!何を手伝いましょう?
[エフゲニー] 新しいメッセージを受信しました: ボット ヘルパー が対応します。
[ボット ヘルパー]: こんにちは!何を手伝いましょう?
...

どこかでバグが見つかりますか?そう、無限ループです:ボットが自分のメッセージに反応してしまい、再度メッセージを送る、を繰り返します。これを防ぐ一つの方法はシンプルなチェックを入れることです:

public void OnMessageReceived(object? sender, MessageEventArgs e)
{
    // ボットは自分のメッセージには反応しない
    if (e.MessageText.Contains("бот", StringComparison.OrdinalIgnoreCase) &&
        !e.MessageText.Contains(Name))
    {
        if (sender is ChatRoom chatRoom)
        {
            Console.WriteLine($"[ボット {Name}]: こんにちは!何を手伝いましょう?");
            chatRoom.SendMessage($"ボット {Name} が対応します。");
        }
    }
}

実務ではこういう状況はイベントの循環をどう扱うか、ラムダ式の使い方、あるいはさらに先のハンドラ打ち切りメカニズムを考える良いきっかけになります(後述)。

5. 非同期操作とコールバック

イベントは非同期操作の完了通知によく使われます。例えばネットワークからのデータ取得や長時間計算:Completed イベントは終了を通知し、RunLongOperationAsync は長時間処理を実行します。

public class LongRunner
{
    // 完了通知イベント
    public event EventHandler<EventArgs>? Completed;

    public async Task RunLongOperationAsync()
    {
        Console.WriteLine("長い操作を開始します...");
        await Task.Delay(2000); // 長い処理の模擬
        Console.WriteLine("操作が完了しました。サブスクライバに通知します。");
        Completed?.Invoke(this, EventArgs.Empty);
    }
}

クライアントコード:

var runner = new LongRunner();

// 完了イベントにサブスクライブ
runner.Completed += (sender, e) =>
{
    Console.WriteLine("通知を受け取りました:操作が完了しました!");
};

await runner.RunLongOperationAsync();

これが非同期相互作用の基本です — UIフレームワークではロード完了やアニメーションの終了、ユーザクリックなどを通知するのにイベントが多用されます。

6. シグナル配信システム

別の典型的な課題を見てみましょう:通知システム(例えばオンラインストアで商品の値下げがあったとき)。関心を持つ「リスナ」は SaleOccurred イベントで情報を受け取ります:

public class SaleNotifier
{
    public event EventHandler<SaleEventArgs>? SaleOccurred;

    public void AnnounceSale(string product, decimal newPrice)
    {
        SaleOccurred?.Invoke(this, new SaleEventArgs(product, newPrice));
    }
}

public class SaleEventArgs : EventArgs
{
    public string Product { get; }
    public decimal NewPrice { get; }
    public SaleEventArgs(string product, decimal price)
    {
        Product = product; NewPrice = price;
    }
}

public class Customer
{
    public string Name { get; }
    public Customer(string name) => Name = name;

    public void OnSale(object? sender, SaleEventArgs e)
    {
        Console.WriteLine($"[{Name}] に通知:{e.Product} の価格は今や {e.NewPrice.ToString(\"F2\")} です!");
    }
}

使い方:

var notifier = new SaleNotifier();
var c1 = new Customer("アンドレイ");
var c2 = new Customer("オリガ");

notifier.SaleOccurred += c1.OnSale;
notifier.SaleOccurred += c2.OnSale;

notifier.AnnounceSale("ケトル", 999.99m);

興味がなくなった顧客は解除できます:

notifier.SaleOccurred -= c2.OnSale;
notifier.AnnounceSale("ミキサー", 1999.99m);

このパターンは通知配信(notification, pub/sub)に使われ、現代アーキテクチャでは非常に重要です。

7. イベントチェーンのキャンセル機構の実装

時にはあるハンドラが「これ以上の通知を止めたい」場合があります。そのためにキャンセルフラグを持つ EventArgs の派生クラスを使うことが多いです。下の例では GetInvocationList() を手動で列挙し、Cancel = true で処理を中断します。

public class CancelEventArgs : EventArgs
{
    public bool Cancel { get; set; }
}

public class EventSource
{
    public event EventHandler<CancelEventArgs>? SomethingHappened;

    public void DoSomething()
    {
        var args = new CancelEventArgs();
        // 順序を制御したい場合の定番ループ
        var handlers = SomethingHappened?.GetInvocationList();
        if (handlers != null)
        {
            foreach (var handler in handlers)
            {
                ((EventHandler<CancelEventArgs>)handler)(this, args);
                if (args.Cancel)
                {
                    Console.WriteLine("チェーン通知が中断されました。");
                    break;
                }
            }
        }
    }
}

使用例:

var source = new EventSource();
source.SomethingHappened += (s, e) =>
{
    Console.WriteLine("最初のハンドラ");
};
source.SomethingHappened += (s, e) =>
{
    Console.WriteLine("2番目のハンドラがイベントをキャンセルします。");
    e.Cancel = true;
};
source.SomethingHappened += (s, e) =>
{
    Console.WriteLine("このハンドラは呼ばれません。");
};

source.DoSomething();

結果:

最初のハンドラ
2番目のハンドラがイベントをキャンセルします。
チェーン通知が中断されました。

この仕組みはバリデーションやウィンドウのクローズ前処理、権限チェックなど、「ストップしてそれ以上処理しない」と言いたい場面で便利です。

8. スレッドセーフとサブスクライバ管理

マルチスレッド環境では、サブスクライバがイベントの発行中に追加・削除されることがあり、スレッドセーフなパターンが必要です(参照: 公式ドキュメント)。手動で add/remove アクセサを実装し、lock で保護する方法が取れます:

public class CustomEvent
{
    private EventHandler? _handlers;

    public event EventHandler SomethingHappened
    {
        add
        {
            lock (this) // スレッドセーフ
            {
                _handlers += value;
            }
        }
        remove
        {
            lock (this)
            {
                _handlers -= value;
            }
        }
    }

    protected void RaiseEvent()
    {
        // コピーを使う
        EventHandler? handler;
        lock (this)
        {
            handler = _handlers;
        }
        handler?.Invoke(this, EventArgs.Empty);
    }
}

このやり方はあまり一般的ではありません(通常はデフォルト実装で十分)が、高負荷システムで必要になることがあります。

9. UI におけるイベント — WinForms/WPF/MAUI

WinForms:

private void button1_Click(object sender, EventArgs e)
{
    MessageBox.Show("ボタンが押されました!");
}

このメソッドの背後には登録機構があります:

button1.Click += button1_Click;

WPF/MAUI: モデルのプロパティ変更通知には PropertyChanged のようなイベントが使われます:

public class MyViewModel : INotifyPropertyChanged
{
    private string _value;
    public string Value
    {
        get => _value;
        set
        {
            if (_value != value)
            {
                _value = value;
                PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(Value));
            }
        }
    }

    public event PropertyChangedEventHandler? PropertyChanged;
}

フレームワークはこれらのイベントを多用してリアクティブなインターフェース(MVVM)を構築します。

10. イベント使用時の代表的なミス

ミス №1: メモリリークを作ること。
これが最もよくある問題です。短命なオブジェクト(ウィンドウや一時サービスなど)が長命なオブジェクト(グローバルキャッシュや static クラス)にサブスクライブしたまま破棄されると、ガベージコレクタに回収されずメモリに残ります。Dispose やオブジェクトのライフサイクルに応じた適切な場所で必ず解除を実装してください。

ミス №2: 無限イベントループを作ること。
サブスクライバがイベントに反応して同じイベントを再発生させると、無限再帰になり StackOverflowException で落ちます。ハンドラが自分自身でトリガーしたイベントに反応しないよう条件をチェックしましょう。

ミス №3: サブスクライバの呼び出し順に依存すること。
ハンドラが登録された順で必ず呼ばれるとは限りません(C# の仕様と CLR の実装は順序を保証しない)。順序が重要なら GetInvocationList() を使って手動で呼び出してください。

ミス №4: マルチスレッド環境でのイベントの安全でない操作。
あるスレッドでサブスクライブ/解除が行われ、別のスレッドでイベントが発行されるとレースコンディションが発生します。古典的な対処法はデリゲートをローカル変数にコピーしてから呼ぶことです:

var handler = MyEvent;
handler?.Invoke(this, EventArgs.Empty);

あるいは add/remove を手動実装して lock を使う方法もあります。

2
タスク
C# SELF, レベル 54, レッスン 4
ロック未解除
セール通知システム
セール通知システム
1
アンケート/クイズ
デリゲートに関するよくあるミス、レベル 54、レッスン 4
使用不可
デリゲートに関するよくあるミス
イベントプログラミングのベストプラクティス
コメント
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION