Pub/Sub 触发器


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 消息载荷 {:#access-pub/sub}

可以从返回给函数的 Message 对象来访问 Pub/Sub 消息的载荷。对于 Pub/Sub 消息正文中的 JSON 消息，Firebase SDK for Cloud Functions 有一个辅助属性用于解码消息。例如，以下是一条已发布的具有简单 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);
  }
index.js

其他非 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;
index.js

访问消息属性 {:#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;
index.js

您可能会注意到，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);
});