Firebase Data Connect 使用入门

在本快速入门中，您将学习如何在应用中构建 Firebase Data Connect。

  • 将 Firebase Data Connect 添加到您的 Firebase 项目。
  • 设置一个开发环境，其中包含一个 Visual Studio Code 扩展程序，以便与生产实例搭配使用。
  • 然后，我们将向您展示如何：
    • 为电影评论应用创建架构，并部署到生产环境。
    • 为架构定义查询和更改。
    • 生成强类型 SDK 并在应用中使用它们
    • 将最终架构、查询和数据部署到生产环境。

前提条件

如需在本地环境中使用本快速入门，您需要满足以下要求。

关联到您的 Firebase 项目

  1. 如果尚未创建，请创建一个 Firebase 项目。
    1. 在 Firebase 控制台中，点击添加项目，然后按照屏幕上的说明操作。
  2. 前往 Firebase 控制台的 Data Connect 部分，然后按照商品设置工作流程操作。

  3. 将您的项目升级到 Blaze 方案。这样，您就可以创建 Cloud SQL for PostgreSQL 实例了。

  4. 为 CloudSQL for PostgreSQL 数据库选择一个位置。

  5. 记下项目、服务和数据库的名称和 ID，以备日后确认。

  6. 按照其余设置流程操作，然后点击完成。

选择并设置开发环境

Data Connect 支持两种开发体验：

  • 如果您是 Kotlin Android、iOS、Flutter 或 Web 开发者，则可以使用 VS Code 开发在本地设计和测试架构和操作，同时连接到 Cloud SQL for PostgreSQL 实例。
  • 如果您是 Web 开发者，则可以使用 IDX Development 在 IDX 工作区中使用预配置的 IDX 模板（包含 PostgreSQL）、带有 Data Connect 模拟器的 VS Code 扩展程序以及为您设置的快速入门客户端代码进行原型设计。如需了解详情，请访问 Project IDX 网站。

本快速入门重点介绍 VS Code 扩展程序开发流程。请按以下步骤继续操作：

  1. 为您的本地项目创建一个新目录。
  2. 在新目录中打开 VS Code。

  3. 从 Visual Studio Code Marketplace 安装 Firebase Data Connect 扩展程序。

设置本地项目

按照常规说明安装 CLI。如果您已安装 npm，请运行以下命令：

npm install -g firebase-tools

设置项目目录

如需设置本地项目，请初始化项目目录。

在 VS Code 的左侧面板中，点击 Firebase 图标以打开 Firebase VS Code 扩展程序界面。

  1. 点击使用 Google 账号登录按钮。
  2. 点击关联 Firebase 项目按钮，然后在控制台中选择您之前创建的项目。
  3. 点击 Run firebase init 按钮。
  4. 如果您的项目采用的是 Blaze 方案，当系统提示“您想立即配置后端资源吗？”时，请回答“是”。

  5. 点击启动模拟器按钮。

创建架构

在 Firebase 项目目录的 /dataconnect/schema/schema.gql 文件中，开始定义包含电影的 GraphQL 架构。

电影

在 Data Connect 中，GraphQL 字段会映射到列。Movie 类型有 id、title、imageUrl 和 genre。Data Connect 可以识别基元数据类型 String 和 UUID。

复制以下代码段或取消注释文件中的相应行。

# File `/dataconnect/schema/schema.gql`

# By default, a UUID id key will be created by default as primary key.
type Movie @table {
  id: UUID! @default(expr: "uuidV4()")
  title: String!
  imageUrl: String!
  genre: String
}

MovieMetadata

现在，您已经有了电影，可以对电影元数据进行建模了。

复制以下代码段或取消注释文件中的相应行。

# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata @table {
  # This time, we omit adding a primary key because
  # you can rely on Data Connect to manage it.

  # @unique indicates a 1-1 relationship
  movie: Movie! @unique
  # movieId: UUID <- this is created by the above reference
  rating: Float
  releaseYear: Int
  description: String
}

请注意，movie 字段已映射到 Movie 类型。Data Connect 了解这是 Movie 与 MovieMetadata 之间的关系，并会为您管理这项关系。

