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}

您可以透過傳回函式的 Message 物件存取 Pub/Sub 訊息的酬載。對於 Pub/Sub 訊息主體中帶有 JSON 的訊息,Cloud Functions 適用的 Firebase SDK 具有將訊息解碼的輔助屬性。例如,以下是利用簡易 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);
  }

其他的非 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;

存取訊息屬性 {:#access-message}

Pub/Sub 訊息可透過發布指令中設定的資料屬性傳送。舉例來說,您可以發布含有 name 屬性的訊息:

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

您可以從 Message.attributes 讀取這類屬性:

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

您可能會發現 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);
});