使用 Cloud Functions (第 2 代) 扩展 Datastore

借助 Cloud Functions 和 Eventarc，您可以部署代码来处理由 Datastore 模式 Firestore 数据库中的更改触发的事件。这样，您无需运行自己的服务器即可添加服务器端功能。

Datastore 模式触发器

Eventarc 支持以下 Datastore 模式 Firestore 事件触发器，让您能够创建与 Datastore 模式 Firestore 事件关联的 Cloud Functions (第 2 代)处理程序：

事件类型	触发器
`google.cloud.datastore.entity.v1.created`	首次写入实体时触发。
`google.cloud.datastore.entity.v1.updated`	当某个实体已存在且其任何值发生更改时触发。
`google.cloud.datastore.entity.v1.deleted`	当有实体被删除时触发。
`google.cloud.datastore.entity.v1.written`	在触发 `created`、`updated` 或 `deleted` 时触发。
`google.cloud.datastore.entity.v1.created.withAuthContext`	与 `created` 相同，但会添加身份验证信息。
`google.cloud.datastore.entity.v1.updated.withAuthContext`	与 `updated` 相同，但会添加身份验证信息。
`google.cloud.datastore.entity.v1.deleted.withAuthContext`	与 `deleted` 相同，但会添加身份验证信息。
`google.cloud.datastore.entity.v1.written.withAuthContext`	与 `written` 相同，但会添加身份验证信息。

Datastore 模式事件触发器仅响应实体更改。对数据未更改的 Datastore 模式实体的更新（无操作写入）不会生成更新或写入事件。您不能仅针对特定媒体资源生成事件。

在事件中包含身份验证上下文

如需添加有关事件的其他身份验证信息，请使用扩展名为 withAuthContext 的事件触发器。此扩展程序会添加有关触发事件的主帐号的其他信息。除了在基本事件中返回的信息之外，它还会添加 authtype 和 authid 属性。如需详细了解属性值，请参阅 authcontext 参考文档。

编写一个实体触发的函数

如需编写一个函数来响应 Datastore 模式 Firestore 事件，请准备在部署期间指定以下内容：

触发器事件类型
用于选择与函数关联的实体的触发器事件过滤条件
要运行的函数代码

触发器事件过滤条件

指定事件过滤条件时，可以指定完全匹配的实体或路径模式。使用路径模式可以通过通配符 * 或 ** 来匹配多个实体。

例如，您可以指定完全匹配的实体以响应对以下实体的更改：

users/marie

使用通配符 * 或 ** 来响应与模式匹配的实体更改。* 通配符匹配单个段，** 多段通配符匹配模式中的零个或多个段。

对于单个片段匹配 (*)，您还可以使用已命名的捕获组，例如 users/{userId}。

下表演示了有效的路径模式：

模式	说明
`users/*` 或 `users/{userId}`	匹配种类为 `users` 的所有实体。与后代实体级别不匹配，例如 `/users/marie/messages/33e2IxYBD9enzS50SJ68`
`users/**`	匹配 `users` 种类的所有实体和 `/users/marie/messages/33e2IxYBD9enzS50SJ68` 等所有后代实体

如需详细了解路径模式，请参阅 Eventarc 路径模式。

即使您使用的是通配符，触发器也必须始终指向某个实体。请参见以下示例：

users/{userId=*}/{messages=*} 无效，因为 {messages=*} 是种类 ID。
users/{userId=*}/{messages}/{messageId=*} 是有效的，因为 {messageId=*} 始终指向某个实体。

字符转义

本部分介绍了要求您对种类 ID 和实体 ID 中的字符进行转义的情况。对字符进行转义可使事件过滤器正确解读 ID。

