1. 概览
在此 Codelab 中,您将学习如何使用 Cloud Functions for Firebase 向聊天应用的用户发送通知,从而为聊天 Web 应用添加功能。
学习内容
- 使用 Firebase SDK 创建 Google Cloud Functions 函数。
- 根据 Auth、Cloud Storage 和 Cloud Firestore 事件触发 Cloud Functions 函数。
- 为您的网页应用添加 Firebase Cloud Messaging 支持。
您需要满足的条件
2. 获取示例代码
从命令行克隆 GitHub 代码库:
git clone https://github.com/firebase/friendlychat
导入 starter 应用
使用 IDE 打开或从示例代码目录导入 cloud-functions-start
目录。此目录包含此 Codelab 的起始代码,其中包含一个功能齐全的 Chat Web 应用。
3. 创建一个 Firebase 项目并设置您的应用
创建项目
在 Firebase 控制台中,点击添加项目,并将其命名为 FriendlyChat。
点击创建项目。
升级到 Blaze 方案
如需使用 Cloud Functions for Firebase 和 Cloud Storage for Firebase,您的 Firebase 项目必须采用随用随付 (Blaze) 定价方案,这意味着该项目需要与一个 Cloud Billing 账号相关联。
- Cloud Billing 账号要求提供付款方式,例如信用卡。
- 如果您刚开始接触 Firebase 和 Google Cloud,请确认您是否有资格获得 $300 赠金和免费试用 Cloud Billing 账号。
- 如果您是在某个活动中学习本 Codelab,请询问组织者是否有 Cloud 抵用金。
如果您没有信用卡,或者不想继续使用 Blaze 定价方案,不妨考虑使用 Firebase Emulator Suite,以便在本地计算机上免费模拟 Cloud Functions。
所有 Firebase 项目(包括采用 Blaze 定价方案的项目)仍可使用 Cloud Functions 的免费用量配额。此 Codelab 中列出的步骤将不会超出免费层级的使用限制。不过,您需要向 Cloud Storage 支付少量费用(约为 $0.03),因为 Cloud Storage 用于托管您的 Cloud Functions 构建映像。
如需将项目升级到 Blaze 方案,请按以下步骤操作:
- 在 Firebase 控制台中,选择升级您的方案。
- 选择 Blaze 方案。按照屏幕上的说明将 Cloud Billing 账号与您的项目相关联。
如果您需要在此升级过程中创建 Cloud Billing 账号,则可能需要返回 Firebase 控制台中的升级流程以完成升级。
启用 Google 身份验证
为了让用户登录应用,我们将使用 Google 身份验证,您需要启用此功能。
在 Firebase 控制台中,依次打开 Build 部分 > Authentication > Sign-in method 标签页(或点击此处前往该标签页)。然后,启用 Google 登录服务提供方,然后点击保存。这样,用户就可以使用其 Google 账号登录网络应用。
此外,您还可以将应用的公开名称设置为 Friendly Chat:
设置 Cloud Storage for Firebase
该应用使用 Cloud Storage 上传图片。
如需在 Firebase 项目中设置 Cloud Storage for Firebase,请按以下步骤操作:
- 在 Firebase 控制台的左侧面板中,展开构建,然后选择存储。
- 点击开始使用。
- 为默认的 Storage 存储分区选择位置。
US-WEST1
、US-CENTRAL1
和US-EAST1
中的存储分区可以使用 Google Cloud Storage 的“始终免费”层级。所有其他位置的存储分区均遵循 Google Cloud Storage 价格和使用量。 - 点击以测试模式启动。阅读有关安全规则的免责声明。
在未为您的存储分区添加安全规则的情况下,请不要公开分发或公开应用。 - 点击创建。
添加 Web 应用
在 Firebase 控制台中,添加 Web 应用。为此,请前往项目设置,然后向下滚动到添加应用。选择 Web 作为平台,然后选中用于设置 Firebase Hosting 的复选框,接着注册应用并点击下一步完成其余步骤,最后点击继续前往控制台。
4. 安装 Firebase 命令行界面
借助 Firebase 命令行界面 (CLI),您可以在本地提供 Web 应用,并部署 Web 应用和 Cloud Functions 函数。
如需安装或升级 CLI,请运行以下 npm 命令:
npm -g install firebase-tools
如需验证 CLI 是否已正确安装,请打开控制台并运行以下命令:
firebase --version
确保 Firebase CLI 的版本高于 4.0.0,这样它才具备 Cloud Functions 所需的全部最新功能。否则,请运行 npm install -g firebase-tools
进行升级,如上所示。
通过运行以下命令授权 Firebase CLI:
firebase login
确保您位于 cloud-functions-start
目录,然后设置 Firebase CLI 以使用您的 Firebase 项目:
firebase use --add
接下来,选择您的项目 ID,并按照说明操作。出现提示时,您可以选择任何别名,例如 codelab
。
5. 部署并运行 Web 应用
现在,您已导入并配置项目,可以首次运行 Web 应用了!打开一个终端窗口,前往 cloud-functions-start
文件夹,然后使用以下命令将 Web 应用部署到 Firebase Hosting:
firebase deploy --except functions
您应该会看到以下控制台输出:
i deploying database, storage, hosting
✔ database: rules ready to deploy.
i storage: checking rules for compilation errors...
✔ storage: rules file compiled successfully
i hosting: preparing ./ directory for upload...
✔ hosting: ./ folder uploaded successfully
✔ storage: rules file compiled successfully
✔ hosting: 8 files uploaded successfully
i starting release process (may take several minutes)...
✔ Deploy complete!
Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview
Hosting URL: https://friendlychat-1234.firebaseapp.com
打开 Web 应用
最后一行应显示托管网址。现在,网络应用应当从此网址提供,网址的格式应为 https://<project-id>.firebaseapp.com。请打开此网址。您应该会看到聊天应用的正常运行界面。
使用使用 Google 账号登录按钮登录应用,然后随意添加一些消息和发布图片:
如果您是在新浏览器中首次登录该应用,请务必在系统提示时允许接收通知:
我们稍后需要您启用通知。
如果您不小心点击了屏蔽,可以通过以下方式更改此设置:点击 Chrome 全局搜索栏中网址左侧的🔒? 安全按钮,然后切换通知旁边的栏:
现在,我们将使用 Firebase SDK for Cloud Functions 添加一些功能。
6. 函数目录
借助 Cloud Functions,您可以轻松在云端运行代码,而无需设置服务器。我们将介绍如何构建函数来响应 Firebase Auth、Cloud Storage 和 Firebase Firestore 数据库事件。我们先从身份验证开始。
使用 Firebase SDK for Cloud Functions 时,您的函数代码将位于 functions
目录下(默认)。您的 Functions 代码也是一个 Node.js 应用,因此需要一个 package.json
,用于提供有关应用的一些信息并列出依赖项。
为方便起见,我们已创建用于存放代码的 functions/index.js
文件。在继续操作之前,您可以随意检查此文件。
cd functions
ls
如果您不熟悉 Node.js,建议您先详细了解一下,然后再继续本 Codelab。
package.json
文件中已列出两个必需的依赖项:Firebase SDK for Cloud Functions 和 Firebase Admin SDK。如需在本地安装这些依赖项,请前往 functions
文件夹并运行以下命令:
npm install
现在,我们来看看 index.js
文件:
index.js
/**
* Copyright 2017 Google Inc. All Rights Reserved.
* ...
*/
// TODO(DEVELOPER): Import the Cloud Functions for Firebase and the Firebase Admin modules here.
// TODO(DEVELOPER): Write the addWelcomeMessage Function here.
// TODO(DEVELOPER): Write the blurImages Function here.
// TODO(DEVELOPER): Write the sendNotification Function here.
我们将导入所需的模块,然后编写三个函数来替换 TODO。首先,导入所需的 Node 模块。
7. 导入 Cloud Functions 和 Firebase Admin 模块
在本 Codelab 中,您需要使用两个模块:firebase-functions
用于编写 Cloud Functions 触发器和日志,firebase-admin
用于在具有管理员访问权限的服务器上使用 Firebase 平台执行写入 Cloud Firestore 或发送 FCM 通知等操作。
在 index.js
文件中,将第一个 TODO
替换为以下内容:
index.js
/**
* Copyright 2017 Google Inc. All Rights Reserved.
* ...
*/
// Import the Firebase SDK for Google Cloud Functions.
const functions = require('firebase-functions');
// Import and initialize the Firebase Admin SDK.
const admin = require('firebase-admin');
admin.initializeApp();
// TODO(DEVELOPER): Write the addWelcomeMessage Function here.
// TODO(DEVELOPER): Write the blurImages Function here.
// TODO(DEVELOPER): Write the sendNotification Function here.
部署到 Cloud Functions 环境或其他 Google Cloud Platform 容器时,Firebase Admin SDK 可以自动配置,当我们不带任何参数调用 admin.initializeApp()
时,就会发生这种情况。
现在,我们来添加一个函数,在用户首次登录聊天应用时运行该函数,并添加一条欢迎用户的聊天消息。
8. 欢迎新用户
Chat 消息结构
发布到 FriendlyChat 聊天信息流的消息会存储在 Cloud Firestore 中。我们来看看消息所用的数据结构。为此,请在聊天中发布一条内容为“Hello World”的新消息:
这应显示为:
在 Firebase 控制台中,点击 Build 部分下的 Firestore 数据库。您应该会看到“messages”集合以及包含您写入的消息的一个文档:
如您所见,聊天消息会作为文档存储在 Cloud Firestore 中,并将 name
、profilePicUrl
、text
和 timestamp
属性添加到 messages
集合。
添加欢迎消息
第一个 Cloud Functions 函数会添加一条欢迎新用户加入聊天的消息。为此,我们可以使用触发器 functions.auth().onCreate
,该触发器会在用户首次在 Firebase 应用中登录时运行函数。将 addWelcomeMessages
函数添加到 index.js
文件中:
index.js
// Adds a message that welcomes new users into the chat.
exports.addWelcomeMessages = functions.auth.user().onCreate(async (user) => {
functions.logger.log('A new user signed in for the first time.');
const fullName = user.displayName || 'Anonymous';
// Saves the new welcome message into the database
// which then displays it in the FriendlyChat clients.
await admin.firestore().collection('messages').add({
name: 'Firebase Bot',
profilePicUrl: '/images/firebase-logo.png', // Firebase logo
text: `${fullName} signed in for the first time! Welcome!`,
timestamp: admin.firestore.FieldValue.serverTimestamp(),
});
functions.logger.log('Welcome message written to database.');
});
将此函数添加到特殊的 exports
对象是 Node 让函数在当前文件之外可访问的方式,对于 Cloud Functions 而言,这是必需的。
在上面的函数中,我们将向聊天消息列表中添加由“Firebase Bot”发布的新欢迎消息。为此,我们将对 Cloud Firestore 中的 messages
集合(聊天消息的存储位置)使用 add
方法。
由于这是一项异步操作,因此我们需要返回一个 Promise,指明 Cloud Firestore 何时完成写入,以免 Cloud Functions 函数过早执行。
部署 Cloud Functions 函数
Cloud Functions 函数只有在部署后才会生效。为此,请在命令行中运行以下命令:
firebase deploy --only functions
您应该会看到以下控制台输出:
i deploying functions
i functions: ensuring necessary APIs are enabled...
⚠ functions: missing necessary APIs. Enabling now...
i env: ensuring necessary APIs are enabled...
⚠ env: missing necessary APIs. Enabling now...
i functions: waiting for APIs to activate...
i env: waiting for APIs to activate...
✔ env: all necessary APIs are enabled
✔ functions: all necessary APIs are enabled
i functions: preparing functions directory for uploading...
i functions: packaged functions (X.XX KB) for uploading
✔ functions: functions folder uploaded successfully
i starting release process (may take several minutes)...
i functions: creating function addWelcomeMessages...
✔ functions[addWelcomeMessages]: Successful create operation.
✔ functions: all functions deployed successfully!
✔ Deploy complete!
Project Console: https://console.firebase.google.com/project/friendlypchat-1234/overview
测试函数
函数成功部署后,您需要让用户首次登录。
- 使用托管网址(采用
https://<project-id>.firebaseapp.com
格式)在浏览器中打开您的应用。 - 使用新用户首次在您的应用中登录,并使用登录按钮。
- 如果您已登录应用,可以打开 Firebase 控制台 Authentication,然后从用户列表中删除您的账号。然后,重新登录。
- 登录后,系统应会自动显示欢迎消息:
9. 图片审核
用户可以在聊天中上传各种类型的图片,因此请务必审核冒犯性图片,尤其是在公共社交平台上。在 FriendlyChat 中,发布到聊天中的图片会存储到 Cloud Storage 存储分区中。
借助 Cloud Functions,您可以使用 functions.storage().onFinalize
触发器检测上传的新图片。每当在 Cloud Storage 中上传或修改新文件时,此函数都会运行。
如需审核图片,我们将按照以下流程操作:
- 使用 Cloud Vision API 检查图片是否被标记为成人内容或暴力内容。
- 如果图片已被标记,请将其下载到正在运行的 Functions 实例中。
- 使用 ImageMagick 对图片进行模糊处理。
- 将经过模糊处理的图片上传到 Cloud Storage。
启用 Cloud Vision API
由于我们将在此函数中使用 Google Cloud Vision API,因此您必须在 Firebase 项目中启用该 API。点击此链接,然后选择您的 Firebase 项目并启用该 API:
安装依赖项
为了审核图片,我们将使用适用于 Node.js 的 Google Cloud Vision 客户端库 @google-cloud/vision,通过 Cloud Vision API 运行图片以检测不当图片。
如需将此软件包安装到您的 Cloud Functions 应用中,请运行以下 npm install --save
命令。请务必从 functions
目录中执行此操作。
npm install --save @google-cloud/vision@2.4.0
这将在本地安装该软件包,并将其作为声明的依赖项添加到 package.json
文件中。
导入和配置依赖项
如需导入已安装的依赖项以及我们在本部分中需要的一些 Node.js 核心模块(path
、os
和 fs
),请将以下行添加到 index.js
文件的顶部:
index.js
const Vision = require('@google-cloud/vision');
const vision = new Vision.ImageAnnotatorClient();
const {promisify} = require('util');
const exec = promisify(require('child_process').exec);
const path = require('path');
const os = require('os');
const fs = require('fs');
由于您的函数将在 Google Cloud 环境中运行,因此无需配置 Cloud Storage 和 Cloud Vision 库:系统会自动将其配置为使用您的项目。
检测不当图片
您将使用 functions.storage.onChange
Cloud Functions 触发器,该触发器会在 Cloud Storage 存储分区中创建或修改文件或文件夹后立即运行您的代码。将 blurOffensiveImages
函数添加到 index.js
文件中:
index.js
// Checks if uploaded images are flagged as Adult or Violence and if so blurs them.
exports.blurOffensiveImages = functions.runWith({memory: '2GB'}).storage.object().onFinalize(
async (object) => {
const imageUri = `gs://${object.bucket}/${object.name}`;
// Check the image content using the Cloud Vision API.
const batchAnnotateImagesResponse = await vision.safeSearchDetection(imageUri);
const safeSearchResult = batchAnnotateImagesResponse[0].safeSearchAnnotation;
const Likelihood = Vision.protos.google.cloud.vision.v1.Likelihood;
if (Likelihood[safeSearchResult.adult] >= Likelihood.LIKELY ||
Likelihood[safeSearchResult.violence] >= Likelihood.LIKELY) {
functions.logger.log('The image', object.name, 'has been detected as inappropriate.');
return blurImage(object.name);
}
functions.logger.log('The image', object.name, 'has been detected as OK.');
});
请注意,我们为将运行该函数的 Cloud Functions 实例添加了一些配置。使用 .runWith({memory: '2GB'})
时,我们会请求为实例分配 2GB 内存(而不是默认值),因为此函数需要大量内存。
触发该函数后,系统会通过 Cloud Vision API 运行图片,以检测图片是否被标记为成人或暴力内容。如果根据这些条件检测到图片不当,我们会模糊处理图片,具体是在 blurImage
函数中完成的,我们将在下文中介绍。
模糊处理图片
在 index.js
文件中添加以下 blurImage
函数:
index.js
// Blurs the given image located in the given bucket using ImageMagick.
async function blurImage(filePath) {
const tempLocalFile = path.join(os.tmpdir(), path.basename(filePath));
const messageId = filePath.split(path.sep)[1];
const bucket = admin.storage().bucket();
// Download file from bucket.
await bucket.file(filePath).download({destination: tempLocalFile});
functions.logger.log('Image has been downloaded to', tempLocalFile);
// Blur the image using ImageMagick.
await exec(`convert "${tempLocalFile}" -channel RGBA -blur 0x24 "${tempLocalFile}"`);
functions.logger.log('Image has been blurred');
// Uploading the Blurred image back into the bucket.
await bucket.upload(tempLocalFile, {destination: filePath});
functions.logger.log('Blurred image has been uploaded to', filePath);
// Deleting the local file to free up disk space.
fs.unlinkSync(tempLocalFile);
functions.logger.log('Deleted local file.');
// Indicate that the message has been moderated.
await admin.firestore().collection('messages').doc(messageId).update({moderated: true});
functions.logger.log('Marked the image as moderated in the database.');
}
在上面的函数中,系统会从 Cloud Storage 下载图片二进制文件。然后,系统会使用 ImageMagick 的 convert
工具对图片进行模糊处理,并将经过模糊处理的版本重新上传到存储分区。接下来,我们会删除 Cloud Functions 实例上的文件以释放一些磁盘空间。之所以这样做,是因为同一 Cloud Functions 实例可以重复使用,如果不清理文件,它可能会耗尽磁盘空间。最后,我们向聊天消息添加一个布尔值,指明图片已通过审核,这将触发客户端上消息的刷新。
部署函数
只有在您部署函数后,该函数才会处于活动状态。在命令行中,运行 firebase deploy --only functions
:
firebase deploy --only functions
您应该会看到以下控制台输出:
i deploying functions
i functions: ensuring necessary APIs are enabled...
✔ functions: all necessary APIs are enabled
i functions: preparing functions directory for uploading...
i functions: packaged functions (X.XX KB) for uploading
✔ functions: functions folder uploaded successfully
i starting release process (may take several minutes)...
i functions: updating function addWelcomeMessages...
i functions: creating function blurOffensiveImages...
✔ functions[addWelcomeMessages]: Successful update operation.
✔ functions[blurOffensiveImages]: Successful create operation.
✔ functions: all functions deployed successfully!
✔ Deploy complete!
Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview
测试函数
函数成功部署后:
- 使用托管网址(采用
https://<project-id>.firebaseapp.com
格式)在浏览器中打开您的应用。 - 登录应用后,上传图片:
- 选择要上传的最好看的冒犯性图片(您也可以使用这张肉食僵尸!),几秒钟后,您应该会看到帖子刷新,并显示图片的模糊处理版本:
10. 新消息通知
在本部分中,您将添加一个 Cloud Functions 函数,以便在有新消息发布时向聊天参与者发送通知。
借助 Firebase Cloud Messaging (FCM),您可以向各个平台上的用户可靠地发送通知。如需向用户发送通知,您需要其 FCM 设备令牌。我们使用的聊天 Web 应用在用户首次在新浏览器或设备上打开该应用时,已经会收集用户的设备令牌。这些令牌存储在 Cloud Firestore 的 fcmTokens
集合中。
如需了解如何在 Web 应用中获取 FCM 设备令牌,您可以查看 Firebase Web Codelab。
发送通知
如需检测何时发布了新消息,您将使用 functions.firestore.document().onCreate
Cloud Functions 触发器,该触发器会在 Cloud Firestore 的给定路径中创建新对象时运行您的代码。将 sendNotifications
函数添加到 index.js
文件中:
index.js
// Sends a notifications to all users when a new message is posted.
exports.sendNotifications = functions.firestore.document('messages/{messageId}').onCreate(
async (snapshot) => {
// Notification details.
const text = snapshot.data().text;
const payload = {
notification: {
title: `${snapshot.data().name} posted ${text ? 'a message' : 'an image'}`,
body: text ? (text.length <= 100 ? text : text.substring(0, 97) + '...') : '',
icon: snapshot.data().profilePicUrl || '/images/profile_placeholder.png',
click_action: `https://${process.env.GCLOUD_PROJECT}.firebaseapp.com`,
}
};
// Get the list of device tokens.
const allTokens = await admin.firestore().collection('fcmTokens').get();
const tokens = [];
allTokens.forEach((tokenDoc) => {
tokens.push(tokenDoc.id);
});
if (tokens.length > 0) {
// Send notifications to all tokens.
const response = await admin.messaging().sendToDevice(tokens, payload);
await cleanupTokens(response, tokens);
functions.logger.log('Notifications have been sent and tokens cleaned up.');
}
});
在上面的函数中,我们会从 Cloud Firestore 数据库中收集所有用户的设备令牌,并使用 admin.messaging().sendToDevice
函数向每个用户发送通知。
清理令牌
最后,我们要移除不再有效的令牌。如果浏览器或设备不再使用我们从用户那里获取的令牌,就会发生这种情况。例如,如果用户撤消了浏览器会话的通知权限,就会发生这种情况。为此,请在 index.js
文件中添加以下 cleanupTokens
函数:
index.js
// Cleans up the tokens that are no longer valid.
function cleanupTokens(response, tokens) {
// For each notification we check if there was an error.
const tokensDelete = [];
response.results.forEach((result, index) => {
const error = result.error;
if (error) {
functions.logger.error('Failure sending notification to', tokens[index], error);
// Cleanup the tokens that are not registered anymore.
if (error.code === 'messaging/invalid-registration-token' ||
error.code === 'messaging/registration-token-not-registered') {
const deleteTask = admin.firestore().collection('fcmTokens').doc(tokens[index]).delete();
tokensDelete.push(deleteTask);
}
}
});
return Promise.all(tokensDelete);
}
部署函数
该函数只有在部署后才会处于活动状态。如需部署该函数,请在命令行中运行以下命令:
firebase deploy --only functions
您应该会看到以下控制台输出:
i deploying functions
i functions: ensuring necessary APIs are enabled...
✔ functions: all necessary APIs are enabled
i functions: preparing functions directory for uploading...
i functions: packaged functions (X.XX KB) for uploading
✔ functions: functions folder uploaded successfully
i starting release process (may take several minutes)...
i functions: updating function addWelcomeMessages...
i functions: updating function blurOffensiveImages...
i functions: creating function sendNotifications...
✔ functions[addWelcomeMessages]: Successful update operation.
✔ functions[blurOffensiveImages]: Successful updating operation.
✔ functions[sendNotifications]: Successful create operation.
✔ functions: all functions deployed successfully!
✔ Deploy complete!
Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview
测试函数
- 函数成功部署后,使用托管网址(格式为
https://<project-id>.firebaseapp.com
)在浏览器中打开您的应用。 - 如果您是首次登录该应用,请务必在系统提示时允许显示通知:
- 关闭聊天应用标签页或显示其他标签页:只有当应用在后台运行时,才会显示通知。如需了解如何在应用在前台运行时接收消息,请参阅我们的文档。
- 使用其他浏览器(或无痕式窗口)登录该应用并发布消息。您应该会看到第一个浏览器显示的通知:
11. 恭喜!
您已使用 Firebase SDK for Cloud Functions 并向聊天应用添加了服务器端组件。
所学内容
- 使用 Firebase SDK for Cloud Functions 编写 Cloud Functions 函数。
- 根据 Auth、Cloud Storage 和 Cloud Firestore 事件触发 Cloud Functions 函数。
- 为您的网页应用添加 Firebase Cloud Messaging 支持。
- 使用 Firebase CLI 部署 Cloud Functions 函数。
后续步骤
- 了解其他 Cloud Functions 触发器类型。
- 将 Firebase 和 Cloud Functions 与您自己的应用搭配使用。