AngularFire Web Codelab

1. 概览

在此 Codelab 中，您将学习如何使用 AngularFire 通过使用 Firebase 产品和服务实现和部署聊天客户端来创建 Web 应用。

学习内容

• 使用 Angular 和 Firebase 构建 Web 应用。
• 使用 Cloud Firestore 和 Cloud Storage for Firebase 同步数据。
• 使用 Firebase Authentication 对您的用户进行身份验证。
• 在 Firebase App Hosting 上部署您的 Web 应用。
• 使用 Firebase Cloud Messaging 发送通知。
• 收集您的 Web 应用的性能数据。

所需条件

• GitHub 帐号
• 能够将 Firebase 项目升级为 Blaze 定价方案
• 您选择的 IDE/文本编辑器，例如 WebStorm、Sublime 或 VS Code
• 软件包管理器 npm（通常随 Node.js 一起提供）
• 终端/控制台
• 您选择的浏览器（例如 Chrome）
• 此 Codelab 的示例代码（请参阅此 Codelab 的下一步，了解如何获取代码。）

2. 获取示例代码

创建一个 GitHub 代码库。

此 Codelab 的源代码位于 https://github.com/firebase/codelab-friendlychat-web 上。该代码库包含适用于多个平台的示例项目。不过，此 Codelab 仅使用 angularfire-start 目录。

将 angularfire-start 文件夹复制到您自己的代码库中：

1. 使用终端在计算机上创建一个新文件夹，然后切换到新目录：

   mkdir codelab-friendlyeats-web
   
   cd codelab-friendlyeats-web
   

2. 使用 giget npm 软件包仅提取 angularfire-start 文件夹：

   npx giget@latest gh:firebase/codelab-friendlychat-web/angularfire-start#master . --install
   

3. 使用 git 在本地跟踪更改：

   git init
   
   git add .
   
   git commit -m "codelab starting point"
   
   git branch -M main
   

4. 创建新的 GitHub 代码库：https://github.com/new。您可以随意为其命名。
   1. GitHub 将为您提供一个类似于 https://github.com/[user-name]/[repository-name].git 或 [e-mail]:[user-name]/[repository-name].git 的新代码库网址。复制此网址。
5. 将本地更改推送到新的 GitHub 代码库。运行以下命令，并将 your-repository-url 占位符替换为您的代码库网址。

   git remote add origin your-repository-url
   
   git push -u origin main
   

6. 现在，您应该会在 GitHub 代码库中看到起始代码。

3. 创建和设置 Firebase 项目

创建 Firebase 项目

1. 登录 Firebase 控制台。
2. 在 Firebase 控制台中，点击添加项目，然后将您的 Firebase 项目命名为 RelationChat。记住 Firebase 项目的 ID。
3. 取消选中为此项目启用 Google Analytics（分析）
4. 点击创建项目。

重要提示：您的 Firebase 项目将命名为 RelationChat，但 Firebase 会自动为其分配一个唯一的项目 ID，格式为 friendchat-1234。此唯一标识符用于识别项目（包括在 CLI 中识别），而 FreeChat 只是一个显示名称。

您要构建的应用使用了适用于 Web 应用的 Firebase 产品：

• Firebase Authentication：可让用户轻松登录您的应用。
• Cloud Firestore：用于将结构化数据保存在云端，并在数据发生变化时获得即时通知。
• Cloud Storage for Firebase：可用于将文件保存到云端。
• Firebase 应用托管：用于构建、托管和提供应用。
• Firebase Cloud Messaging：用于发送推送通知并显示浏览器弹出式通知。
• Firebase Performance Monitoring 用于收集您的应用的用户性能数据。

其中部分产品需要进行特殊配置，或者需要使用 Firebase 控制台启用。

升级您的 Firebase 定价方案

如需使用 App Hosting，您的 Firebase 项目必须采用 Blaze 定价方案，这意味着该项目需要与一个 Cloud Billing 帐号相关联。

• Cloud Billing 账号要求提供付款方式，例如信用卡。
• 如果您刚开始接触 Firebase 和 Google Cloud，请确认您是否有资格获得 $300 赠金和免费试用 Cloud Billing 账号。

如需将项目升级到 Blaze 方案，请按以下步骤操作：

1. 在 Firebase 控制台中，选择升级您的方案。
2. 在对话框中，选择 Blaze 方案，然后按照屏幕上的说明将您的项目与 Cloud Billing 账号相关联。
   如果您需要创建 Cloud Billing 账号，则可能需要返回 Firebase 控制台中的升级流程以完成升级。

注意：完成此 Codelab 后，您可以将项目降级为 Spark。

将 Firebase Web 应用添加到项目中