如果种类 ID 或实体 ID 包含 ~ 或 / 字符，则必须在事件过滤器中对该 ID 进行转义。如需对某个 ID 进行转义，请使用以下格式：__escENCODED_ID__。将 ENCODED_ID 替换为种类 ID 或实体 ID，并将所有 ~ 和 / 字符替换为其编码 ID，如下所示：
- ~：~0
- /：~1
例如，种类 ID user/profile 会变为 __escusers~1profile__。具有此种类 ID 的示例路径模式是 __escusers~1profile__/{userId}
如果您在事件过滤器中使用了 . 或 .. 的种类 ID 或实体 ID，则必须按如下方式对该 ID 进行转义：
- .：__esc~2__
- ..：__esc~2~2__
仅当 ID 正好为 . 或 .. 时，才需要转义 . 字符。例如，种类 ID customers.info 不需要转义。
如果您的种类或实体 ID 是数值而不是字符串值，您必须使用 __idNUMERIC_VALUE__ 来转义该 ID。例如，种类为 111 且实体 ID 为 222 的实体的路径模式为 __id111__/__id222__。
如果您从旧版 Cloud Datastore 迁移到 Datastore 模式 Firestore，则您的数据库可能包含采用非 UTF8 编码的旧版 ID。您必须使用 __bytesBASE64_ENCODING__ 对这些 ID 进行转义。将 BASE64_ENCODING 替换为 ID 的 base-64 编码。例如，针对非 UTF8 种类 ID Task 进行转义的路径模式 Task/{task} 会变为 __bytesVGFzaw==__/{task}。

函数示例

以下示例演示了如何接收 Datastore 模式事件。如需处理事件中涉及的数据，请查看 value 和 old_value 字段。

value：包含操作后实体快照的 EntityResult 对象。对于删除事件，不会填充此字段。
old_value：包含操作前实体快照的 EntityResult 对象。系统仅会针对更新和删除事件填充此字段。

Java

如需了解如何安装和使用 Datastore 模式客户端库，请参阅 Datastore 模式客户端库。如需了解详情，请参阅 Datastore 模式 Java API 参考文档。

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

import com.google.cloud.functions.CloudEventsFunction;
import com.google.events.cloud.datastore.v1.EntityEventData;
import com.google.protobuf.InvalidProtocolBufferException;
import io.cloudevents.CloudEvent;
import java.util.logging.Logger;

public class Datastore implements CloudEventsFunction {
  private static final Logger logger = Logger.getLogger(Datastore.class.getName());

  @Override
  public void accept(CloudEvent event) throws InvalidProtocolBufferException {
    EntityEventData datastoreEventData = EntityEventData.parseFrom(event.getData().toBytes());

    logger.info("Function triggered by event on: " + event.getSource());
    logger.info("Event type: " + event.getType());

    logger.info("Old value:");
    logger.info(datastoreEventData.getOldValue().toString());

    logger.info("New value:");
    logger.info(datastoreEventData.getValue().toString());
  }
}

在源代码中添加 proto 依赖项

您必须在函数源目录中添加 Datastore 模式 data.proto 文件。此文件会导入以下 proto，您还必须将这些 proto 添加到源目录中：

请为依赖项使用相同的目录结构。例如，将 struct.proto 放置在 google/protobuf 中。

这些文件是解码事件数据所必需的。如果您的函数来源不包含这些文件，则会在运行时返回错误。

事件属性

每个事件都包含数据属性，数据属性包含事件的相关信息，例如事件触发时间。Datastore 模式 Firestore 会添加有关事件中涉及的数据库和实体的额外数据。您可以按如下方式访问这些属性：

Java

logger.info("Event time " + event.getTime());
logger.info("Event project: " + event.getExtension("project"));
logger.info("Event location: " + event.getExtension("location"));
logger.info("Database name: " + event.getExtension("database"));
logger.info("Database namespace: " + event.getExtension("namespace"));
logger.info("Database entity: " + event.getExtension("entity"));
// For withAuthContext events
logger.info("Auth information: " + event.getExtension("authid"));
logger.info("Auth information: " + event.getExtension("authtype"));

部署函数

部署 Cloud Functions 的用户必须具有 Cloud Functions Developer IAM 角色或具有提供相同权限的其他角色。另请参阅其他部署配置。

您可以使用 gcloud CLI 或 Google Cloud 控制台部署函数。下面的示例演示了如何使用 gcloud CLI 进行部署。如需详细了解如何使用 Google Cloud 控制台进行部署，请参阅部署 Cloud Functions 函数。

在 Google Cloud 控制台中，激活 Cloud Shell。

激活 Cloud Shell

