Cloud Pub/Sub 教程

本简单教程演示了如何使用 Cloud Pub/Sub 触发器编写、部署和触发 Cloud Functions 后台函数。

如果您刚接触 Pub/Sub，并且希望了解详情，请参阅 Pub/Sub 文档，特别是管理主题和订阅。如需简要了解如何在 Cloud Functions 中处理 Pub/Sub 主题和订阅，请参阅 Google Cloud Pub/Sub 触发器。

如果您要查找使用 Pub/Sub 本身的代码示例，请访问 Google Cloud 示例浏览器。

注意：您还可以使用由 HTTP 触发的函数来侦听 Pub/Sub 推送订阅。通过 HTTP 函数，单个函数可以订阅多个 Pub/Sub 主题。

目标

• 编写和部署 Cloud Functions 后台函数。
• 向 Pub/Sub 主题发布消息以触发函数。

费用

本教程使用 Cloud Platform 的可计费组件，包括：

• Cloud Functions
• Pub/Sub

您可使用价格计算器根据您的预计使用情况来估算费用。

Cloud Platform 新用户可能有资格申请免费试用。

准备工作

1. 登录您的 Google 帐号。

   如果您还没有 Google 帐号，请注册新帐号。

2. 在 Google Cloud Console 的项目选择器页面上，选择或创建一个 Google Cloud 项目。

   注意：如果您不打算保留在此过程中创建的资源，请创建新的项目，而不要选择现有的项目。完成本教程介绍的步骤后，您可以删除所创建的项目，并移除与该项目关联的所有资源。

   转到项目选择器页面

3. 确保您的 Cloud 项目已启用结算功能。 了解如何确认您的项目是否已启用结算功能。

4. 启用 Cloud Functions and Cloud Pub/Sub API。

   启用 API

5. 安装并初始化 Cloud SDK。

如果您已安装 Cloud SDK，请运行以下命令进行更新：

gcloud components update

6. 准备开发环境。

   Node.js

   转到 Node.js 设置指南

   Python

   转到 Python 设置指南

   Go

   转到 Go 设置指南

   Java

   转到 Java 设置指南

   C#

   转到 .NET 设置指南

   Ruby

   转到 Ruby 设置指南

准备应用

1. 将示例应用代码库克隆到本地机器：

   Node.js

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

   Python

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

   Go

   git clone https://github.com/GoogleCloudPlatform/golang-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

   Java

   git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

   C#

   git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

   Ruby

   git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

2. 切换到包含用于访问 Pub/Sub 的 Cloud Functions 函数示例代码的目录：

   Node.js

   cd nodejs-docs-samples/functions/helloworld/

   Python

   cd python-docs-samples/functions/helloworld/

   Go

   cd golang-samples/functions/helloworld/

   Java

   cd java-docs-samples/functions/helloworld/hello-pubsub/

   C#

   cd dotnet-docs-samples/functions/helloworld/HelloPubSub/

   Ruby

   cd ruby-docs-samples/functions/helloworld/pubsub/

