Pub/Sub 觸發條件


Google CloudPub/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 訊息的酬載。如果訊息內文中含有 JSON,且 Pub/Sub 訊息內文中有 JSON,Cloud FunctionsFirebase 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);
});