Pub/Sub-Trigger (1. Generation)

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

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 die Funktion ausgelöst werden soll, und das Ereignis im onPublish() Event-Handler festlegen:

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

Auf die Nutzlast der Pub/Sub-Nachricht zugreifen

Die Nutzlast für die Pub/Sub Nachricht ist über das Message Objekt zugänglich, das an die Funktion zurückgegeben wird. Für Nachrichten mit JSON im Pub/Sub Nachrichten text enthält 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"}'

Über das Attribut json können Sie so auf eine JSON-Datennutzlast 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 Nutzlasten, die nicht im JSON-Format vorliegen, sind in der Pub/Sub Nachricht als base64-codierte Strings im Nachrichtobjekt 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

Pub/Sub Nachricht kann mit Datenattributen gesendet werden, die im Befehl zum Veröffentlichen festgelegt sind. Sie können 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;

Einige grundlegende Daten wie die Nachrichten-ID oder die Veröffentlichungszeit der Nachricht sind in Message.attributes nicht verfügbar. Um dieses Problem zu umgehen, können Sie auf diese Details im auslösenden Ereignis zugreifen EventContext. 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);
});