1. 点击 Web 图标 以创建新的 Firebase Web 应用。
2. 使用别名 Free Chat 注册应用。请勿选中同时为此应用设置 Firebase Hosting 旁边的复选框，而是点击注册应用。
3. 在下一步中，您将看到一个配置对象。您目前不需要它。点击继续前往控制台。

设置身份验证

如要允许用户使用其 Google 帐号登录 Web 应用，请使用 Google 登录方法。

1. 在 Firebase 控制台中，前往身份验证。
2. 点击开始使用。
3. 在其他提供商列中，点击 Google > 启用。
4. 在项目的公开名称文本框中，输入一个容易记住的名称，例如 My Next.js app。
5. 从项目的支持电子邮件地址下拉列表中，选择您的电子邮件地址。
6. 点击保存。

启用 Cloud Firestore

Web 应用使用 Cloud Firestore 保存聊天消息并接收新的聊天消息。

您需要启用 Cloud Firestore：

1. 在 Firebase 控制台中，前往 Firestore。
2. 依次点击创建数据库 > 下一步 > 以测试模式开始 > 下一步。
   在本 Codelab 的后面，您将添加安全规则来保护您的数据。在没有为数据库添加安全规则的情况下，请不要公开分发或公开应用。
3. 使用默认位置或选择您所选的位置。
   对于真实应用，您需要选择靠近用户的位置。请注意，此位置以后无法更改，并且它也会自动成为您的默认 Cloud Storage 存储桶的位置（下一步）。
4. 点击完成。

启用 Cloud Storage

Web 应用使用 Cloud Storage for Firebase 存储、上传和分享照片。

您需要启用 Cloud Storage：

1. 在 Firebase 控制台中，前往 Storage。
2. 依次点击开始使用 > 以测试模式开始 > 下一步。
   在此 Codelab 的后面部分，您将添加安全规则来保护您的数据。在未为您的存储桶添加安全规则的情况下，请不要公开分发或公开应用。
3. 您的存储桶的位置应该已经处于选中状态（由于在上一步中设置了 Firestore）。
4. 点击完成。

4.安装 Firebase 命令行界面

通过 Firebase 命令行界面 (CLI)，您可以使用 Firebase Hosting 在本地提供您的 Web 应用，以及将您的 Web 应用部署到 Firebase 项目。

注意：如需安装 CLI，您需要安装 Node.js 通常附带的 npm。

1. 通过运行以下 npm 命令来安装 CLI：

npm -g install firebase-tools@latest

不能运行？您可能需要更改 npm 权限。

2. 通过运行以下命令来验证 CLI 是否已正确安装：

firebase --version

确保 Firebase CLI 版本为 v13.9.0 或更高版本。

3. 通过运行以下命令向 Firebase CLI 授权：

firebase login

您已将 Web 应用模板设置为从应用的本地目录（您之前在此 Codelab 中克隆的代码库）中提取应用的 Firebase Hosting 配置。但是，要提取配置，您需要将应用与 Firebase 项目相关联。

4. 确保您的命令行可以访问应用的本地 angularfire-start 目录。
5. 通过运行以下命令，将您的应用与 Firebase 项目相关联：

firebase use --add

6. 当系统提示时，选择您的项目 ID，然后为您的 Firebase 项目指定一个别名。

如果您有多个环境（生产、预演等），别名会非常有用。不过，在此 Codelab 中，我们直接使用 default 这个别名。

7. 按照命令行中的其余说明操作。

5. 安装 AngularFire

在运行项目之前，请确保您已设置 Angular CLI 和 AngularFire。

1. 在控制台中，运行以下命令：

npm install -g @angular/cli

2. 然后，在控制台中的 angularfire-start 目录下，运行以下 Angular CLI 命令：

ng add @angular/fire

这将为您的项目安装所有必要的依赖项。

3. 出现提示时，使用空格键取消选中 ng deploy -- hosting。使用箭头键和空格键选择以下功能：
   • Authentication
   • Firestore
   • Cloud Messaging
   • Cloud Storage
4. 按 enter 并按其余提示操作。
5. 使用提交消息“Install AngularFire”创建提交，并将其推送到您的 GitHub 代码库。

6. 创建 App Hosting 后端

在本部分中，您将设置一个应用托管后端，以监控 Git 代码库中的分支。

注意：Firebase 应用托管目前为公开预览版。

完成本部分后，您将有一个连接到 GitHub 中的代码库的 App Hosting 后端。每当您将新提交推送到 main 分支时，该后端都会自动重新构建并发布应用的新版本。

1. 前往 Firebase 控制台中的“App Hosting”页面：

2. 点击“开始使用”以开始后端创建流程。按如下方式配置后端：
3. 按照第一步中的提示连接您之前创建的 GitHub 代码库。
4. 设置部署设置：
   1. 将根目录保留为 /
   2. 将实际分支设置为 main
   3. 启用自动发布
