了解如何将 Firebase 用于 Web

1.概览

在此 Codelab 中,您将学习一些 Firebase 基础知识,以便创建交互式 Web 应用。您将使用多个 Firebase 产品构建一个活动回复和留言板聊天应用。

此步骤的屏幕截图

学习内容

  • 使用 Firebase Authentication 和 FirebaseUI 对用户进行身份验证。
  • 使用 Cloud Firestore 同步数据。
  • 编写 Firebase 安全规则以保护数据库。

所需条件

  • 您选择的浏览器(例如 Chrome)。
  • 访问 stackblitz.com(无需账号或登录)。
  • Google 账号,例如 Gmail 账号。我们建议您使用已用于 GitHub 账号的电子邮件账号。这样,您就可以在 StackBlitz 中使用高级功能了。
  • 此 Codelab 的示例代码。请参阅下一步,了解如何获取代码。

2. 获取起始代码

在此 Codelab 中,您将使用 StackBlitz 构建一个应用。StackBlitz 是一个在线编辑器,其中集成了多个 Firebase 工作流。Stackblitz 不需要安装任何软件,也不需要任何特殊的 StackBlitz 账号。

StackBlitz 可让您与他人分享项目。知道您的 StackBlitz 项目网址的其他人可以查看您的代码和分叉您的项目,但无法修改您的 StackBlitz 项目。

  1. 前往以下网址获取起始代码:https://stackblitz.com/edit/firebase-gtk-web-start
  2. 在 StackBlitz 页面顶部,点击克隆

此步骤的屏幕截图

现在,您已经将起始代码的副本作为自己的 StackBlitz 项目,该项目具有唯一的名称和网址。您的所有文件和更改都保存在此 StackBlitz 项目中。

3. 修改活动信息

此 Codelab 的起始资料为 Web 应用提供了一些结构,包括该应用的一些样式表和几个 HTML 容器。在此 Codelab 的后面部分,您会将这些容器连接到 Firebase。

首先,我们来进一步熟悉一下 StackBlitz 界面。

  1. 在 StackBlitz 中,打开 index.html 文件。
  2. 找到“event-details-container”和“description-container”,然后尝试修改一些活动详细信息。

在您修改文本时,StackBlitz 中的自动页面重新加载会显示新活动的详细信息。很酷吧?

<!-- ... -->

<div id="app">
  <img src="..." />

  <section id="event-details-container">
     <h1>Firebase Meetup</h1>

     <p><i class="material-icons">calendar_today</i> October 30</p>
     <p><i class="material-icons">location_city</i> San Francisco</p>

  </section>

  <hr>

  <section id="firebaseui-auth-container"></section>

  <section id="description-container">
     <h2>What we'll be doing</h2>
     <p>Join us for a day full of Firebase Workshops and Pizza!</p>
  </section>
</div>

<!-- ... -->

应用的预览应如下所示:

应用预览

此步骤的屏幕截图

4. 创建和设置 Firebase 项目

显示活动信息对邀请对象来说很有利,但仅仅显示活动对所有人都没有太大帮助。让我们为此应用添加一些动态功能。为此,您需要将 Firebase 与您的应用关联。要开始使用 Firebase,您需要创建并设置 Firebase 项目。

创建 Firebase 项目

  1. 登录 Firebase
  2. 在 Firebase 控制台中,点击 Add Project(或 Create a project),然后将您的 Firebase 项目命名为 Firebase-Web-Codelab

    此步骤的屏幕截图

  3. 点击各个项目创建选项。如果出现提示,请接受 Firebase 条款。在 Google Analytics 屏幕上,点击“不启用”,因为您不为此应用使用 Google Analytics。

如需详细了解 Firebase 项目,请参阅了解 Firebase 项目

在控制台中启用和设置 Firebase 产品

您所构建的应用会使用多个适用于 Web 应用的 Firebase 产品:

  • Firebase 身份验证Firebase 界面:可让用户轻松登录您的应用。
  • Cloud Firestore:用于在云端保存结构化数据,并在数据发生变化时即时收到通知。
  • Firebase 安全规则:用于保护您的数据库。

其中一些产品需要特殊配置,或者需要使用 Firebase 控制台启用。

为 Firebase Authentication 启用电子邮件地址登录

