直接调用 Cloud Functions 函数

为了支持快速迭代和调试,Cloud Functions 在命令行界面中提供了一个 call 命令,并在 Google Cloud 控制台界面中提供了测试功能。这样,您就可以直接调用函数,确保其行为符合预期。在这种情况下,函数会立即执行,即使它可能是为响应特定事件而部署的也是如此。

使用 Google Cloud CLI 测试您的函数

第 1 代

要使用 gcloud CLI 直接调用第 1 代函数,请使用 gcloud functions call 命令并在 --data 参数中以 JSON 格式提供函数所需的任何数据。例如:

gcloud functions call YOUR_FUNCTION_NAME --data '{"name":"Tristan"}'

其中,YOUR_FUNCTION_NAME 是您要执行的函数的名称。--data 是发送给您的函数的参数,如下所示:

  • 对于 HTTP 函数,您提供的数据将以 POST 请求正文的形式发送。
  • 对于后台函数,数据将以事件数据形式直接传递给您的函数。 如需详细了解如何在后台函数中访问事件数据,请参阅后台函数参数
  • 对于 CloudEvent 函数,数据将以事件数据形式直接传递给您的函数。如需详细了解如何在 CloudEvent 函数中访问事件数据,请参阅 CloudEvent 函数参数

第 2 代

如需使用 gcloud CLI 直接调用第 2 代函数,请使用 gcloud functions call 的第 2 代版本,并在 --data 参数中以 JSON 格式提供函数所需的任何数据。例如:

gcloud functions call YOUR_FUNCTION_NAME \
  --region=REGION --gen2 \
  --data '{"name":"Kalani"}'

您需要将其中的:

  • YOUR_FUNCTION_NAME:您要测试的函数的名称
  • REGION:将您的函数部署到的 Google Cloud 区域

--data 是发送给您的函数的参数,如下所示:

  • 对于 HTTP 函数,您提供的数据将以 POST 请求正文的形式发送。
  • 对于 CloudEvent 函数,数据将以事件数据形式直接传递给您的函数。如需详细了解如何在 CloudEvent 函数中访问事件数据,请参阅 CloudEvent 函数参数

如需了解详情,请参阅 gcloud functions call 文档。

使用 Google Cloud Console 测试您的函数

如需通过 Google Cloud 控制台直接调用函数,请按以下步骤操作:

第 1 代

  1. 打开 Cloud Functions 概览页面

  2. 点击要调用的函数的名称。

  3. 点击测试标签。

  4. 配置触发事件字段中,以 JSON 格式输入函数所需的任何数据。

  5. 点击测试函数

函数的响应显示在输出字段中,单项执行的日志显示在日志字段中。

第 2 代

  1. 打开 Cloud Functions 概览页面

  2. 从列表中点击要调用的函数的名称。 此时将转到函数详情 (Function details) 页面。

  3. 点击测试标签。

  4. 配置触发事件字段中,以 JSON 格式输入函数所需的任何数据。

  5. 点击 +添加查询参数+添加标头参数按钮,根据需要向函数调用添加查询和标头参数。

    Google Cloud 控制台会将您指定的参数汇编到 CLI 测试命令窗口中的 gcloud functions call 命令。

  6. 选择在 Cloud Shell 中运行,以打开 Cloud Shell 窗口来运行此命令。

  7. 在 Cloud Shell 窗口中显示的 gcloud functions call 命令触发后按 Enter 键。

Cloud Pub/Sub 事件驱动的函数示例

本示例演示了如何直接调用由 Cloud Pub/Sub 事件触发的第 1 代事件驱动函数:

Node.js

/**
 * 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

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 `@type` field maps to
                         `type.googleapis.com/google.pubsub.v1.PubsubMessage`.
                        The `data` field maps to the PubsubMessage data
                        in a base64-encoded string. The `attributes` field maps
                        to the PubsubMessage attributes if any is present.
         context (google.cloud.functions.Context): Metadata of triggering event
                        including `event_id` which maps to the PubsubMessage
                        messageId, `timestamp` which maps to the PubsubMessage
                        publishTime, `event_type` which maps to
                        `google.pubsub.topic.publish`, and `resource` which is
                        a dictionary that describes the service API endpoint
                        pubsub.googleapis.com, the triggering topic's name, and
                        the triggering event type
                        `type.googleapis.com/google.pubsub.v1.PubsubMessage`.
    Returns:
        None. The output is written to Cloud Logging.
    """
    import base64

    print(
        """This Function was triggered by messageId {} published at {} to {}
    """.format(
            context.event_id, context.timestamp, context.resource["name"]
        )
    )

    if "data" in event:
        name = base64.b64decode(event["data"]).decode("utf-8")
    else:
        name = "World"
    print(f"Hello {name}!")

Go


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

import (
	"context"
	"log"
)

// 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 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


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#

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

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

PHP


use CloudEvents\V1\CloudEventInterface;
use Google\CloudFunctions\FunctionsFramework;

// Register the function with Functions Framework.
// This enables omitting the `FUNCTIONS_SIGNATURE_TYPE=cloudevent` environment
// variable when deploying. The `FUNCTION_TARGET` environment variable should
// match the first parameter.
FunctionsFramework::cloudEvent('helloworldPubsub', 'helloworldPubsub');

function helloworldPubsub(CloudEventInterface $event): void
{
    $log = fopen(getenv('LOGGER_OUTPUT') ?: 'php://stderr', 'wb');

    $cloudEventData = $event->getData();
    $pubSubData = base64_decode($cloudEventData['message']['data']);

    $name = $pubSubData ? htmlspecialchars($pubSubData) : 'World';
    fwrite($log, "Hello, $name!" . PHP_EOL);
}

如需直接调用该函数,请以事件数据的形式发送一条 PubsubMessage,该消息应为采用 base64 编码的数据:

Node.js

DATA=$(printf 'Hello!'|base64) && gcloud functions call helloPubSub --data '{"data":"'$DATA'"}'

Python

DATA=$(printf 'Hello!'|base64) && gcloud functions call hello_pubsub --data '{"data":"'$DATA'"}'

Go

DATA=$(printf 'Hello!'|base64) && gcloud functions call HelloPubSub --data '{"data":"'$DATA'"}'

Java

DATA=$(printf 'Hello!'|base64) && gcloud functions call java-hello-pubsub --data '{"data":"'$DATA'"}'

C#

DATA=$(printf 'Hello!'|base64) && gcloud functions call csharp-hello-pubsub --data '{"data":"'$DATA'"}'

Ruby

DATA=$(printf 'Hello!'|base64) && gcloud functions call hello_pubsub --data '{"data":"'$DATA'"}'

PHP

DATA=$(printf 'Hello!'|base64) && gcloud functions call helloworldPubsub --data '{"data":"'$DATA'"}'

此 CLI 示例使用 bashsh 语法。它适用于 Linux 和 Mac 环境,但不适用于 Windows。

您还可以在触发事件字段中使用相同的事件数据,从 Google Cloud 控制台调用该函数。