Cloud Shell 会话随即会在 Google Cloud 控制台的底部启动，并显示命令行提示符。Cloud Shell 是一个已安装 Google Cloud CLI 且已为当前项目设置值的 Shell 环境。该会话可能需要几秒钟时间来完成初始化。
使用 gcloud functions deploy 命令部署函数：
```
gcloud functions deploy FUNCTION_NAME \
--gen2 \
--region=FUNCTION_LOCATION \
--trigger-location=TRIGGER_LOCATION \
--runtime=RUNTIME \
--source=SOURCE_LOCATION \
--entry-point=CODE_ENTRYPOINT \
--trigger-event-filters="type=EVENT_FILTER_TYPE" \
--trigger-event-filters="database=DATABASE" \
--trigger-event-filters="namespace=NAMESPACE" \
--trigger-event-filters-path-pattern="entity=ENTITY_OR_PATH" \
```
第一个参数 FUNCTION_NAME 是已部署函数的名称。函数名称必须以字母开头，后面最多可跟 62 个字母、数字、连字符或下划线，但必须以字母或数字结尾。将 FUNCTION_NAME 替换为有效的函数名称。然后，添加以下标志：
- --gen2 标志用于指定要部署到 Cloud Functions (第 2 代)。省略此标志会导致部署到 Cloud Functions（第 1 代）。
- --region=FUNCTION_LOCATION 标志指定要部署函数的区域。
  
  为了最大限度增加邻近性，请将 FUNCTION_LOCATION 设置为 Firestore 数据库附近的一个区域。如果您的 Firestore 数据库位于多区域位置，对于位于 nam5 的数据库，请将该值设置为 us-central1；对于位于 eur3 的数据库，请将该值设置为 europe-west4。对于区域级 Firestore 位置，请设置为同一区域。
- --trigger-location=TRIGGER_LOCATION 标志指定触发器的位置。您必须将 TRIGGER_LOCATION 设置为 Datastore 模式数据库的位置。
- --runtime=RUNTIME 标志指定函数使用的语言运行时。Cloud Functions 支持多个运行时。如需了解详情，请参阅运行时。将 RUNTIME 设置为支持的运行时。
- --source=SOURCE_LOCATION 标志用于指定函数源代码的位置。如需了解详情，请参阅以下内容：
  将 SOURCE_LOCATION 设置为函数源代码的位置。
- --entry-point=CODE_ENTRYPOINT 标志指定源代码中函数的入口点。这是您的函数在运行时执行的代码。您必须将 CODE_ENTRYPOINT 设置为源代码中存在的函数名称或完全限定类名称。如需了解详情，请参阅函数入口点。
- --trigger-event-filters 标志用于定义事件过滤器，其中包括触发器类型和触发事件的实体或路径。设置以下属性值以定义事件过滤器：
  - type=EVENT_FILTER_TYPE：Firestore 支持以下事件类型：
    - google.cloud.datastore.entity.v1.created：首次写入实体时发送事件。
    - google.cloud.datastore.entity.v1.updated：当某个实体已存在并且其值发生了更改时，系统会发送事件。
    - google.cloud.datastore.entity.v1.deleted：删除实体时发送事件。
    - google.cloud.datastore.entity.v1.written：当创建、更新或删除实体时，系统会发送事件。
    - google.cloud.datastore.entity.v1.created.withAuthContext：当首次向某个文档写入数据时发送事件，并且该事件包含额外的身份验证信息
    - google.cloud.datastore.entity.v1.updated.withAuthContext：当某个文档已存在并且其值发生了更改时发送事件。包含额外的身份验证信息
    - google.cloud.datastore.entity.v1.deleted.withAuthContext：当某个文档被删除时，系统会发送该事件。包含额外的身份验证信息
    - google.cloud.datastore.entity.v1.written.withAuthContext：当创建、更新或删除文档时发送事件。包含额外的身份验证信息
    将 EVENT_FILTER_TYPE 设置为其中一种事件类型。
  - database=DATABASE：Firestore 数据库。对于默认数据库名称，将 DATABASE 设置为 (default)。
  - namespace=NAMESPACE：数据库命名空间。对于默认数据库名称，请将 NAMESPACE 设置为 (default)。移除该标志以匹配任何命名空间。
    
    注意：请将默认命名空间完全设置为 (default)。这是仅用于 Eventarc 的非规范资源名称。请勿按照 Google Cloud 控制台中所示设置为 [default]。
  - entity=ENTITY_OR_PATH：在创建、更新或删除数据时触发事件的数据库路径。ENTITY_OR_PATH 接受的值为：
    - 等于；例如 --trigger-event-filters="entity='users/marie'"。
    - 路径模式；例如 --trigger-event-filters-path-pattern="entity='users/*'"。如需了解详情，请参阅了解路径模式。
  您可以视需要在部署函数时指定其他配置、网络和安全选项。
  
  如需查看有关部署命令及其标志的完整参考信息，请参阅 gcloud functions deploy 文档。