在此 Codelab 中,如需允许用户登录 Web 应用,您将使用电子邮件地址/密码登录方法:

  1. 在 Firebase 控制台的左侧面板中,点击 Build >身份验证。然后点击开始使用。您现在位于“身份验证”信息中心,在这里可以查看已注册的用户、配置登录提供程序和管理设置。

    此步骤的屏幕截图

  2. 选择登录方法标签页(或点击此处直接进入该标签页)。

    此步骤的屏幕截图

  3. 在提供商选项中点击电子邮件地址/密码,将开关切换为启用,然后点击保存

    此步骤的屏幕截图

设置 Cloud Firestore

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

以下是设置 Cloud Firestore 的方法:

  1. 在 Firebase 控制台的左侧面板中,点击 Build >Firestore 数据库。然后点击创建数据库
  2. 点击创建数据库

    此步骤的屏幕截图

  3. 选择 Start in test mode 选项。阅读有关安全规则的免责声明。测试模式可确保您在开发过程中可以随意向数据库写入数据。点击下一步

    此步骤的屏幕截图

  4. 选择数据库的位置(可以使用默认值)。不过请注意,此位置以后无法更改。

    此步骤的屏幕截图

  5. 点击完成

5. 添加和配置 Firebase

现在您已经创建了 Firebase 项目并启用了一些服务,接下来您需要告诉代码要使用 Firebase,以及要使用哪个 Firebase 项目。

添加 Firebase 库

如需让应用使用 Firebase,您需要将 Firebase 库添加到应用中。如需了解具体方法,请参阅 Firebase 文档。例如,您可以从 Google 的 CDN 添加库,也可以使用 npm 将它们安装在本地,然后将它们打包到应用中(如果您使用的是 Browserify)。

StackBlitz 提供自动打包功能,因此您可以使用 import 语句添加 Firebase 库。您将使用这些库的模块化 (v9) 版本,这些模块会通过一个称为“摇树优化”的流程帮助减小网页的总大小。如需详细了解模块化 SDK,请参阅文档

如需构建此应用,请使用 Firebase Authentication、FirebaseUI 和 Cloud Firestore 库。对于本 Codelab,index.js 文件的顶部已包含以下 import 语句,我们将在后续过程中从每个 Firebase 库导入更多方法:

// Import stylesheets
import './style.css';

// Firebase App (the core Firebase SDK) is always required
import { initializeApp } from 'firebase/app';

// Add the Firebase products and methods that you want to use
import {} from 'firebase/auth';
import {} from 'firebase/firestore';

import * as firebaseui from 'firebaseui';

将 Firebase Web 应用添加到您的 Firebase 项目

  1. 返回 Firebase 控制台,点击左上角的 Project Overview(项目概览),进入项目的概览页面。
  2. 在项目概览页面的中心位置,点击 Web 图标 Web 应用图标 创建新的 Firebase Web 应用。

    此步骤的屏幕截图

  3. 使用别名 Web 应用注册应用。
  4. 对于本 Codelab,请勿选中还为此应用设置 Firebase Hosting 旁边的复选框。您暂时将使用 StackBlitz 的预览窗格。
  5. 点击注册应用

    此步骤的屏幕截图

  6. Firebase 配置对象复制到剪贴板。

    此步骤的屏幕截图

  7. 点击继续并前往控制台。将 Firebase 配置对象添加到您的应用:
  8. 返回 StackBlitz,前往 index.js 文件。
  9. 找到 Add Firebase project configuration object here 注释行,然后将配置代码段粘贴到该注释下方。
  10. 添加 initializeApp 函数调用,以使用您唯一的 Firebase 项目配置来设置 Firebase。
    // ...
    // Add Firebase project configuration object here
    const firebaseConfig = {
      apiKey: "random-unique-string",
      authDomain: "your-projectId.firebaseapp.com",
      databaseURL: "https://your-projectId.firebaseio.com",
      projectId: "your-projectId",
      storageBucket: "your-projectId.appspot.com",
      messagingSenderId: "random-unique-string",
      appId: "random-unique-string",
    };
    
    // Initialize Firebase
    initializeApp(firebaseConfig);
    

6. 添加用户登录信息(回复)

现在,您已将 Firebase 添加到应用中,接下来可以设置一个用于使用 Firebase Authentication 注册用户的回复按钮。

使用电子邮件登录和 FirebaseUI 对用户进行身份验证