5. 将您的后端命名为 friendlychat-codelab。
6. 在“创建或关联 Firebase Web 应用”中，从“选择现有的 Firebase Web 应用”下拉菜单中选择您之前配置的 Web 应用。
7. 点击“完成并部署”。稍后，您将进入一个新页面，您可以在其中查看新的 App Hosting 后端的状态！

   注意：您可以在控制台中访问相应链接，以监控 App Hosting 后端的底层 Google Cloud 服务。如需了解详情，请参阅查看日志和指标。

8. 部署完成后，点击“网域”下的免费域名。由于 DNS 传播，这可能需要几分钟才能开始生效。

您已部署初始 Web 应用！每次您将新提交推送到 GitHub 代码库的 main 分支时，您都会在 Firebase 控制台中看到新的构建和发布开始，并且您的网站会在发布完成后自动更新。

您应该会看到 FreeChat 应用的登录屏幕（目前尚未运行）。

该应用程序目前无法执行任何操作，但在您的帮助下，它很快就会完成！

现在，我们构建一个实时聊天应用。

7. 导入和配置 Firebase

配置 Firebase

您需要配置 Firebase SDK，以告知它您正在使用的 Firebase 项目。

1. 前往 Firebase 控制台中的“项目设置”
2. 在“您的应用”卡片中，选择需要配置对象的应用的别名。
3. 从 Firebase SDK 代码段窗格中选择“Config”。

您会发现系统为您生成了一个环境文件 /angularfire-start/src/environments/environment.ts。

4. 复制配置对象代码段，然后将其添加到 angularfire-start/src/firebase-config.js。

environment.ts

export const environment = {
  firebase: {
    apiKey: "API_KEY",
    authDomain: "PROJECT_ID.firebaseapp.com",
    projectId: "PROJECT_ID",
    storageBucket: "PROJECT_ID.appspot.com",
    messagingSenderId: "SENDER_ID",
    appId: "APP_ID",
  },
};

上面的代码应包含特定于您应用的 Firebase 配置对象，而不是我们的占位值！

查看 AngularFire 设置

您会发现，您在控制台中选择的功能已自动添加到 /angularfire-start/src/app/app.config.ts 文件中。这样，您的应用就可以使用 Firebase 功能。

8. 设置用户登录

现在，AngularFire 应该已可供使用，因为它已在 app.config.ts 中导入并初始化。您现在将使用 Firebase Authentication 实现用户登录。

添加授权网域

Firebase Authentication 仅允许从您控制的一组网域登录。将您的免费 App Hosting 网域添加到网域列表中：

1. 前往 App Hosting（应用托管）。
2. 对应您的后端的网域。
3. 转到 Authentication 设置。
4. 选择已获授权的网域标签页。
5. 点击添加网域，然后粘贴您的应用托管后端的网域。

使用 Google 登录功能对用户进行身份验证

在应用中，当用户点击 Sign in with Google（使用 Google 帐号登录）按钮时，会触发 login 函数。对于此 Codelab，您需要授权 Firebase 使用 Google 作为身份提供方。您将使用弹出式窗口，不过 Firebase 中也提供了多种其他方法。

1. 在子目录 /src/app/services/ 中，打开 chat.service.ts。
2. 找到 login 函数。
3. 将整个函数替换为以下代码。

chat.service.ts

// Signs-in Friendly Chat.
login() {
    signInWithPopup(this.auth, this.provider).then((result) => {
        const credential = GoogleAuthProvider.credentialFromResult(result);
        this.router.navigate(['/', 'chat']);
        return credential;
    })
}

当用户点击 Log out 按钮时，就会触发 logout 函数。

1. 返回至 src/app/services/chat.service.ts 文件。
2. 找到 logout 函数。
3. 将整个函数替换为以下代码。

chat.service.ts

// Logout of Friendly Chat.
logout() {
    signOut(this.auth).then(() => {
        this.router.navigate(['/', 'login'])
        console.log('signed out');
    }).catch((error) => {
        console.log('sign out error: ' + error);
    })
}

跟踪身份验证状态

如需相应地更新界面，您需要一种方法来检查用户是处于登录状态还是已退出登录状态。AngularFire 提供了一个函数来获取一个可观察对象，该对象会在每次身份验证状态发生变化时更新。我们已实现此功能，但值得一试。

1. 返回至 src/app/services/chat.service.ts 文件。
2. 找到变量赋值 user$。

chat.service.ts

// observable that is updated when the auth state changes
user$ = user(this.auth);

上述代码会调用 AngularFire 函数 user，后者会返回一个可观察用户。每当身份验证状态发生变化时（当用户登录或退出帐号时），它就会触发。FreeChat 中的 Angular 模板组件使用此可观察对象更新界面以重定向、在标头导航中显示用户，以及执行其他操作。