3. 查看示例代码：

   Node.js

   functions/helloworld/index.js

   在 GitHub 上查看

   /**
    * Background Cloud Function to be triggered by Pub/Sub.
    * This function is exported by index.js, and executed when
    * the trigger topic receives a message.
    *
    * @param {object} message The Pub/Sub message.
    * @param {object} context The event metadata.
    */
   exports.helloPubSub = (message, context) => {
     const name = message.data
       ? Buffer.from(message.data, 'base64').toString()
       : 'World';
   
     console.log(`Hello, ${name}!`);
   };

   Python

   functions/helloworld/main.py

   在 GitHub 上查看

   def hello_pubsub(event, context):
       """Background Cloud Function to be triggered by Pub/Sub.
       Args:
            event (dict):  The dictionary with data specific to this type of
            event. The `data` field contains the PubsubMessage message. The
            `attributes` field will contain custom attributes if there are any.
            context (google.cloud.functions.Context): The Cloud Functions event
            metadata. The `event_id` field contains the Pub/Sub message ID. The
            `timestamp` field contains the publish time.
       """
       import base64
   
       print("""This Function was triggered by messageId {} published at {}
       """.format(context.event_id, context.timestamp))
   
       if 'data' in event:
           name = base64.b64decode(event['data']).decode('utf-8')
       else:
           name = 'World'
       print('Hello {}!'.format(name))

   Go

   functions/helloworld/hello_pubsub.go

   在 GitHub 上查看

   
   // Package helloworld provides a set of Cloud Functions samples.
   package helloworld
   
   import (
   	"context"
   	"log"
   )
   
   // PubSubMessage is the payload of a Pub/Sub event.
   type PubSubMessage struct {
   	Data []byte `json:"data"`
   }
   
   // HelloPubSub consumes a Pub/Sub message.
   func HelloPubSub(ctx context.Context, m PubSubMessage) error {
   	name := string(m.Data) // Automatically decoded from base64.
   	if name == "" {
   		name = "World"
   	}
   	log.Printf("Hello, %s!", name)
   	return nil
   }
   

   Java

   functions/helloworld/hello-pubsub/src/main/java/functions/HelloPubSub.java

   在 GitHub 上查看

   
   import com.google.cloud.functions.BackgroundFunction;
   import com.google.cloud.functions.Context;
   import functions.eventpojos.PubSubMessage;
   import java.nio.charset.StandardCharsets;
   import java.util.Base64;
   import java.util.logging.Level;
   import java.util.logging.Logger;
   
   public class HelloPubSub implements BackgroundFunction<PubSubMessage> {
     private static final Logger logger = Logger.getLogger(HelloPubSub.class.getName());
   
     @Override
     public void accept(PubSubMessage message, Context context) {
       String name = "world";
       if (message != null && message.getData() != null) {
         name = new String(
             Base64.getDecoder().decode(message.getData().getBytes(StandardCharsets.UTF_8)),
             StandardCharsets.UTF_8);
       }
       logger.info(String.format("Hello %s!", name));
       return;
     }
   }

   C#

   functions/helloworld/HelloPubSub/Function.cs

   在 GitHub 上查看

   using CloudNative.CloudEvents;
   using Google.Cloud.Functions.Framework;
   using Google.Events.Protobuf.Cloud.PubSub.V1;
   using Microsoft.Extensions.Logging;
   using System.Threading;
   using System.Threading.Tasks;
   
   namespace HelloPubSub
   {
       public class Function : ICloudEventFunction<MessagePublishedData>
       {
           private readonly ILogger _logger;
   
           public Function(ILogger<Function> logger) =>
               _logger = logger;
   
           public Task HandleAsync(CloudEvent cloudEvent, MessagePublishedData data, CancellationToken cancellationToken)
           {
               string nameFromMessage = data.Message?.TextData;
               string name = string.IsNullOrEmpty(nameFromMessage) ? "world" : nameFromMessage;
               _logger.LogInformation("Hello {name}", name);
               return Task.CompletedTask;
           }
       }
   }

   Ruby

   functions/helloworld/pubsub/app.rb

   在 GitHub 上查看

   require "functions_framework"
   require "base64"
   
   FunctionsFramework.cloud_event "hello_pubsub" do |event|
     # The event parameter is a CloudEvents::Event::V1 object.
     # See https://cloudevents.github.io/sdk-ruby/latest/CloudEvents/Event/V1.html
     name = Base64.decode64 event.data["message"]["data"] rescue "World"
   
     # A cloud_event function does not return a response, but you can log messages
     # or cause side effects such as sending additional events.
     logger.info "Hello, #{name}!"
   end

   注意：Pub/Sub 消息的数据将以 base64 编码的字符串形式存储在 PubsubMessage 对象的 data 属性中。如需提取此数据，您可能需要对其进行解码，如上例所示。有关 context 参数的说明，请参见此处。

部署函数

如需部署带有 Pub/Sub 触发器的函数，请在包含示例代码（如果是 Java，则为 pom.xml 文件）的目录中运行以下命令：

Node.js

gcloud functions deploy helloPubSub \
--runtime nodejs10 \
--trigger-topic YOUR_TOPIC_NAME