部署示例

以下示例演示了如何使用 Google Cloud CLI 进行部署。

在 us-west2 区域中为数据库部署一个函数：

gcloud functions deploy gcfv2-trigger-datastore-node \
--gen2 \
--region=us-west2 \
--trigger-location=us-west2 \
--runtime=nodejs18 \
--source=gs://example_bucket-1/datastoreEventFunction.zip \
--entry-point=makeUpperCase \
--trigger-event-filters=type=google.cloud.datastore.entity.v1.written \
--trigger-event-filters=database='(default)' \
--trigger-event-filters-path-pattern="entity='messages/{pushId}'"

在 nam5 多区域位置为数据库部署函数：

gcloud functions deploy gcfv2-trigger-datastore-python \
--gen2 \
--region=us-central1 \
--trigger-location=nam5 \
--runtime=python311 \
--source=gs://example_bucket-1/datastoreEventFunction.zip \
--entry-point=make_upper_case \
--trigger-event-filters=type=google.cloud.datastore.entity.v1.written.withAuthContext \
--trigger-event-filters=database='(default)' \
--trigger-event-filters-path-pattern="entity='messages/{pushId}'"

限制

请注意适用于 Cloud Functions 的 Firestore 触发器的以下限制：

无法保证顺序。快速更改可能会以意想不到的顺序触发函数调用。
事件至少会被传送一次，但单个事件可能会导致多次调用函数。应该避免依赖“正好一次”机制，并编写幂等函数。
Datastore 模式 Firestore 需要 Cloud Functions（第 2 代）。Cloud Functions（第 1 代）不支持 Datastore 模式。
Cloud Functions (第 1 代) 仅适用于“（默认）”数据库，不支持 Firestore 命名数据库。请使用 Cloud Functions (第 2 代) 为命名数据库配置事件。
一个触发器与单一数据库相关联。您无法创建与多个数据库匹配的触发器。
删除数据库不会自动删除该数据库的任何触发器。触发器会停止传送事件，但会继续存在，直到您删除触发器。
如果匹配的事件超过请求大小上限，该事件可能不会传送到 Cloud Functions (第 1 代)。
- 因请求大小而未传送的事件会记录在平台日志中，并计入项目的日志使用量。
- 您可以在 Logs Explorer 中找到这些日志，其严重性为 error 且内容为“由于大小超出第 1 代的限制，因此事件无法传送到 Cloud Functions 函数”消息。您可以在 functionName 字段下方找到函数名称。如果 receiveTimestamp 字段仍在从现在起的一小时内，您可以利用该时间戳之前和之后的快照来读取相关文档，从而推断实际事件内容。
- 为避免这种情况发生，您可以：
  - 迁移和升级到 Cloud Functions (第 2 代)
  - 缩小文档
  - 删除相关的 Cloud Functions 函数
- 您可以使用排除功能关闭日志记录功能本身，但请注意，违规事件仍然不会传送。

Eventarc 和 Datastore 模式 Firestore 位置

Eventarc 不支持多区域位置的 Firestore 事件触发器，但您仍然可以为多区域位置的 Firestore 数据库创建触发器。Eventarc 会将 Firestore 多区域位置映射到以下 Eventarc 区域：

Firestore 多区域	Eventarc 区域
`nam5`	`us-central1`
`eur3`	`europe-west4`

后续步骤

了解事件驱动型架构。
请参阅 Datastore 模式的代码示例。