测试登录应用

1. 使用提交消息“添加 Google 身份验证”创建提交，并将其推送到您的 GitHub 代码库。
2. 在 Firebase 控制台中打开“应用托管”页面，等待新发布完成。
3. 在 Web 应用中，刷新页面，然后使用登录按钮和您的 Google 帐号登录应用。如果您看到错误消息“auth/operation-not-allowed”，请检查是否已在 Firebase 控制台中启用 Google 登录作为身份验证提供方。
4. 登录后，系统应该会显示您的个人资料照片和用户名：

9. 向 Cloud Firestore 写入消息

在本部分中，您会将一些数据写入 Cloud Firestore，以便填充应用的界面。此操作可以使用 Firebase 控制台手动完成，但为了演示基本的 Cloud Firestore 写入，您需要在应用本身中执行。

数据模型

Cloud Firestore 数据会拆分为集合、文档、字段和子集合。您将把每条聊天消息作为文档存储在名为 messages 的顶级集合中。

提示：如需详细了解 Cloud Firestore 数据模型，请参阅相关文档中的文档和集合。

向 Cloud Firestore 添加消息

要存储用户撰写的聊天消息，您需要使用 Cloud Firestore。

在本部分中，您将为用户添加向数据库写入新消息的功能。用户点击发送按钮会触发以下代码段。它会将一个包含消息字段内容的消息对象添加到 messages 集合中的 Cloud Firestore 实例。add() 方法会将一个包含自动生成的 ID 的新文档添加到集合中。

1. 返回至 src/app/services/chat.service.ts 文件。
2. 找到 addMessage 函数。
3. 将整个函数替换为以下代码。

chat.service.ts

// Adds a text or image message to Cloud Firestore.
addMessage = async (
  textMessage: string | null,
  imageUrl: string | null,
): Promise<void | DocumentReference<DocumentData>> => {
  // ignore empty messages
  if (!textMessage && !imageUrl) {
    console.log(
      "addMessage was called without a message",
      textMessage,
      imageUrl,
    );
    return;
  }

  if (this.currentUser === null) {
    console.log("addMessage requires a signed-in user");
    return;
  }

  const message: ChatMessage = {
    name: this.currentUser.displayName,
    profilePicUrl: this.currentUser.photoURL,
    timestamp: serverTimestamp(),
    uid: this.currentUser?.uid,
  };

  textMessage && (message.text = textMessage);
  imageUrl && (message.imageUrl = imageUrl);

  try {
    const newMessageRef = await addDoc(
      collection(this.firestore, "messages"),
      message,
    );
    return newMessageRef;
  } catch (error) {
    console.error("Error writing new message to Firebase Database", error);
    return;
  }
};

测试发送消息

1. 使用提交消息“Post new chat to Firestore”创建提交内容，并将其推送到 GitHub 代码库。
2. 在 Firebase 控制台中打开“应用托管”页面，等待新发布完成。
3. 刷新 FreeChat。登录后，输入“嗨！”等消息，然后点击发送。这会将消息写入 Cloud Firestore。不过，您尚无法在实际 Web 应用中看到数据，因为您仍需实现数据检索功能（此 Codelab 的下一部分）。
4. 您可以在 Firebase 控制台中查看新添加的消息。打开模拟器套件界面。在构建部分下，点击 Firestore 数据库（或点击此处，您应该会看到包含新添加消息的 messages 集合：

10. 阅读消息

同步消息

如需读取应用中的消息，您需要添加一个会在数据发生变化时触发的可观察对象，然后创建显示新消息的界面元素。

您将添加用于监听应用中新添加的消息的代码。在此代码中，您将检索 messages 集合的快照。您将仅显示聊天的最后 12 条消息，以免加载时显示过长的历史记录。

1. 返回至 src/app/services/chat.service.ts 文件。
2. 找到 loadMessages 函数。
3. 将整个函数替换为以下代码。

chat.service.ts

// Loads chat message history and listens for upcoming ones.
loadMessages = () => {
  // Create the query to load the last 12 messages and listen for new ones.
  const recentMessagesQuery = query(collection(this.firestore, 'messages'), orderBy('timestamp', 'desc'), limit(12));
  // Start listening to the query.
  return collectionData(recentMessagesQuery);
}

如需监听数据库中的消息，您可以使用 collection 函数指定要监听的数据所在的集合，从而创建对集合的查询。在上面的代码中，您将监听 messages 集合（用于存储聊天消息的位置）中的更改。您还应用了此限制，方法是使用 limit(12) 仅监听最近 12 封邮件，并使用 orderBy('timestamp', 'desc') 按日期对邮件进行排序，以获取 12 封最新邮件。

