Pub/Sub-Trigger


Google Clouds Pub/Sub ist ein global verteilter Nachrichtenbus, der automatisch nach Bedarf skaliert wird. Sie können eine Funktion erstellen, die Pub/Sub-Ereignisse mit functions.pubsub 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 Nutzlast der Pub/Sub-Nachricht zugreifen {:#access-pub/sub}

Die Nutzlast für die Pub/Sub-Nachricht ist über das Message-Objekt zugänglich, das an Ihre Funktion zurückgegeben wird. Für Nachrichten mit JSON im Pub/Sub-Nachrichtentext hat das Firebase SDK für Cloud Functions ein Hilfsattribut zum Decodieren der Nachricht. Hier ist ein Beispiel für eine Nachricht, die mit einer einfachen JSON-Nutzlast veröffentlicht wurde:

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

Sie können über das Attribut json auf eine JSON-Daten-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);
  }

Andere, nicht JSON-basierte Nutzlasten sind in der Pub/Sub-Nachricht als base64-codierte Strings im Nachrichtsobjekt 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;

Auf Nachrichtenattribute zugreifen {:#access-message}

Die Pub/Sub-Nachricht kann mit Datenattributen gesendet werden, die im Befehl „publish“ festgelegt sind. Sie können beispielsweise eine Nachricht mit dem Attribut name 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;

Möglicherweise stellen Sie fest, dass einige grundlegende Daten wie die Nachrichten-ID oder die Veröffentlichungszeit der Nachricht in Message.attributes nicht verfügbar sind. Als Workaround können Sie auf diese Details im EventContext des auslösenden Ereignisses zugreifen. 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);
});