此页面由 Cloud Translation API 翻译。

使用 SMT 创建主题

本文档介绍了如何使用单个消息转换 (SMT) 创建 Pub/Sub 主题。

借助主题 SMT，您可以直接在 Pub/Sub 中对消息数据和属性进行轻量级修改。借助此功能，您可以在消息发布到主题之前进行数据清理、过滤或格式转换。

如需创建包含 SMT 的主题，您可以使用 Google Cloud 控制台、Google Cloud CLI、客户端库或 Pub/Sub API。

准备工作

了解 Pub/Sub 服务及其术语。
了解 SMT。

所需的角色和权限

如需获得使用 SMT 创建主题所需的权限，请让您的管理员为您授予项目的 Pub/Sub Editor (roles/pubsub.editor) IAM 角色。如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

此预定义角色包含使用 SMT 创建主题所需的权限。如需查看所需的确切权限，请展开所需权限部分：

所需权限

若要创建包含 SMT 的主题，您需要具备以下权限：

向项目授予创建主题权限： pubsub.topics.create

您也可以使用自定义角色或其他预定义角色来获取这些权限。

您可以在项目级别和各个资源级别配置访问权限控制。

使用 SMT 创建主题

在使用 SMT 创建主题之前，请先查看主题的属性文档。

以下示例假设您想使用此用户定义的函数 (UDF) SMT 创建主题。如需详细了解 UDF，请参阅 UDF 概览。

function redactSSN(message, metadata) {
  const data = JSON.parse(message.data);
  delete data['ssn'];
  message.data = JSON.stringify(data);
  return message;
}

控制台

在 Google Cloud 控制台中，前往 Pub/Sub 主题页面。

转到“主题”
点击创建主题。

系统随即会打开创建主题页面。
在主题 ID 字段中，输入主题 ID。如需详细了解如何命名主题，请参阅命名准则。
在转换下，点击添加转换。
输入函数名称。例如：redactSSN。
如果您不想立即对主题使用 SMT，请点击停用转换选项。这样仍然会保存 SMT，但当消息流经您的主题时，系统不会执行该 SMT。

输入新的转换。例如：

function redactSSN(message, metadata) {
  const data = JSON.parse(message.data);
  delete data['ssn'];
  message.data = JSON.stringify(data);
  return message;
}

Pub/Sub 提供了一个验证函数，可用于验证 SMT。点击验证以验证转换。
如果您想添加其他转换，请点击添加转换。
如需按特定顺序排列所有 SMT，您可以使用向上箭头和向下箭头。如需移除 SMT，请点击“删除”按钮。
Pub/Sub 提供了一个测试函数，可让您检查对示例消息运行 SMT 的结果。如需测试 SMT，请点击测试转换。
在 Test transform 窗口中，选择要测试的函数。
在输入消息窗口中，输入示例消息。
如果您想添加消息属性，请点击添加属性，然后输入一个或多个键值对。
点击测试。系统会显示对消息应用 SMT 的结果。
关闭该窗口可停止对示例邮件测试 SMT。
点击创建以创建主题。

gcloud

In the Google Cloud console, activate Cloud Shell.

Activate Cloud Shell

At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

Pub/Sub 提供了一个验证函数，可用于验证 SMT。运行 gcloud pubsub message-transforms validate 命令：

gcloud pubsub message-transforms validate --message-transform-file=TRANSFORM_FILE

替换以下内容：

TRANSFORM_FILE：包含单个 SMT 的 YAML 或 JSON 文件的路径。

下面是一个 YAML 转换文件示例：

javascriptUdf:
    code: >
        function redactSSN(message, metadata) {
          const data = JSON.parse(message.data);
          delete data['ssn'];
          message.data = JSON.stringify(data);
          return message;
        }
    functionName: redactSSN

Pub/Sub 提供了一个测试函数，可让您检查对示例消息运行一个或多个 SMT 的结果。运行 gcloud pubsub message-transforms test 命令：

gcloud pubsub message-transforms test --message-transforms-file=TRANSFORMS_FILE

替换以下内容：

TRANSFORMS_FILE：包含一个或多个 SMT 的 YAML 或 JSON 文件的路径。

下面是一个 YAML 转换文件示例：

- javascriptUdf:
    code: >
        function redactSSN(message, metadata) {
          const data = JSON.parse(message.data);
          delete data['ssn'];
          message.data = JSON.stringify(data);
          return message;
        }
    functionName: redactSSN

如需创建主题，请运行 gcloud pubsub topics create 命令：

gcloud pubsub topics create TOPIC_ID \
 --message-transforms-file=TRANSFORMS_FILE

请替换以下内容：

TOPIC_ID：您要创建的主题的 ID 或名称。如需有关如何命名主题的准则，请参阅资源名称。主题的名称不可更改。