collectionData 函数在后台使用快照。当与查询匹配的文档发生任何更改时，会触发回调函数。例如，消息已被删除、修改或添加。如需了解详情，请参阅 Cloud Firestore 文档。

测试同步消息

1. 使用提交消息“Show new chat in the UI”创建提交，并将其推送到 GitHub 代码库。
2. 在 Firebase 控制台中打开“应用托管”页面，等待新发布完成。
3. 刷新 FreeChat。您之前在数据库中创建的消息应显示在 RelationChat 界面中（见下文）。您可以随意撰写新消息，这些消息应该会立即显示。
4. （可选）您可以尝试直接在模拟器套件的 Firestore 部分中手动删除、修改或添加新消息；所有更改都应反映在界面中。

恭喜！您正在应用中读取 Cloud Firestore 文档！

11. 添加 AI 功能

您将使用 Google AI 为聊天应用添加实用的辅助功能。

获取 Google AI API 密钥

1. 前往 Google AI Studio，然后点击创建 API 密钥
2. 选择您为此 Codelab 创建的 Firebase 项目。提示针对的是 Google Cloud 项目，但每个 Firebase 项目都是一个 Google Cloud 项目。
3. 点击在现有项目中创建 API 密钥
4. 复制生成的 API 密钥

安装扩展程序

此扩展程序将部署一个 Cloud Functions 函数，每次有新文档添加到 Firestore 中的 messages 集合时都会触发该函数。该函数将调用 Gemini，并将其响应写回文档中的 response 字段。

1. 点击使用 Gemini API 扩展程序构建聊天机器人页面上的在 Firebase 控制台中安装。
2. 请按照提示操作。进入配置扩展程序步骤后，设置以下参数值：
   • Gemini API 提供商：Google AI
   • Google AI API 密钥：粘贴您之前创建的密钥，然后点击创建密钥。
   • Firestore 集合路径：messages
   • 提示字段：text
   • 响应字段：response
   • 订单字段：timestamp
   • 上下文：Keep your answers short, informal, and helpful. Use emojis when possible.
3. 点击安装扩展程序
4. 等待扩展程序完成安装

测试 AI 功能

FreeChat 已包含用于从 AI 扩展程序读取响应的代码。您只需发送一条新的聊天消息来测试一下效果！

1. 打开 RelationChat 并发送消息。
2. 片刻之后，你应该会看到你的消息旁边弹出一条回复。它的末尾有一条 ✨ ai generated 备注，标明它是使用生成式 AI 创建的，而不是真实用户。

12. 发送图片

您现在将添加分享图片的功能。

虽然 Cloud Firestore 非常适合存储结构化数据，但 Cloud Storage 更适合存储文件。Cloud Storage for Firebase 是一项文件/blob 存储服务，您可以使用它来存储用户通过我们的应用共享的所有图片。

将图片保存到 Cloud Storage

在此 Codelab 中，您已经为您添加了一个触发文件选择器对话框的按钮。选择文件后，系统会调用 saveImageMessage 函数，您可以获取对所选文件的引用。saveImageMessage 函数会完成以下操作：

1. 在聊天信息流中创建“占位符”聊天消息，以便用户在您上传图片时看到“正在加载”动画。
2. 将图片文件上传到 Cloud Storage 到以下路径：/<uid>/<file_name>
3. 为图片文件生成可公开读取的网址。
4. 使用新上传的图片文件的网址更新聊天消息，以取代临时加载的图片。

现在，您将添加发送图片的功能：

1. 返回至 src/chat.service.ts 文件。
2. 找到 saveImageMessage 函数。
3. 将整个函数替换为以下代码。

chat.service.ts

// Saves a new message containing an image in Firestore.
// This first saves the image in Firebase storage.
saveImageMessage = async(file: any) => {
  try {
    // 1 - Add a message with a loading icon that will get updated with the shared image.
    const messageRef = await this.addMessage(null, this.LOADING_IMAGE_URL);

    // 2 - Upload the image to Cloud Storage.
    const filePath = `${this.auth.currentUser?.uid}/${file.name}`;
    const newImageRef = ref(this.storage, filePath);
    const fileSnapshot = await uploadBytesResumable(newImageRef, file);

    // 3 - Generate a public URL for the file.
    const publicImageUrl = await getDownloadURL(newImageRef);

    // 4 - Update the chat message placeholder with the image's URL.
    messageRef ?
    await updateDoc(messageRef, {
      imageUrl: publicImageUrl,
      storageUri: fileSnapshot.metadata.fullPath
    }): null;
  } catch (error) {
    console.error('There was an error uploading a file to Cloud Storage:', error);
  }
}

测试发送图片