您需要一个回复按钮,以提示用户使用其电子邮件地址登录。为此,您可以将 FirebaseUI 连接到回复按钮。FirebaseUI 是一个库,可在 Firebase Auth 之上为您提供预构建的界面。

FirebaseUI 需要执行两项操作的配置(请参阅文档中的选项):

  • 告知 FirebaseUI 您要使用电子邮件地址/密码登录方法。
  • 处理成功登录的回调,并返回 false 以避免重定向。您不想刷新页面,因为您正在构建单页 Web 应用。

添加用于初始化 FirebaseUI Auth 的代码

  1. 在 StackBlitz 中,前往 index.js 文件。
  2. 在顶部,找到 firebase/auth import 语句,然后添加 getAuthEmailAuthProvider,如下所示:
    // ...
    // Add the Firebase products and methods that you want to use
    import { getAuth, EmailAuthProvider } from 'firebase/auth';
    
    import {} from 'firebase/firestore';
    
  3. 紧跟在 initializeApp 之后保存对 auth 对象的引用,如下所示:
    initializeApp(firebaseConfig);
    auth = getAuth();
    
  4. 请注意,启动代码中已提供 FirebaseUI 配置。它已设置为使用电子邮件身份验证提供程序。
  5. index.jsmain() 函数底部,添加 FirebaseUI 初始化语句,如下所示:
    async function main() {
      // ...
    
      // Initialize the FirebaseUI widget using Firebase
      const ui = new firebaseui.auth.AuthUI(auth);
    }
    main();
    
    

向 HTML 添加回复按钮

  1. 在 StackBlitz 中,前往 index.html 文件。
  2. event-details-container 内添加 RSVP 按钮的 HTML,如以下示例所示。

    请务必使用与下方所示相同的 id 值,因为在此 Codelab 中,index.js 文件中已经包含这些特定 ID 的钩子。

    请注意,在 index.html 文件中,有一个 ID 为 firebaseui-auth-container 的容器。这是您将传递给 FirebaseUI 以保存登录信息的 ID。
    <!-- ... -->
    
    <section id="event-details-container">
        <!-- ... -->
        <!-- ADD THE RSVP BUTTON HERE -->
        <button id="startRsvp">RSVP</button>
    </section>
    <hr>
    <section id="firebaseui-auth-container"></section>
    <!-- ... -->
    
    应用预览

    此步骤的屏幕截图

  3. 在“RSVP”按钮上设置监听器,并调用 FirebaseUI 的 start 函数。这会告知 FirebaseUI 您希望显示登录窗口。

    将以下代码添加到 index.jsmain() 函数的底部:
    async function main() {
      // ...
    
      // Listen to RSVP button clicks
      startRsvpButton.addEventListener("click",
       () => {
            ui.start("#firebaseui-auth-container", uiConfig);
      });
    }
    main();
    

测试登录应用

  1. 在 StackBlitz 的预览窗口中,点击“RSVP”(回复)按钮以登录该应用。
    • 对于本 Codelab,您可以使用任何电子邮件地址,甚至可以使用虚假电子邮件地址,因为您不会为本 Codelab 设置电子邮件验证步骤。
    • 如果您看到显示 auth/operation-not-allowedThe given sign-in provider is disabled for this Firebase project 的错误消息,请检查并确保您已在 Firebase 控制台中将电子邮件/密码作为登录提供方启用。
    应用预览

    此步骤的屏幕截图

  2. 前往 Firebase 控制台中的身份验证信息中心。在用户标签页中,您应该会看到您在登录应用时输入的账号信息。

    此步骤的屏幕截图

向界面添加身份验证状态

接下来,确保界面反映您已登录这一事实。

