טריגרים של Pub/Sub


Google Cloud's Pub/Sub הוא אוטובוס הודעות מבוזר גלובלית שניתן להרחבה אוטומטית לפי הצורך. אפשר ליצור פונקציה שמטפלת באירועים של Pub/Sub באמצעות functions.pubsub.

הפעלת פונקציית Pub/Sub

אפשר להפעיל פונקציה בכל פעם ששולחים הודעה חדשה Pub/Sub לנושא ספציפי. צריך לציין את Pub/Sub שם הנושא שרוצים להפעיל את הפונקציה שלו, ולהגדיר את האירוע בתוך onPublish() handler האירועים:

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

גישה למטען הייעודי (payload) של הודעת pub/sub {:#access-pub/sub}

המטען הייעודי (payload) של ההודעה Pub/Sub נגיש מהאובייקט Message שמוחזר לפונקציה. בהודעות עם JSON בגוף ההודעה Pub/Sub, ל-SDK‏ Firebase של Cloud Functions יש מאפיין עזר לפענוח ההודעה. לדוגמה, הנה הודעה שפורסמה עם מטען ייעודי (payload) פשוט של JSON:

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

אפשר לגשת למטען ייעודי (payload) של נתוני 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);
  }

מטענים ייעודיים (payload) אחרים שאינם JSON כלולים בהודעה Pub/Sub כמחרוזות בקידוד base64 באובייקט ההודעה. כדי לקרוא הודעה כמו זו שבהמשך, צריך לפענח את המחרוזת בקידוד 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 עם מאפייני נתונים שמוגדרים בפקודה publish. לדוגמה, אפשר לפרסם הודעה עם מאפיין 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. כדי לעקוף את הבעיה, אפשר לגשת לפרטים האלה ב-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);
});