1. 使用提交消息“Add the capability to post images”（添加图片发布功能）创建提交，并将其推送到 GitHub 代码库。
2. 在 Firebase 控制台中打开“应用托管”页面，等待新发布完成。
3. 刷新 FreeChat。登录后，点击左下角的图片上传按钮 ，然后使用文件选择器选择一个图片文件。如果您正在寻找图片，可以随时使用这张精美的咖啡杯图片。
4. 应用的界面中应会显示一条新消息以及您选择的图片：

如果您在未登录的情况下尝试添加图片，将会看到一条错误消息，提示您必须登录才能添加图片。

13. 显示通知

你将添加对浏览器通知的支持。当聊天中有新消息发布时，应用会通知用户。Firebase Cloud Messaging (FCM) 是一种跨平台消息传递解决方案，可供您可靠地传递消息和通知，且无需任何费用。

添加 FCM Service Worker

Web 应用需要一个可接收并显示网络通知的 Service Worker。

添加 AngularFire 时，消息传递提供程序应该已经设置，请确保 /angularfire-start/src/app/app.module.ts 的 imports 部分存在以下代码

provideMessaging(() => {
    return getMessaging();
}),

app/app.module.ts

Service Worker 只需加载并初始化 Firebase Cloud Messaging SDK，此 SDK 将负责显示通知。

获取 FCM 设备令牌

在设备或浏览器上启用通知功能后，您会收到一个设备令牌。您可以使用此设备令牌向特定设备或特定浏览器发送通知。

当用户登录时，您调用 saveMessagingDeviceToken 函数。在这里，您可以从浏览器获取 FCM 设备令牌并将其保存到 Cloud Firestore。

chat.service.ts

2. 找到 saveMessagingDeviceToken 函数。
3. 将整个函数替换为以下代码。

chat.service.ts

// Saves the messaging device token to Cloud Firestore.
saveMessagingDeviceToken= async () => {
    try {
      const currentToken = await getToken(this.messaging);
      if (currentToken) {
        console.log('Got FCM device token:', currentToken);
        // Saving the Device Token to Cloud Firestore.
        const tokenRef = doc(this.firestore, 'fcmTokens', currentToken);
        await setDoc(tokenRef, { uid: this.auth.currentUser?.uid });
 
        // This will fire when a message is received while the app is in the foreground.
        // When the app is in the background, firebase-messaging-sw.js will receive the message instead.
        onMessage(this.messaging, (message) => {
          console.log(
            'New foreground notification from Firebase Messaging!',
            message.notification
          );
        });
      } else {
        // Need to request permissions to show notifications.
        this.requestNotificationsPermissions();
      }
    } catch(error) {
      console.error('Unable to get messaging token.', error);
    };
}

不过，此代码最初无法运行。为了让您的应用能够检索设备令牌，用户需要授予您的应用显示通知的权限（此 Codelab 的下一步）。

请求权限以显示通知

如果用户尚未授予您的应用显示通知的权限，您将不会获得设备令牌。在本例中，您需要调用 requestPermission() 方法，该方法会显示一个浏览器对话框，请求此权限（在支持的浏览器中）。

1. 返回至 src/app/services/chat.service.ts 文件。
2. 找到 requestNotificationsPermissions 函数。
3. 将整个函数替换为以下代码。

chat.service.ts

// Requests permissions to show notifications.
requestNotificationsPermissions = async () => {
    console.log('Requesting notifications permission...');
    const permission = await Notification.requestPermission();
    
    if (permission === 'granted') {
      console.log('Notification permission granted.');
      // Notification permission granted.
      await this.saveMessagingDeviceToken();
    } else {
      console.log('Unable to get permission to notify.');
    }
}

获取设备令牌

1. 使用提交消息“Add the capability to post images”（添加图片发布功能）创建提交，并将其推送到 GitHub 代码库。
2. 在 Firebase 控制台中打开“应用托管”页面，等待新发布完成。
3. 刷新 FreeChat。登录后，您应该会看到通知权限对话框：
4. 点击允许。
5. 打开浏览器的 JavaScript 控制台。您应该会看到以下消息：Got FCM device token: cWL6w:APA91bHP...4jDPL_A-wPP06GJp1OuekTaTZI5K2Tu
6. 复制您的设备令牌。在本 Codelab 的下一阶段，将会用到它。

向您的设备发送通知

现在，您已经获得了设备令牌，可以发送通知了。

1. 打开 Firebase 控制台中的“Cloud Messaging”标签页。
2. 点击“新建通知”
3. 输入通知标题和通知文本。
4. 在屏幕右侧，点击“发送测试消息”
5. 输入您从浏览器的 JavaScript 控制台复制的设备令牌，然后点击加号 (+)
6. 点击“测试”

如果您的应用在前台运行，您会在 JavaScript 控制台中看到通知。

如果您的应用在后台运行，您的浏览器应该会显示一条通知，如下例所示：