您将使用 Firebase Authentication 状态监听器回调,该回调会在用户的登录状态发生变化时收到通知。如果当前已有用户,您的应用将会切换“回复”“退出”按钮按钮。

  1. 在 StackBlitz 中,前往 index.js 文件。
  2. 在顶部,找到 firebase/auth import 语句,然后添加 signOutonAuthStateChanged,如下所示:
    // ...
    // Add the Firebase products and methods that you want to use
    import {
      getAuth,
      EmailAuthProvider,
      signOut,
      onAuthStateChanged
    } from 'firebase/auth';
    
    import {} from 'firebase/firestore';
    
  3. main() 函数底部添加以下代码:
    async function main() {
      // ...
    
      // Listen to the current Auth state
      onAuthStateChanged(auth, user => {
        if (user) {
          startRsvpButton.textContent = 'LOGOUT';
        } else {
          startRsvpButton.textContent = 'RSVP';
        }
      });
    }
    main();
    
  4. 在按钮监听器中,检查是否有当前用户并将其退出。为此,请将当前的 startRsvpButton.addEventListener替换为以下内容:
    // ...
    // Called when the user clicks the RSVP button
    startRsvpButton.addEventListener('click', () => {
      if (auth.currentUser) {
        // User is signed in; allows user to sign out
        signOut(auth);
      } else {
        // No user is signed in; allows user to sign in
        ui.start('#firebaseui-auth-container', uiConfig);
      }
    });
    

现在,应用中的按钮应该显示 LOGOUT,并且在用户点击该按钮后应切换回 RSVP

应用预览

此步骤的屏幕截图

7. 将消息写入 Cloud Firestore

知道用户即将到来是件好事,但我们还可以为访客提供其他在应用中执行的操作。如果他们可以在留言板中留言,那该多好!他们可以告诉大家为什么很高兴参加或希望见到谁。

要存储用户在应用中编写的聊天消息,请使用 Cloud Firestore

数据模型

Cloud Firestore 是一种 NoSQL 数据库,其中存储的数据分为集合、文档、字段和子集合。您会将聊天对话中的每条消息作为文档存储在名为 guestbook 的顶级集合中。

Firestore 数据模型图,显示包含多个消息文档的留言板集合

向 Firestore 添加消息

在本部分中,您将添加一项功能,让用户可以向数据库写入新消息。首先,您需要为界面元素(消息字段和发送按钮)添加 HTML。然后,添加将这些元素连接到数据库的代码。

如需添加消息字段和发送按钮的界面元素,请执行以下操作:

  1. 在 StackBlitz 中,前往 index.html 文件。
  2. 找到 guestbook-container,然后添加以下 HTML 代码,以创建包含消息输入字段和发送按钮的表单。
    <!-- ... -->
    
     <section id="guestbook-container">
       <h2>Discussion</h2>
    
       <form id="leave-message">
         <label>Leave a message: </label>
         <input type="text" id="message">
         <button type="submit">
           <i class="material-icons">send</i>
           <span>SEND</span>
         </button>
       </form>
    
     </section>
    
    <!-- ... -->
    

应用预览

此步骤的屏幕截图

用户点击发送按钮将触发以下代码段。它将消息输入字段的内容添加到数据库的 guestbook 集合中。具体而言,addDoc 方法会将消息内容添加到 guestbook 集合中的新文档(具有自动生成的 ID)。

  1. 在 StackBlitz 中,前往 index.js 文件。
  2. 在顶部,找到 firebase/firestore import 语句,然后添加 getFirestoreaddDoccollection,如下所示:
    // ...
    
    // Add the Firebase products and methods that you want to use
    import {
      getAuth,
      EmailAuthProvider,
      signOut,
      onAuthStateChanged
    } from 'firebase/auth';
    
    import {
      getFirestore,
      addDoc,
      collection
    } from 'firebase/firestore';
    
  3. 现在,我们将在 initializeApp 之后保存对 Firestore db 对象的引用:
    initializeApp(firebaseConfig);
    auth = getAuth();
    db = getFirestore();
    
  4. main() 函数底部,添加以下代码。

    请注意,auth.currentUser.uid 是指 Firebase Authentication 为所有已登录用户分配的自动生成的唯一 ID。
    async function main() {
      // ...
    
      // Listen to the form submission
      form.addEventListener('submit', async e => {
        // Prevent the default form redirect
        e.preventDefault();
        // Write a new message to the database collection "guestbook"
        addDoc(collection(db, 'guestbook'), {
          text: input.value,
          timestamp: Date.now(),
          name: auth.currentUser.displayName,
          userId: auth.currentUser.uid
        });
        // clear message input field
        input.value = '';
        // Return false to avoid redirect
        return false;
      });
    }
    main();
    

仅向已登录的用户显示留言板

