Pub/Sub トリガー


Google Cloud の Pub/Sub は、グローバルに分散されたメッセージバスであり、必要に応じて自動的にスケーリングされます。functions.pubsub を使用して、Pub/Sub イベントを処理する関数を作成できます。

Pub/Sub 関数をトリガーする

新しい Pub/Sub メッセージが特定のトピックに送信されるたびに、関数をトリガーできます。関数をトリガーする Pub/Sub トピック名を指定し、onPublish() イベント ハンドラ内でイベントを設定する必要があります。

exports.helloPubSub = functions.pubsub.topic('topic-name').onPublish((message) => {
  // ...
});

Pub/Sub メッセージ ペイロード {:#access-pub/sub} にアクセスする

Pub/Sub メッセージのペイロードには、関数に返された Message オブジェクトからアクセスできます。Pub/Sub メッセージ本文に JSON が含まれるメッセージの場合、Firebase SDK for Cloud Functions にある、メッセージをデコードするためのヘルパー プロパティを使用できます。例として、単純な JSON ペイロードを持つパブリッシュされたメッセージを次に示します。

gcloud pubsub topics publish topic-name --message '{"name":"Xenia"}'

json プロパティを使用して、次のように JSON データ ペイロードにアクセスできます。

  // Get the `name` attribute of the PubSub message JSON body.
  let name = null;
  try {
    name = message.json.name;
  } catch (e) {
    functions.logger.error('PubSub message was not JSON', e);
  }
index.js

その他の非 JSON ペイロードは、メッセージ オブジェクト内の base64 でエンコードされた文字列として Pub/Sub メッセージに含まれています。次のようなメッセージを読み込むには、次に示すように base64 でエンコードされた文字列をデコードする必要があります。

gcloud pubsub topics publish topic-name --message 'MyMessage'


// Decode the PubSub Message body.
const messageBody = message.data ? Buffer.from(message.data, 'base64').toString() : null;
index.js

メッセージ属性 {:#access-message} にアクセスする

Pub/Sub メッセージは、publish コマンドでデータ属性を設定したうえで送信できます。例として、name 属性を設定したメッセージをパブリッシュしてみます。

gcloud pubsub topics publish topic-name --attribute name=Xenia

設定された属性は Message.attributes から読み取ることができます。

// Get the `name` attribute of the message.
const name = message.attributes.name;
index.js

Message.attributes では、メッセージ ID やメッセージをパブリッシュする時間など、一部の基本的なデータが使用できないことがあります。この問題を回避するには、トリガー イベントの EventContext でこれらの詳細にアクセスします。次に例を示します。

exports.myFunction = functions.pubsub.topic('topic1').onPublish((message, context) => {
    console.log('The function was triggered at ', context.timestamp);
    console.log('The unique ID for the event is', context.eventId);
});