在后续的 Codelab Firebase SDK for Cloud Functions 中，您将了解如何针对聊天应用中发布的每条新消息从后端自动发送通知。

14. Cloud Firestore 安全规则

查看数据库安全规则

Cloud Firestore 使用特定的规则语言来定义访问权限、安全性和数据验证。

在此 Codelab 的开头设置 Firebase 项目时，您选择了使用“测试模式”默认安全规则，这样就不会限制对数据存储区的访问。在 Firebase 控制台的数据库部分的规则标签页中，您可以查看和修改这些规则。

现在，您应该会看到默认规则，这些规则不会限制对数据存储区的访问。这意味着任何用户都可以对您数据存储区中的任何集合执行读写操作。

rules_version = '2';

service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write;
    }
  }
}

您将使用以下规则更新规则，以对内容进行限制：

firestore.rules

rules_version = '2';

service cloud.firestore {
  match /databases/{database}/documents {
    // Messages:
    //   - Anyone can read.
    //   - Authenticated users can add and edit messages.
    //   - Validation: Check name is same as auth token and text length below 300 char or that imageUrl is a URL.
    //   - Deletes are not allowed.
    match /messages/{messageId} {
      allow read;
      allow create, update: if request.auth != null
                    && request.resource.data.name == request.auth.token.name
                    && (request.resource.data.text is string
                      && request.resource.data.text.size() <= 300
                      || request.resource.data.imageUrl is string
                      && request.resource.data.imageUrl.matches('https?://.*'));
      allow delete: if false;
    }
    // FCM Tokens:
    //   - Anyone can write their token.
    //   - Reading list of tokens is not allowed.
    match /fcmTokens/{token} {
      allow read: if false;
      allow write;
    }
  }
}

request.auth 规则变量是一个特殊的变量，包含经过身份验证的用户的相关信息。request.resource 规则变量指向正在写入的新数据。如需了解详情，请参阅相关文档。

安全规则应会自动更新到您的模拟器套件。

查看 Cloud Storage 安全规则

Cloud Storage for Firebase 使用特定的规则语言来定义访问权限、安全性和数据验证。

在此 Codelab 的开头设置 Firebase 项目时，您已选择使用默认的 Cloud Storage 安全规则，该规则仅允许通过身份验证的用户使用 Cloud Storage。在 Firebase 控制台的存储部分的规则标签页中，您可以查看和修改规则。您应该会看到一条默认规则，此规则允许所有已登录用户读取和写入您的存储分区中的任何文件。

rules_version = '2';

service firebase.storage {
  match /b/{bucket}/o {
    match /{allPaths=**} {
      allow read, write: if request.auth != null;
    }
  }
}

您将更新这些规则以执行以下操作：

• 仅允许每个用户向自己的特定文件夹写入数据
• 允许任何人从 Cloud Storage 读取数据
• 请确保上传的文件是图片
• 将可上传的图片大小上限设为 5 MB

这可以使用以下规则来实现：

storage.rules

rules_version = '2';

// Returns true if the uploaded file is an image and its size is below the given number of MB.
function isImageBelowMaxSize(maxSizeMB) {
  return request.resource.size < maxSizeMB * 1024 * 1024
      && request.resource.contentType.matches('image/.*');
}

service firebase.storage {
  match /b/{bucket}/o {
    match /{userId}/{messageId}/{fileName} {
      allow write: if request.auth != null && request.auth.uid == userId && isImageBelowMaxSize(5);
      allow read;
    }
  }
}

request.auth 规则变量是一个特殊的变量，包含经过身份验证的用户的相关信息。request.resource 规则变量包含已上传文件的相关信息。如需了解详情，请参阅相关文档。

15. 恭喜！

您已使用 Firebase 构建了一个实时聊天 Web 应用！

所学内容

• Firebase App Hosting
• Firebase Authentication
• Cloud Firestore
• 适用于 Cloud Storage 的 Firebase SDK
• Firebase Cloud Messaging
• Firebase Performance Monitoring

后续步骤

继续学习 Cloud Functions for Firebase Codelab，了解如何使用 Firebase SDK for Cloud Functions 以及向您的聊天应用添加一些后端任务。由于您已经设置了 Firebase 项目，因此可以直接从该 Codelab 的第 5 步开始操作。

想要详细了解 Cloud Firestore？也许您想了解子集合和事务？前往 Cloud Firestore Web Codelab，进入一个更深入地了解 Cloud Firestore 的 Codelab。

想要详细了解 Web 版 Firebase Performance Monitoring？不妨前往“适用于 Web 的 Firebase 性能监控”Codelab，进入一个更深入地了解 Firebase Performance Monitoring 的 Codelab。

了解详情

• firebase.google.com

16. [可选] 使用 App Check 强制执行