您不想只让任何人看到邀请对象聊天。为了确保聊天安全,您可以只允许已登录的用户查看留言板。不过,对于您自己的应用,您还需要使用 Firebase 安全规则来保护数据库。(本 Codelab 后面会详细介绍安全规则。)

  1. 在 StackBlitz 中,前往 index.js 文件。
  2. 修改 onAuthStateChanged 监听器以隐藏和显示留言板。
    // ...
    
    // Listen to the current Auth state
    onAuthStateChanged(auth, user => {
      if (user) {
        startRsvpButton.textContent = 'LOGOUT';
        // Show guestbook to logged-in users
        guestbookContainer.style.display = 'block';
      } else {
        startRsvpButton.textContent = 'RSVP';
        // Hide guestbook for non-logged-in users
        guestbookContainer.style.display = 'none';
      }
    });
    

测试发送消息

  1. 确保您已登录该应用。
  2. 输入消息,如“您好!”,然后点击发送

此操作会将消息写入 Cloud Firestore 数据库。不过,您不会在实际 Web 应用中看到消息,因为您仍需实现数据检索。您接下来将执行此操作。

不过,您可以在 Firebase 控制台中看到新添加的消息。

在 Firebase 控制台的 Firestore 数据库信息中心中,您应该会看到包含新添加的消息的 guestbook 集合。如果您继续发送消息,您的留言板集合将包含许多文档,如下所示:

Firebase 控制台

此步骤的屏幕截图

8. 读取消息

同步消息

很高兴,访客可以向数据库写入消息,但他们目前还无法在应用中看到这些消息。

如需显示消息,您需要添加在数据发生变化时触发的监听器,然后创建一个用于显示新消息的界面元素。

您将添加相应的代码,用于监听来自应用的新添加消息。首先,在 HTML 中添加一个部分以显示消息:

  1. 在 StackBlitz 中,前往 index.html 文件。
  2. guestbook-container 中,添加一个 ID 为 guestbook 的新部分。
    <!-- ... -->
    
      <section id="guestbook-container">
       <h2>Discussion</h2>
    
       <form><!-- ... --></form>
    
       <section id="guestbook"></section>
    
     </section>
    
    <!-- ... -->
    

接下来,注册监听器以监听数据更改:

  1. 在 StackBlitz 中,前往 index.js 文件。
  2. 在顶部,找到 firebase/firestore import 语句,然后添加 queryorderByonSnapshot,如下所示:
    // ...
    import {
      getFirestore,
      addDoc,
      collection,
      query,
      orderBy,
      onSnapshot
    } from 'firebase/firestore';
    
  3. main() 函数底部,添加以下代码以循环遍历数据库中的所有文档(留言)。如需详细了解此代码发生的情况,请参阅代码段下面的信息。
    async function main() {
      // ...
    
      // Create query for messages
      const q = query(collection(db, 'guestbook'), orderBy('timestamp', 'desc'));
      onSnapshot(q, snaps => {
        // Reset page
        guestbook.innerHTML = '';
        // Loop through documents in database
        snaps.forEach(doc => {
          // Create an HTML entry for each document and add it to the chat
          const entry = document.createElement('p');
          entry.textContent = doc.data().name + ': ' + doc.data().text;
          guestbook.appendChild(entry);
        });
      });
    }
    main();
    

为了监听数据库中的消息,您已使用 collection 函数针对特定集合创建了查询。上述代码会监听 guestbook 集合中的更改,聊天消息就存储在该集合中。消息还会按日期排序,并使用 orderBy('timestamp', 'desc') 在顶部显示最新消息。

onSnapshot 函数采用两个参数:要使用的查询和回调函数。当与查询匹配的文档发生任何更改时,就会触发回调函数。如果邮件被删除、修改或添加,就可能会发生这种情况。如需了解详情,请参阅 Cloud Firestore 文档

测试邮件同步情况

Cloud Firestore 会自动并即时地将数据与订阅了该数据库的客户端同步。

  • 您之前在数据库中创建的消息应显示在应用中。您可以随意写入新消息,这些消息应该会立即显示。
  • 如果您在多个窗口或标签页中打开工作区,消息会在标签页之间实时同步。
  • (可选)您可以尝试直接在 Firebase 控制台的数据库部分手动删除、修改或添加新消息;所有更改都应显示在界面中

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

应用预览

此步骤的屏幕截图

9. 设置基本安全规则

