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 訊息酬載
您可以從傳回至函式的 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;
存取訊息屬性
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);
});