您可以使用 --runtime 标志的以下值来指定偏好的 Node.js 版本：

• nodejs10
• nodejs12
• nodejs14（公开预览版）

Python

gcloud functions deploy hello_pubsub \
--runtime python38 \
--trigger-topic YOUR_TOPIC_NAME

您可以使用 --runtime 标志的以下值来指定偏好的 Python 版本：

• python37
• python38
• python39（公开预览版）

Go

gcloud functions deploy HelloPubSub \
--runtime go113 \
--trigger-topic YOUR_TOPIC_NAME

您可以使用 --runtime 标志的以下值来指定偏好的 Go 版本：

• go111（已弃用）
• go113

Java

gcloud functions deploy java-pubsub-function \
--entry-point functions.HelloPubSub \
--runtime java11 \
--memory 512MB \
--trigger-topic YOUR_TOPIC_NAME

C#

gcloud functions deploy csharp-pubsub-function \
--entry-point HelloPubSub.Function \
--runtime dotnet3 \
--trigger-topic YOUR_TOPIC_NAME

Ruby

gcloud functions deploy hello_pubsub --runtime ruby26 \
--trigger-topic YOUR_TOPIC_NAME

您可以使用 --runtime 标志的以下值来指定偏好的 Ruby 版本：

• ruby26
• ruby27

其中，YOUR_TOPIC_NAME 是函数将订阅的 Pub/Sub 主题的名称。

如果 YOUR_TOPIC_NAME 不存在，则此命令会为您创建。您还可以在运行 deploy 命令之前，使用 Cloud Console 或以下 gcloud 命令创建主题：

gcloud pubsub topics create YOUR_TOPIC_NAME

注意：Cloud Functions 会自动创建推送订阅，用于将指定主题的消息转发到您的函数。

触发函数

1. 向您的 Pub/Sub 主题发布消息。在此示例中，消息是函数将在问候语中使用的名称：

   gcloud pubsub topics publish YOUR_TOPIC_NAME --message YOUR_NAME

   请将 YOUR_TOPIC_NAME 替换为您的 Pub/Sub 主题的名称，并将 YOUR_NAME 替换为任意字符串。

2. 检查日志以确保执行已完成：

   gcloud functions logs read --limit 50
   

   注意：日志可能需要一些时间才会显示。如果日志没有立即显示，请在一两分钟后再检查一次。

您还可以从函数内部向 Pub/Sub 主题发布消息。

清理

为避免因本教程中使用的资源导致您的 Google Cloud 帐号产生费用，请删除包含这些资源的项目，或者保留项目但删除各个资源。

删除项目

为了避免产生费用，最简单的方法是删除您为本教程创建的项目。

要删除项目，请执行以下操作：

警告：删除项目会产生以下影响

• 项目中的所有内容都会被删除。如果您将现有项目用于本教程，则在删除该项目后，还将删除您已在该项目中完成的任何其他工作。
• 自定义项目 ID 丢失。创建此项目时，您可能创建了要在将来使用的自定义项目 ID。要保留使用该项目 ID 的网址（例如 appspot.com 网址），请删除项目内的所选资源，而不是删除整个项目。

如果您打算浏览多个教程和快速入门，重复使用项目可以帮助您避免超出项目配额上限。

1. 在 Cloud Console 中，转到管理资源页面。

   转到“管理资源”

2. 在项目列表中，选择要删除的项目，然后点击删除。
3. 在对话框中输入项目 ID，然后点击关闭以删除项目。

删除 Cloud Functions 函数

删除 Cloud Functions 函数不会移除存储在 Cloud Storage 中的任何资源。

如需删除您在本教程中创建的 Cloud Functions 函数，请运行以下命令：

Node.js

gcloud functions delete helloPubSub 

Python

gcloud functions delete hello_pubsub 

Go

gcloud functions delete HelloPubSub 

Java

gcloud functions delete java-pubsub-function 

C#

gcloud functions delete csharp-pubsub-function 

Ruby

gcloud functions delete hello_pubsub 

您也可以通过 Google Cloud Console 删除 Cloud Functions 函数。