Pub/Sub-Trigger


Pub/Sub von Google Cloud ist ein global verteilter Nachrichtenbus, der automatisch nach Bedarf skaliert wird. Mit functions.pubsub können Sie eine Funktion erstellen, die Pub/Sub-Ereignisse verarbeitet.

Pub/Sub-Funktion auslösen

Sie können eine Funktion auslösen, wenn eine neue Pub/Sub-Nachricht an ein bestimmtes Thema gesendet wird. Sie müssen den Namen des Pub/Sub-Themas angeben, mit dem Ihre Funktion ausgelöst werden soll, und das Ereignis im Ereignishandler onPublish() festlegen:

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

Auf die Pub/Sub-Nachrichtennutzlast zugreifen {:#access-pub/sub}

Auf die Nutzlast der Pub/Sub-Nachricht kann über das Message-Objekt zugegriffen werden, das an Ihre Funktion zurückgegeben wird. Für Nachrichten mit JSON im Pub/Sub-Nachrichtentext gibt es im Firebase SDK für Cloud Functions eine Hilfseigenschaft zum Decodieren der Nachricht. Hier ist beispielsweise eine Nachricht mit einer einfachen JSON-Nutzlast:

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

Über das Attribut json können Sie auf eine JSON-Nutzlast wie diese zugreifen:

  // 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

Andere Nutzlasten, die keine JSON-Nutzlasten sind, sind in der Pub/Sub-Nachricht als base64-codierte Strings im Nachrichtenobjekt enthalten. Wenn Sie eine Nachricht wie die folgende lesen möchten, müssen Sie den base64-codierten String wie gezeigt decodieren:

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

Attribute für Zugriffsnachrichten {:#access-message}

Pub/Sub-Nachrichten können mit Datenattributen gesendet werden, die im Befehl „publish“ festgelegt sind. So können Sie beispielsweise eine Nachricht mit einem name-Attribut veröffentlichen:

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

Sie können solche Attribute aus Message.attributes lesen:

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

Einige grundlegende Daten wie die Nachrichten-ID oder die Veröffentlichungszeit der Nachricht sind in Message.attributes möglicherweise nicht verfügbar. Sie können diese Details jedoch in den EventContext des auslösenden Ereignisses aufrufen. Beispiel:

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);
});