使用 Pub/Sub 模拟器在本地进行测试

您可以在部署函数之前在本地对其进行测试，方法是将 Functions 框架与 Pub/Sub 模拟器配合使用。 本页面上的示例使用 Cloud Functions（第 2 代）。

将 Functions 框架与 Pub/Sub 模拟器配合使用

您可以使用来自 Pub/Sub 模拟器的推送消息在本地触发函数。

按照此处的说明测试此功能。请注意，您需要使用三个单独的终端实例：

  1. 确保已安装了 pack 工具和 Docker。

  2. 在第一个终端中，在本地项目内、端口 8043 上启动 Pub/Sub 模拟器：

    gcloud beta emulators pubsub start \
    --project=abc \
    --host-port='localhost:8043'

  3. 在第二个终端中，创建一个 Pub/Sub 主题和订阅：

    curl -s -X PUT 'http://localhost:8043/v1/projects/abc/topics/mytopic'

    使用 http://localhost:8080 作为推送订阅的端点。

    curl -s -X PUT 'http://localhost:8043/v1/projects/abc/subscriptions/mysub' \
    -H 'Content-Type: application/json' \
    --data '{"topic":"projects/abc/topics/mytopic","pushConfig":{"pushEndpoint":"http://localhost:8080/projects/abc/topics/mytopic"}}'

  4. 在第三个终端中，将示例代码库克隆到您的本地机器：

    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 文件并将其解压缩。

    切换到包含 Cloud Functions 函数示例代码的目录：

    Node.js 

    cd nodejs-docs-samples/functions/v2/helloPubSub/

    Python 

    cd python-docs-samples/functions/v2/pubsub/

    Go 

    cd golang-samples/functions/functionsv2/hellopubsub/

    查看示例代码：

    Node.js 

    const functions = require('@google-cloud/functions-framework');

// Register a CloudEvent callback with the Functions Framework that will
// be executed when the Pub/Sub trigger topic receives a message.
functions.cloudEvent('helloPubSub', cloudEvent => {
  // The Pub/Sub message is passed as the CloudEvent's data payload.
  const base64name = cloudEvent.data.message.data;

  const name = base64name
    ? Buffer.from(base64name, 'base64').toString()
    : 'World';

  console.log(`Hello, ${name}!`);
});

    Python 

    import base64

from cloudevents.http import CloudEvent
import functions_framework

# Triggered from a message on a Cloud Pub/Sub topic.
@functions_framework.cloud_event
def subscribe(cloud_event: CloudEvent) -> None:
    # Print out the data from Pub/Sub, to prove that it worked
    print(
        "Hello, " + base64.b64decode(cloud_event.data["message"]["data"]).decode() + "!"
    )

    Go 

    
// Package helloworld provides a set of Cloud Functions samples.
package helloworld

import (
	"context"
	"fmt"
	"log"

	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
	"github.com/cloudevents/sdk-go/v2/event"
)

func init() {
	functions.CloudEvent("HelloPubSub", helloPubSub)
}

// MessagePublishedData contains the full Pub/Sub message
// See the documentation for more details:
// https://cloud.google.com/eventarc/docs/cloudevents#pubsub
type MessagePublishedData struct {
	Message PubSubMessage
}

// PubSubMessage is the payload of a Pub/Sub event.
// See the documentation for more details:
// https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage
type PubSubMessage struct {
	Data []byte `json:"data"`
}

// helloPubSub consumes a CloudEvent message and extracts the Pub/Sub message.
func helloPubSub(ctx context.Context, e event.Event) error {
	var msg MessagePublishedData
	if err := e.DataAs(&msg); err != nil {
		return fmt.Errorf("event.DataAs: %w", err)
	}

	name := string(msg.Message.Data) // Automatically decoded from base64.
	if name == "" {
		name = "World"
	}
	log.Printf("Hello, %s!", name)
	return nil
}

    创建 Buildpack（可能需要几分钟的时间）：

    Node.js

    pack build \
  --builder gcr.io/buildpacks/builder:v1 \
  --env GOOGLE_FUNCTION_SIGNATURE_TYPE=event \
  --env GOOGLE_FUNCTION_TARGET=helloPubSub \
  my-function

    Python 

    pack build \
  --builder gcr.io/buildpacks/builder:v1 \
  --env GOOGLE_FUNCTION_SIGNATURE_TYPE=event \
  --env GOOGLE_FUNCTION_TARGET=subscribe \
  my-function

    Go 

    pack build \
  --builder gcr.io/buildpacks/builder:v1 \
  --env GOOGLE_FUNCTION_SIGNATURE_TYPE=event \
  --env GOOGLE_FUNCTION_TARGET=HelloPubSub \
  my-function

    在端口 8080 上启动 Pub/Sub 函数。模拟器会将推送消息发送到这里：

    docker run --rm -p 8080:8080 my-function

  5. 在第二个终端中，通过发布一条消息来调用该函数。消息数据需要采用 base64 编码。此示例使用 base64 编码的字符串 {"foo":"bar"}。

    curl -s -X POST 'http://localhost:8043/v1/projects/abc/topics/mytopic:publish' \
    -H 'Content-Type: application/json' \
    --data '{"messages":[{"data":"eyJmb28iOiJiYXIifQ=="}]}'

    您应该会在第三个终端中看到函数输出。

    按 Ctrl+C 即可取消。