TRANSFORMS_FILE：包含一个或多个 SMT 的 YAML 或 JSON 文件的路径。

下面是一个 YAML 转换文件示例：

- javascriptUdf:
    code: >
        function redactSSN(message, metadata) {
          const data = JSON.parse(message.data);
          delete data['ssn'];
          message.data = JSON.stringify(data);
          return message;
        }
    functionName: redactSSN

Java

在尝试此示例之前，请按照 Pub/Sub 快速入门：使用客户端库中的 Java 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Java API 参考文档。

如需向 Pub/Sub 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。


import com.google.api.gax.rpc.AlreadyExistsException;
import com.google.cloud.pubsub.v1.TopicAdminClient;
import com.google.pubsub.v1.JavaScriptUDF;
import com.google.pubsub.v1.MessageTransform;
import com.google.pubsub.v1.Topic;
import com.google.pubsub.v1.TopicName;
import java.io.IOException;

public class CreateTopicWithSmtExample {

  public static void main(String... args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "your-project-id";
    String topicId = "your-topic-id";

    createTopicWithSmtExample(projectId, topicId);
  }

  public static void createTopicWithSmtExample(String projectId, String topicId)
      throws IOException {
    TopicName topicName = TopicName.of(projectId, topicId);

    // UDF that removes the 'ssn' field, if present
    String code =
        "function redactSSN(message, metadata) {"
            + "  const data = JSON.parse(message.data);"
            + "  delete data['ssn'];"
            + "  message.data = JSON.stringify(data);"
            + "  return message;"
            + "}";
    String functionName = "redactSSN";

    JavaScriptUDF udf =
        JavaScriptUDF.newBuilder().setCode(code).setFunctionName(functionName).build();
    MessageTransform transform = MessageTransform.newBuilder().setJavascriptUdf(udf).build();
    try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {

      Topic topic =
          topicAdminClient.createTopic(
              Topic.newBuilder()
                  .setName(topicName.toString())
                  // Add the UDF message transform
                  .addMessageTransforms(transform)
                  .build());

      System.out.println("Created topic with SMT: " + topic.getName());
    } catch (AlreadyExistsException e) {
      System.out.println(topicName + "already exists.");
    }
  }
}

Python

在尝试此示例之前，请按照 Pub/Sub 快速入门：使用客户端库中的 Python 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Python API 参考文档。

如需向 Pub/Sub 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。

from google.cloud import pubsub_v1
from google.pubsub_v1.types import JavaScriptUDF, MessageTransform, Topic

# TODO(developer)
# project_id = "your-project-id"
# topic_id = "your-topic-id"

code = """function redactSSN(message, metadata) {
            const data = JSON.parse(message.data);
            delete data['ssn'];
            message.data = JSON.stringify(data);
            return message;
            }"""
udf = JavaScriptUDF(code=code, function_name="redactSSN")
transforms = [MessageTransform(javascript_udf=udf)]

publisher = pubsub_v1.PublisherClient()
topic_path = publisher.topic_path(project_id, topic_id)

request = Topic(name=topic_path, message_transforms=transforms)

topic = publisher.create_topic(request=request)

print(f"Created topic: {topic.name} with SMT")

Go

在尝试此示例之前，请按照 Pub/Sub 快速入门：使用客户端库中的 Go 设置说明进行操作。如需了解详情，请参阅 Pub/Sub Go API 参考文档。

如需向 Pub/Sub 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。

// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package topics

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/pubsub"
)

// createTopicWithSMT creates a topic with a single message transform function applied.
func createTopicWithSMT(w io.Writer, projectID, topicID string) error {
	// projectID := "my-project-id"
	// topicID := "my-topic"
	ctx := context.Background()
	client, err := pubsub.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("pubsub.NewClient: %w", err)
	}
	defer client.Close()

	code := `function redactSSN(message, metadata) {
			const data = JSON.parse(message.data);
			delete data['ssn'];
			message.data = JSON.stringify(data);
			return message;
		}`
	transform := pubsub.MessageTransform{
		Transform: pubsub.JavaScriptUDF{
			FunctionName: "redactSSN",
			Code:         code,
		},
	}
	cfg := &pubsub.TopicConfig{
		MessageTransforms: []pubsub.MessageTransform{transform},
	}
	t, err := client.CreateTopicWithConfig(ctx, topicID, cfg)
	if err != nil {
		return fmt.Errorf("CreateTopic: %w", err)
	}

	fmt.Fprintf(w, "Created topic with message transform: %v\n", t)
	return nil
}

使用 SMT 创建主题 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

准备工作

所需的角色和权限

所需权限

使用 SMT 创建主题

控制台

gcloud

Java

Python

Go

后续步骤

使用 SMT 创建主题