Skip to content

パブリッシュ・サブスクライブパターン

公開日:November 17, 2024更新日:November 28, 2024
TypeScriptDesign pattern📄

パブリッシュ・サブスクライブパターン

パブリッシュ・サブスクライブパターン(Publish-Subscribe Pattern) は、オブジェクト間の疎結合な通信を実現するためのデザインパターンです。このパターンでは、イベントを発行(パブリッシュ)する側と、そのイベントを購読(サブスクライブ)する側が直接連携せず、イベントブローカー(またはメッセージブローカー)を介してやり取りします。これにより、パブリッシャー(発行者)とサブスクライバー(購読者)を疎結合に保ち、拡張性や保守性を向上させることが可能です。

パブリッシュ・サブスクライブパターンは、イベント駆動型のシステムや、UIコンポーネント間でのやり取りに使われることが多く、複数のオブジェクトが同じイベントに反応する必要がある場合に有効です。

TypeScriptでのパブリッシュ・サブスクライブパターンの実装

以下に、TypeScriptでパブリッシュ・サブスクライブパターンを実装する例を紹介します。この例では、シンプルなイベントシステムを構築し、複数のサブスクライバーがイベントに反応するシナリオを示します。

イベントシステムの例

typescript
// イベントエミッタクラス(イベントブローカーの役割を果たす)
class EventEmitter {
  private events: { [key: string]: Array<(...args: any[]) => void> } = {};

  // イベントをサブスクライブするメソッド
  subscribe(event: string, listener: (...args: any[]) => void): void {
    if (!this.events[event]) {
      this.events[event] = [];
    }
    this.events[event].push(listener);
  }

  // イベントを発行(パブリッシュ)するメソッド
  publish(event: string, ...args: any[]): void {
    if (this.events[event]) {
      this.events[event].forEach(listener => listener(...args));
    }
  }

  // イベントのサブスクライバーを解除するメソッド
  unsubscribe(event: string, listener: (...args: any[]) => void): void {
    if (this.events[event]) {
      this.events[event] = this.events[event].filter(l => l !== listener);
    }
  }
}

// 実際の使用例
const eventEmitter = new EventEmitter();

// リスナーを定義
const onUserLogin = (username: string) => {
  console.log(`User logged in: ${username}`);
};

const onUserLogout = (username: string) => {
  console.log(`User logged out: ${username}`);
};

// イベントをサブスクライブ
eventEmitter.subscribe('userLogin', onUserLogin);
eventEmitter.subscribe('userLogout', onUserLogout);

// イベントを発行
eventEmitter.publish('userLogin', 'Alice'); // "User logged in: Alice"
eventEmitter.publish('userLogout', 'Alice'); // "User logged out: Alice"

// サブスクライバーを解除
eventEmitter.unsubscribe('userLogin', onUserLogin);

// 解除後のイベント発行
eventEmitter.publish('userLogin', 'Bob'); // サブスクライバーが解除されているため何も出力されない

解説

  1. EventEmitterクラス(イベントブローカー)

    • EventEmitterクラスは、イベントを管理するためのイベントブローカーの役割を果たします。このクラスは、イベントのサブスクライブ、パブリッシュ、サブスクライバーの解除を行うメソッドを提供します。
  2. subscribeメソッド

    • subscribeメソッドは、特定のイベントにリスナー(コールバック関数)を追加します。これにより、イベントが発行されたときに対応するリスナーが呼び出されます。
  3. publishメソッド

    • publishメソッドは、特定のイベントを発行し、登録されているすべてのリスナーを呼び出します。これにより、イベントに関連する全てのアクションが実行されます。
  4. unsubscribeメソッド

    • unsubscribeメソッドは、特定のイベントに登録されたリスナーを解除します。これにより、解除されたリスナーはそのイベントが発行されても呼び出されなくなります。
  5. 実際の使用例

    • EventEmitterインスタンスを作成し、userLoginuserLogoutのイベントにリスナーを追加します。その後、イベントを発行して、対応するリスナーが呼び出される様子を示しています。また、リスナーを解除して、解除後にイベントが発行されても何も起こらないことを確認しています。

利点

  • 疎結合の実現: パブリッシャーとサブスクライバー間の依存関係をなくすことで、クラス同士の結合度を低く保ち、システム全体の保守性を向上させます。
  • スケーラビリティの向上: 新しいサブスクライバーを追加することが容易であり、既存のコードを変更せずに新しい機能を追加できます。
  • イベント駆動の設計: 複数のオブジェクトが同じイベントに反応する必要がある場合、効率的に処理することが可能です。

使用例

  • ユーザーインターフェース: ボタンのクリックやフォームの送信など、ユーザーのアクションに応じてイベントを発行し、複数のコンポーネントでそのイベントに反応させることができます。
  • 通知システム: ユーザーのアクションに応じて通知を送る場合に、特定のイベントが発生したときに通知を発行する処理で使用されます。
  • リアルタイムデータの処理: WebSocketやその他のリアルタイム技術と組み合わせて、サーバーからの通知を複数のクライアントに配信するために使用されます。

まとめ

パブリッシュ・サブスクライブパターンは、オブジェクト間の疎結合な通信を実現し、イベント駆動の設計を可能にするデザインパターンです。TypeScriptでの実装を通じて、イベントを発行する側とそれを受け取る側を分離し、柔軟で保守性の高いコードを構築する方法を理解しました。

このパターンを利用することで、イベントのサブスクライバーを柔軟に追加・削除でき、システム全体のスケーラビリティを向上させることが可能になります。