在文档中详细了解 Data Connect 架构

将架构部署到生产环境

如果您使用 Firebase VS Code 扩展程序处理生产数据库，则需要先部署架构，然后才能继续操作。将架构部署到生产数据库后，您应该能够在控制台中查看该架构。

  1. 您可以使用 Data Connect VS Code 扩展程序进行部署。
    • 在扩展程序界面中，点击 Firebase Data Connect 面板下的部署到生产环境。
  2. 您可能需要审核架构更改并批准可能破坏性修改。系统会提示您执行以下操作：
    • 使用 firebase dataconnect:sql:diff 查看架构更改
    • 对更改感到满意后，请使用 firebase dataconnect:sql:migrate 启动的流程应用更改。

向表格添加数据

在 VS Code 编辑器面板中，您会看到 CodeLens 按钮显示在 /dataconnect/schema/schema.gql 中的 GraphQL 类型上方。由于您已将架构部署到生产环境，因此可以使用添加数据和运行（生产环境）按钮向后端的数据库添加数据。

如需向 Movie 表添加记录，请执行以下操作：

  1. 在 schema.gql 中，点击 Movie 类型声明上方的添加数据按钮。
    Firebase Data Connect 的 Code Lens“添加数据”按钮
  2. 在生成的 Movie_insert.gql 文件中，为这四个字段硬编码数据。
  3. 点击运行（生产环境）按钮。
    Firebase Data Connect 的 Code Lens“Run”按钮
  4. 重复上述步骤，将记录添加到 MovieMetadata 表中，在 movieId 字段中提供电影的 id，如生成的 MovieMetadata_insert 更改中所提示。

如需快速验证是否添加了数据，请执行以下操作：

  1. 返回 schema.gql，点击 Movie 类型声明上方的读取数据按钮。
  2. 在生成的 Movie_read.gql 文件中，点击 Run (Production) 按钮以执行查询。

参阅文档详细了解 Data Connect 更改

定义查询

现在进入有趣的部分，查询。作为开发者，您可能习惯编写 SQL 查询，而不是 GraphQL 查询，因此这在开始时可能会感觉有些不同。不过，与原始 SQL 相比，GraphQL 要简洁得多，并且具有类型安全性。我们的 VS Code 扩展程序可简化开发体验。

开始修改 /dataconnect/connector/queries.gql 文件。如果您想获取所有电影，请使用如下查询。

# File `/dataconnect/connector/queries.gql`

# @auth() directives control who can call each operation.
# Anyone should be able to list all movies, so the auth level
# is set to PUBLIC
query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
  }
}

使用附近的 CodeLens 按钮执行查询。

参阅文档，详细了解 Data Connect 查询

生成 SDK 并在应用中使用

  1. 点击将 SDK 添加到应用按钮。

  2. 在随即显示的对话框中，选择包含应用代码的目录。Data ConnectSDK 代码将生成并保存在此处。

  3. 选择您的应用平台，然后请注意，SDK 代码会立即在您选择的目录中生成。

了解如何使用生成的 SDK 从客户端应用（Web、Android、iOS、Flutter）调用查询和更改。

将架构和查询部署到生产环境

您已完成一个开发迭代。现在，您可以使用 Firebase 扩展程序界面或 Firebase CLI 将架构、数据和查询部署到服务器，就像部署架构一样。

如果您使用 Firebase VS Code 扩展程序进行部署，请点击部署到生产环境按钮。

部署完成后，请前往 Firebase 控制台，验证架构、操作和数据是否已上传到云端。您应该能够查看架构，并在控制台中运行操作。Cloud SQL for PostgreSQL 实例将更新为最终部署的生成架构和数据。

在文档中详细了解如何使用 Data Connect 模拟器

后续步骤

查看已部署的项目并探索更多工具：

  • 在 Firebase 控制台中向数据库添加数据、检查和修改架构，以及监控 Data Connect 服务。如需了解详情，请参阅相关文档。例如，由于您已完成快速入门，因此：

  • 详细了解架构、查询和更改开发

  • 了解如何为 Web、Android、iOS 和 Flutter 生成客户端 SDK，以及如何从客户端代码调用查询和更改。