您最初将 Cloud Firestore 设置为使用测试模式,这意味着您的数据库可以进行读写操作。不过,您应仅在开发的非常早期阶段使用测试模式。最佳实践是,在开发应用时为数据库设置安全规则。安全性应该是应用结构和行为不可或缺的一部分。

通过安全规则,您可以控制对数据库中的文档和集合的访问权限。灵活的规则语法可让您创建适用于以下情况的规则:从对整个数据库执行的所有写入操作到对特定文档执行的操作。

您可以在 Firebase 控制台中为 Cloud Firestore 编写安全规则:

  1. 在 Firebase 控制台的构建部分中,点击 Firestore 数据库,然后选择规则标签页(也可以点击此处直接转到规则标签页)。
  2. 您应该会看到以下默认安全规则,其公开访问权限期限为从今天起几周后。

此步骤的屏幕截图

标识集合

首先,确定应用将数据写入的集合。

  1. 删除现有的 match /{document=**} 子句,使您的规则如下所示:
    rules_version = '2';
    service cloud.firestore {
      match /databases/{database}/documents {
      }
    }
    
  2. match /databases/{database}/documents 中,指定要保护的集合:
    rules_version = '2';
    service cloud.firestore {
      match /databases/{database}/documents {
        match /guestbook/{entry} {
         // You'll add rules here in the next step.
      }
    }
    

添加安全规则

由于您在每个留言板文档中都使用身份验证 UID 作为字段,因此您可以获取身份验证 UID,并验证尝试写入文档的任何人都具有匹配的身份验证 UID。

  1. 将读取和写入规则添加到规则集,如下所示:
    rules_version = '2';
    service cloud.firestore {
      match /databases/{database}/documents {
        match /guestbook/{entry} {
          allow read: if request.auth.uid != null;
          allow create:
            if request.auth.uid == request.resource.data.userId;
        }
      }
    }
    
  2. 点击发布以部署新规则。现在,对于留言板,只有已登录的用户才能阅读消息(任何消息!),但您只能使用用户 ID 创建消息。也不允许修改或删除消息。

添加验证规则

  1. 添加数据验证,确保所有预期字段都显示在文档中:
    rules_version = '2';
    service cloud.firestore {
      match /databases/{database}/documents {
        match /guestbook/{entry} {
          allow read: if request.auth.uid != null;
          allow create:
          if request.auth.uid == request.resource.data.userId
              && "name" in request.resource.data
              && "text" in request.resource.data
              && "timestamp" in request.resource.data;
        }
      }
    }
    
  2. 点击发布以部署新规则。

重置监听器

由于您的应用现在仅允许经过身份验证的用户登录,因此您应将访客簿 firestore 查询移至身份验证监听器内。否则,系统会发生权限错误,并且在用户退出账号时应用会断开连接。

  1. 在 StackBlitz 中,前往 index.js 文件。
  2. 将访客留言集合 onSnapshot 监听器拉入名为 subscribeGuestbook 的新函数中。此外,将 onSnapshot 函数的结果分配给 guestbookListener 变量。

    Firestore onSnapshot 监听器会返回一个取消订阅函数,您稍后可以使用该函数取消快照监听器。
    // ...
    // Listen to guestbook updates
    function subscribeGuestbook() {
      const q = query(collection(db, 'guestbook'), orderBy('timestamp', 'desc'));
      guestbookListener = onSnapshot(q, snaps => {
        // Reset page
        guestbook.innerHTML = '';
        // Loop through documents in database
        snaps.forEach(doc => {
          // Create an HTML entry for each document and add it to the chat
          const entry = document.createElement('p');
          entry.textContent = doc.data().name + ': ' + doc.data().text;
          guestbook.appendChild(entry);
        });
      });
    }
    
  3. 在下面添加一个名为 unsubscribeGuestbook 的新函数。检查 guestbookListener 变量是否不为 null,然后调用函数以取消监听器。
    // ...
    // Unsubscribe from guestbook updates
    function unsubscribeGuestbook() {
      if (guestbookListener != null) {
        guestbookListener();
        guestbookListener = null;
      }
    }
    

最后,将新函数添加到 onAuthStateChanged 回调。

  1. if (user) 底部添加 subscribeGuestbook()
  2. else 语句底部添加 unsubscribeGuestbook()
    // ...
    // Listen to the current Auth state
    onAuthStateChanged(auth, user => {
      if (user) {
        startRsvpButton.textContent = 'LOGOUT';
        // Show guestbook to logged-in users
        guestbookContainer.style.display = 'block';
        // Subscribe to the guestbook collection
        subscribeGuestbook();
      } else {
        startRsvpButton.textContent = 'RSVP';
        // Hide guestbook for non-logged-in users
        guestbookContainer.style.display = 'none';
        // Unsubscribe from the guestbook collection
        unsubscribeGuestbook();
      }
    });
    

10. 额外步骤:练习所学内容

记录参加者的回复状态

目前,只有对活动感兴趣的用户才能在您的应用中发起聊天。此外,要知道他人是否会参加,只有他们在聊天中发布了信息。我们来整理一下,让大家知道有多少人会来。

您需要添加一个切换开关,用于登记希望参加活动的用户,然后收集参加人数。

  1. 在 StackBlitz 中,前往 index.html 文件。
  2. guestbook-container 中,添加一组 YESNO 按钮,如下所示:
    <!-- ... -->
      <section id="guestbook-container">
       <h2>Are you attending?</h2>
         <button id="rsvp-yes">YES</button>
         <button id="rsvp-no">NO</button>
    
       <h2>Discussion</h2>
    
       <!-- ... -->
    
     </section>
    <!-- ... -->
    

应用预览

此步骤的屏幕截图

接下来,注册按钮点击监听器。如果用户点击,则使用其 Authentication UID 将响应保存到数据库。

  1. 在 StackBlitz 中,前往 index.js 文件。
  2. 在顶部,找到 firebase/firestore import 语句,然后添加 docsetDocwhere,如下所示:
    // ...
    // Add the Firebase products and methods that you want to use
    import {
      getFirestore,
      addDoc,
      collection,
      query,
      orderBy,
      onSnapshot,
      doc,
      setDoc,
      where
    } from 'firebase/firestore';
    
  3. main() 函数底部,添加以下代码以监听回复状态:
    async function main() {
      // ...
    
      // Listen to RSVP responses
      rsvpYes.onclick = async () => {
      };
      rsvpNo.onclick = async () => {
      };
    }
    main();
    
    
  4. 接下来,新建一个名为 attendees 的集合,然后在点击任一 RSVP 按钮时注册一个文档引用。根据点击的按钮,将该引用设置为 truefalse

    首先,对于rsvpYes
    // ...
    // Listen to RSVP responses
    rsvpYes.onclick = async () => {
      // Get a reference to the user's document in the attendees collection
      const userRef = doc(db, 'attendees', auth.currentUser.uid);
    
      // If they RSVP'd yes, save a document with attendi()ng: true
      try {
        await setDoc(userRef, {
          attending: true
        });
      } catch (e) {
        console.error(e);
      }
    };
    
    然后,对 rsvpNo 执行相同的操作,但值为 false
    rsvpNo.onclick = async () => {
      // Get a reference to the user's document in the attendees collection
      const userRef = doc(db, 'attendees', auth.currentUser.uid);
    
      // If they RSVP'd yes, save a document with attending: true
      try {
        await setDoc(userRef, {
          attending: false
        });
      } catch (e) {
        console.error(e);
      }
    };
    

更新安全规则

由于您已经设置了一些规则,您使用按钮添加的新数据将被拒绝。

允许向 attendees 集合添加内容

您需要更新相应规则,以允许添加到 attendees 集合中。

  1. 对于 attendees 集合,由于您使用身份验证 UID 作为文档名称,因此您可以抓取该 UID 并验证提交者的 uid 与他们正在编写的文档是否相同。您可以允许所有人读取参加者名单(因为其中没有私密数据),但只有创建者应该能够更新该名单。
    rules_version = '2';
    service cloud.firestore {
      match /databases/{database}/documents {
        // ... //
        match /attendees/{userId} {
          allow read: if true;
          allow write: if request.auth.uid == userId;
        }
      }
    }
    
  2. 点击发布以部署新规则。

添加验证规则

  1. 添加一些数据验证规则,确保文档中包含所有预期字段:
    rules_version = '2';
    service cloud.firestore {
      match /databases/{database}/documents {
        // ... //
        match /attendees/{userId} {
          allow read: if true;
          allow write: if request.auth.uid == userId
              && "attending" in request.resource.data;
    
        }
      }
    }
    
  2. 别忘了点击发布以部署规则!

(可选)现在,您可以查看点击按钮的结果。前往 Firebase 控制台中的 Cloud Firestore 信息中心。

读取回复状态

现在,您已记录回答,接下来我们来看看有哪些人要来,并在界面中反映出来。

  1. 在 StackBlitz 中,前往 index.html 文件。
  2. description-container 中,添加一个 ID 为 number-attending 的新元素。
    <!-- ... -->
    
     <section id="description-container">
         <!-- ... -->
         <p id="number-attending"></p>
     </section>
    
    <!-- ... -->
    

接下来,为 attendees 集合注册监听器,并统计 YES 响应的数量:

  1. 在 StackBlitz 中,前往 index.js 文件。
  2. main() 函数底部,添加以下代码以监听回复状态并统计 YES 点击次数。
    async function main() {
      // ...
    
      // Listen for attendee list
      const attendingQuery = query(
        collection(db, 'attendees'),
        where('attending', '==', true)
      );
      const unsubscribe = onSnapshot(attendingQuery, snap => {
        const newAttendeeCount = snap.docs.length;
        numberAttending.innerHTML = newAttendeeCount + ' people going';
      });
    }
    main();
    

最后,我们来突出显示与当前状态对应的按钮。

  1. 创建一个函数,用于检查当前 Authentication UID 是否在 attendees 集合中有条目,然后将按钮类设置为 clicked
    // ...
    // Listen for attendee list
    function subscribeCurrentRSVP(user) {
      const ref = doc(db, 'attendees', user.uid);
      rsvpListener = onSnapshot(ref, doc => {
        if (doc && doc.data()) {
          const attendingResponse = doc.data().attending;
    
          // Update css classes for buttons
          if (attendingResponse) {
            rsvpYes.className = 'clicked';
            rsvpNo.className = '';
          } else {
            rsvpYes.className = '';
            rsvpNo.className = 'clicked';
          }
        }
      });
    }
    
  2. 此外,我们来创建一个退订函数。系统会在用户退出账号时使用此值。
    // ...
    function unsubscribeCurrentRSVP() {
      if (rsvpListener != null) {
        rsvpListener();
        rsvpListener = null;
      }
      rsvpYes.className = '';
      rsvpNo.className = '';
    }
    
  3. 从 Authentication 监听器调用函数。
    // ...
    // Listen to the current Auth state
      // Listen to the current Auth state
      onAuthStateChanged(auth, user => {
        if (user) {
          startRsvpButton.textContent = 'LOGOUT';
          // Show guestbook to logged-in users
          guestbookContainer.style.display = 'block';
    
          // Subscribe to the guestbook collection
          subscribeGuestbook();
          // Subscribe to the user's RSVP
          subscribeCurrentRSVP(user);
        } else {
          startRsvpButton.textContent = 'RSVP';
          // Hide guestbook for non-logged-in users
          guestbookContainer.style.display = 'none'
          ;
          // Unsubscribe from the guestbook collection
          unsubscribeGuestbook();
          // Unsubscribe from the guestbook collection
          unsubscribeCurrentRSVP();
        }
      });
    
  4. 尝试以多个用户的身份登录,并观察每次点击 YES 按钮时计数增加的情况。

应用预览

此步骤的屏幕截图

11. 恭喜!

您已使用 Firebase 构建了一个交互式实时 Web 应用!

所学内容

  • Firebase Authentication
  • FirebaseUI
  • Cloud Firestore
  • Firebase 安全规则

后续步骤

  • 想要详细了解 Firebase 开发者工作流?如需了解如何完全在本地测试和运行应用,请查看 Firebase 模拟器 Codelab
  • 想详细了解其他 Firebase 产品?也许您想存储用户上传的图片文件?或者向用户发送通知?您可以查看 Firebase Web Codelab,该 Codelab 深入介绍了更多适用于 Web 的 Firebase 产品。
  • 想要详细了解 Cloud Firestore?也许您想了解子集合和事务?前往 Cloud Firestore Web Codelab,深入探索 Cloud Firestore。或者,您也可以观看这 YouTube 系列视频,了解 Cloud Firestore

了解详情

效果如何?

我们期待您的反馈!请在此处填写一份(非常)简短的表单。