Firebase App Check 有助于保护您的服务免受不需要的流量的侵害，并有助于保护您的后端免遭滥用。在此步骤中，您将使用 App Check 和 reCAPTCHA Enterprise 添加凭据验证机制并屏蔽未经授权的客户端。

此步骤取决于前面步骤的完成情况，请确保 RelationChat 使用模拟器在本地运行或借助 Firebase 服务进行部署。

首先，您需要启用 App Check 和 reCAPTCHA。

启用 reCAPTCHA Enterprise

1. 在 Cloud 控制台的“安全性”下，找到并选择 reCAPtcha Enterprise。
2. 按照提示启用该服务，然后点击创建密钥。
3. 按照提示输入显示名称，然后选择网站作为平台类型。
4. 将已部署的网址添加到网域列表中，并确保未选中“使用复选框验证”选项。
5. 点击创建密钥，并将生成的密钥存储在某处妥善保存。在此步骤的后面部分，您将需要用到此文件。

启用 App Check

1. 在 Firebase 控制台中，找到左侧面板中的构建部分。
2. 点击 App Check，然后点击 Sign-in method（登录方法）标签页，前往 App Check。
3. 点击注册，并在系统提示时输入您的 reCAPTCHA Enterprise 密钥，然后点击保存。
4. 在 API 视图中，选择存储，然后点击实施。对 Cloud Firestore 执行相同的操作。

现在应该已强制执行 App Check！刷新应用，然后尝试查看或发送聊天消息。您应该会看到错误消息：

Uncaught Error in snapshot listener: FirebaseError: [code=permission-denied]: Missing or insufficient permissions.

这意味着 App Check 默认屏蔽未验证的请求。现在，让我们来为您的应用添加验证。

找到 environment.ts 文件，然后将 reCAPTCHAEnterpriseKey 添加到 environment 对象。

export const environment = {
  firebase: {
    apiKey: 'API_KEY',
    authDomain: 'PROJECT_ID.firebaseapp.com',
    databaseURL: 'https://PROJECT_ID.firebaseio.com',
    projectId: 'PROJECT_ID',
    storageBucket: 'PROJECT_ID.appspot.com',
    messagingSenderId: 'SENDER_ID',
    appId: 'APP_ID',
    measurementId: 'G-MEASUREMENT_ID',
  },
  reCAPTCHAEnterpriseKey: {
    key: "Replace with your recaptcha enterprise site key"
  },
};

将 key 的值替换为您的 reCAPTCHA Enterprise 令牌。

然后，找到 app.module.ts 文件并添加以下导入内容：

import { getApp } from '@angular/fire/app';
import {
  ReCaptchaEnterpriseProvider,
  initializeAppCheck,
  provideAppCheck,
} from '@angular/fire/app-check';

在同一 app.module.ts 文件中，添加以下全局变量声明：

declare global {
  var FIREBASE_APPCHECK_DEBUG_TOKEN: boolean;
}

@NgModule({ ...

在导入中，使用 ReCaptchaEnterpriseProvider 添加 App Check 的初始化，并将 isTokenAutoRefreshEnabled 设置为 true 以允许自动刷新令牌。

imports: [
BrowserModule,
AppRoutingModule,
CommonModule,
FormsModule,
provideFirebaseApp(() => initializeApp(environment.firebase)),
provideAppCheck(() => {
const appCheck = initializeAppCheck(getApp(), {
  provider: new ReCaptchaEnterpriseProvider(
  environment.reCAPTCHAEnterpriseKey.key
  ),
  isTokenAutoRefreshEnabled: true,
  });
  if (location.hostname === 'localhost') {
    self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
  }
  return appCheck;
}),

如需允许进行本地测试，请将 self.FIREBASE_APPCHECK_DEBUG_TOKEN 设置为 true。当您在 localhost 中刷新应用时，这将在控制台中记录一个类似如下的调试令牌：

App Check debug token: CEFC0C76-7891-494B-B764-349BDFD00D00. You will need to add it to your app's App Check settings in the Firebase console for it to work.

现在，在 Firebase 控制台中前往 App Check 的应用视图。

点击溢出菜单，然后选择管理调试令牌。

然后，点击添加调试令牌，并按照提示从控制台粘贴调试令牌。

转到 chat.service.ts 文件，然后添加以下导入内容：

import { AppCheck } from '@angular/fire/app-check';

在同一 chat.service.ts 文件中，将 App Check 与其他 Firebase 服务一起注入。

export class ChatService {
appCheck: AppCheck = inject(AppCheck);
...

1. 使用提交消息“使用 App Check 阻止未授权的客户端”创建提交，并将其推送到您的 GitHub 代码库。
2. 在 Firebase 控制台中打开“应用托管”页面，等待新发布完成。

恭喜！现在，App Check 应该可以在您的应用中运行了。