1. Khái quát chung
Trong phòng học lập trình này, bạn sẽ tìm hiểu cách sử dụng Chức năng đám mây cho Firebase để thêm chức năng vào ứng dụng web trò chuyện bằng cách gửi thông báo cho người dùng ứng dụng trò chuyện.
Bạn sẽ học được gì
- Tạo Google Cloud Function bằng SDK Firebase.
- Kích hoạt các chức năng đám mây dựa trên các sự kiện Auth, Cloud Storage và Cloud Firestore.
- Thêm hỗ trợ Nhắn tin qua đám mây Firebase vào ứng dụng web của bạn.
Những gì bạn cần
- Một thẻ tín dụng. Chức năng đám mây cho Firebase yêu cầu gói Firebase Blaze, có nghĩa là bạn sẽ phải bật tính năng thanh toán cho dự án Firebase của mình bằng thẻ tín dụng.
- IDE/trình soạn thảo văn bản mà bạn chọn, chẳng hạn như WebStorm , Atom hoặc Sublime .
- Một thiết bị đầu cuối để chạy các lệnh shell đã cài đặt NodeJS v9.
- Một trình duyệt chẳng hạn như Chrome.
- Mã mẫu. Xem bước tiếp theo cho việc này.
2. Lấy mã mẫu
Sao chép kho lưu trữ GitHub từ dòng lệnh:
git clone https://github.com/firebase/friendlychat
Nhập ứng dụng khởi động
Sử dụng IDE của bạn, mở hoặc nhập tệp thư mục
cloud-functions-start
từ thư mục mã mẫu. Thư mục này chứa mã bắt đầu cho phòng học mã bao gồm Ứng dụng Web Trò chuyện đầy đủ chức năng.
3. Tạo dự án Firebase và Thiết lập ứng dụng của bạn
Tạo dự án
Trong Firebase Console , nhấp vào Add Project và gọi nó là FriendlyChat .
Nhấp vào Tạo dự án .
Nâng cấp lên gói Blaze
Để sử dụng Chức năng đám mây cho Firebase, bạn sẽ phải nâng cấp dự án Firebase của mình lên gói thanh toán Blaze . Điều này sẽ yêu cầu bạn thêm thẻ tín dụng hoặc công cụ thanh toán khác vào tài khoản Google Cloud của mình.
Tất cả các dự án Firebase, kể cả những dự án trong gói Blaze, vẫn có quyền truy cập hạn ngạch sử dụng miễn phí cho Chức năng đám mây. Các bước được nêu trong phòng thí nghiệm mã hóa này sẽ nằm trong giới hạn sử dụng của bậc miễn phí. Tuy nhiên, bạn sẽ thấy các khoản phí nhỏ ( khoảng $0,03 ) từ Cloud Storage được sử dụng để lưu trữ hình ảnh bản dựng Cloud Function của bạn.
Nếu bạn không có quyền truy cập vào thẻ tín dụng hoặc không thoải mái khi tiếp tục với gói Blaze, hãy cân nhắc sử dụng Bộ giả lập Firebase cho phép bạn mô phỏng Chức năng đám mây miễn phí trên máy cục bộ của mình.
Bật Google Auth
Để cho phép người dùng đăng nhập ứng dụng, chúng tôi sẽ sử dụng Google auth cần được bật.
Trong Bảng điều khiển Firebase, hãy mở phần Bản dựng > Xác thực > tab Phương thức đăng nhập (hoặc nhấp vào đây để đến đó). Sau đó, bật Nhà cung cấp dịch vụ đăng nhập Google và nhấp vào Lưu . Điều này sẽ cho phép người dùng đăng nhập vào ứng dụng web bằng tài khoản Google của họ.
Ngoài ra, vui lòng đặt tên hiển thị công khai cho ứng dụng của bạn thành Trò chuyện thân thiện :
Kích hoạt lưu trữ đám mây
Ứng dụng sử dụng Cloud Storage để tải ảnh lên. Để bật Lưu trữ đám mây trên dự án Firebase của bạn, hãy truy cập phần Lưu trữ và nhấp vào nút Bắt đầu . Thực hiện các bước ở đó và đối với vị trí Lưu trữ đám mây, sẽ có một giá trị mặc định để sử dụng. Nhấp vào Xong sau đó.
Thêm một ứng dụng web
Trên Bảng điều khiển Firebase, hãy thêm một ứng dụng web. Để làm như vậy, hãy chuyển đến Cài đặt dự án và cuộn xuống Thêm ứng dụng . Chọn web làm nền tảng và chọn hộp để thiết lập Lưu trữ Firebase, sau đó đăng ký ứng dụng và nhấp vào Tiếp theo để thực hiện các bước còn lại, cuối cùng nhấp vào Tiếp tục đến bảng điều khiển .
4. Cài đặt giao diện dòng lệnh Firebase
Giao diện dòng lệnh Firebase (CLI) sẽ cho phép bạn phân phối ứng dụng web cục bộ và triển khai ứng dụng web cũng như Chức năng đám mây của bạn.
Để cài đặt hoặc nâng cấp CLI, hãy chạy lệnh npm sau:
npm -g install firebase-tools
Để xác minh rằng CLI đã được cài đặt chính xác, hãy mở bảng điều khiển và chạy:
firebase --version
Đảm bảo phiên bản Firebase CLI trên 4.0.0 để phiên bản này có tất cả các tính năng mới nhất cần thiết cho Chức năng đám mây. Nếu không, hãy chạy npm install -g firebase-tools
để nâng cấp như hình trên.
Cấp quyền cho Firebase CLI bằng cách chạy:
firebase login
Đảm bảo rằng bạn đang ở trong thư mục cloud-functions-start
, sau đó thiết lập CLI Firebase để sử dụng Dự án Firebase của bạn:
firebase use --add
Tiếp theo, chọn ID dự án của bạn và làm theo hướng dẫn. Khi được nhắc, bạn có thể chọn bất kỳ Bí danh nào, chẳng hạn như codelab
.
5. Triển khai và chạy ứng dụng web
Bây giờ bạn đã nhập và định cấu hình dự án của mình, bạn đã sẵn sàng chạy ứng dụng web lần đầu tiên! Mở một cửa sổ đầu cuối, điều hướng đến thư mục cloud-functions-start
và triển khai ứng dụng web lên dịch vụ lưu trữ Firebase bằng cách sử dụng:
firebase deploy --except functions
Đây là đầu ra giao diện điều khiển bạn sẽ thấy:
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
Mở ứng dụng web
Dòng cuối cùng sẽ hiển thị URL lưu trữ. Bây giờ, ứng dụng web sẽ được cung cấp từ URL này, URL này phải có dạng https://<project-id>.firebaseapp.com. Mở nó ra. Bạn sẽ thấy giao diện người dùng đang hoạt động của ứng dụng trò chuyện.
Đăng nhập vào ứng dụng bằng cách sử dụng nút ĐĂNG NHẬP BẰNG GOOGLE và thoải mái thêm một số tin nhắn và đăng hình ảnh:
Nếu bạn đăng nhập ứng dụng lần đầu tiên trên một trình duyệt mới, hãy đảm bảo rằng bạn cho phép thông báo khi được nhắc:
Chúng tôi sẽ cần bật thông báo sau này.
Nếu bạn đã vô tình nhấp vào Chặn , bạn có thể thay đổi cài đặt này bằng cách nhấp vào nút 🔒 Bảo mật ở bên trái của URL trong Thanh địa chỉ của Chrome và chuyển đổi thanh bên cạnh Thông báo :
Bây giờ, chúng tôi sẽ thêm một số chức năng bằng SDK Firebase cho Chức năng đám mây.
6. Thư mục chức năng
Chức năng đám mây cho phép bạn dễ dàng có mã chạy trong Đám mây mà không cần phải thiết lập máy chủ. Chúng ta sẽ tìm hiểu cách xây dựng các chức năng phản ứng với các sự kiện cơ sở dữ liệu Firebase Auth, Cloud Storage và Firebase Firestore. Hãy bắt đầu với Auth.
Khi sử dụng SDK Firebase cho Chức năng đám mây, mã Chức năng của bạn sẽ nằm trong thư mục functions
(theo mặc định). Mã Hàm của bạn cũng là một ứng dụng Node.js và do đó cần một package.json
cung cấp một số thông tin về ứng dụng của bạn và liệt kê các thành phần phụ thuộc.
Để giúp bạn dễ dàng hơn, chúng tôi đã tạo tệp functions/index.js
nơi mã của bạn sẽ được chuyển đến. Vui lòng kiểm tra tệp này trước khi tiếp tục.
cd functions
ls
Nếu bạn không quen thuộc với Node.js , tìm hiểu thêm về nó trước khi tiếp tục học mã sẽ rất hữu ích.
Tệp package.json
đã liệt kê hai thành phần phụ thuộc bắt buộc: SDK Firebase cho Chức năng đám mây và SDK quản trị Firebase . Để cài đặt chúng cục bộ, hãy chuyển đến thư mục functions
và chạy:
npm install
Bây giờ chúng ta hãy xem tệp 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.
Chúng tôi sẽ nhập các mô-đun cần thiết và sau đó viết ba Chức năng thay cho TODO. Hãy bắt đầu với việc nhập các mô-đun Node cần thiết.
7. Nhập mô-đun Cloud Function và Firebase Admin
Hai mô-đun sẽ được yêu cầu trong phòng thí nghiệm lập trình này: firebase-functions
cho phép ghi nhật ký và trình kích hoạt Chức năng đám mây trong khi firebase-admin
cho phép sử dụng nền tảng Firebase trên máy chủ có quyền truy cập của quản trị viên để thực hiện các hành động như ghi vào Cloud Firestore hoặc gửi thông báo FCM.
Trong tệp index.js
, hãy thay thế TODO
đầu tiên bằng nội dung sau:
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.
SDK quản trị Firebase có thể được định cấu hình tự động khi được triển khai trong môi trường Chức năng đám mây hoặc bộ chứa Google Cloud Platform khác và điều này xảy ra khi chúng tôi gọi admin.initializeApp()
mà không có đối số.
Bây giờ, hãy thêm một Chức năng chạy khi người dùng đăng nhập lần đầu tiên trong ứng dụng trò chuyện và chúng tôi sẽ thêm một tin nhắn trò chuyện để chào mừng người dùng.
8. Chào mừng người dùng mới
Cấu trúc tin nhắn trò chuyện
Các tin nhắn được đăng lên nguồn cấp dữ liệu trò chuyện FriendlyChat được lưu trữ trong Cloud Firestore. Hãy xem cấu trúc dữ liệu chúng tôi sử dụng cho một tin nhắn. Để thực hiện việc này, hãy đăng một tin nhắn mới lên cuộc trò chuyện có nội dung "Xin chào thế giới":
Điều này sẽ xuất hiện dưới dạng:
Trong Bảng điều khiển Firebase, nhấp vào Cơ sở dữ liệu Firestore trong phần Xây dựng . Bạn sẽ thấy bộ sưu tập tin nhắn và một tài liệu chứa tin nhắn mà bạn đã viết:
Như bạn có thể thấy, tin nhắn trò chuyện được lưu trữ trong Cloud Firestore dưới dạng tài liệu với các thuộc name
, profilePicUrl
, text
và timestamp
được thêm vào bộ sưu messages
.
Thêm tin nhắn chào mừng
Chức năng đám mây đầu tiên thêm thông báo chào mừng người dùng mới tham gia trò chuyện. Đối với điều này, chúng ta có thể sử dụng trình kích hoạt functions.auth().onCreate
, chức năng này sẽ chạy chức năng này mỗi khi người dùng đăng nhập lần đầu tiên trong ứng dụng Firebase. Thêm chức năng addWelcomeMessages
vào tệp index.js
của bạn:
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.');
});
Việc thêm chức năng này vào đối tượng exports
đặc biệt là cách Node giúp chức năng này có thể truy cập được bên ngoài tệp hiện tại và là bắt buộc đối với Chức năng đám mây.
Trong chức năng trên, chúng tôi đang thêm một thông báo chào mừng mới được đăng bởi "Firebase Bot" vào danh sách các tin nhắn trò chuyện. Chúng tôi đang thực hiện việc này bằng cách sử dụng phương thức add
trên bộ sưu messages
trong Cloud Firestore, đây là nơi lưu trữ các tin nhắn của cuộc trò chuyện.
Vì đây là một hoạt động không đồng bộ, chúng tôi cần trả lại Lời hứa cho biết khi nào Cloud Firestore đã viết xong để các Hàm trên đám mây không thực thi quá sớm.
Triển khai chức năng đám mây
Chức năng đám mây sẽ chỉ hoạt động sau khi bạn đã triển khai chúng. Để làm như vậy, hãy chạy nó trên dòng lệnh:
firebase deploy --only functions
Đây là đầu ra giao diện điều khiển bạn sẽ thấy:
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
Kiểm tra chức năng
Khi chức năng đã được triển khai thành công, bạn sẽ cần có người dùng đăng nhập lần đầu tiên.
- Mở ứng dụng của bạn trong trình duyệt bằng URL lưu trữ (ở dạng
https://<project-id>.firebaseapp.com
). - Với người dùng mới, hãy đăng nhập lần đầu tiên trong ứng dụng của bạn bằng nút Đăng nhập .
- Nếu bạn đã đăng nhập vào ứng dụng, bạn có thể mở Xác thực bảng điều khiển Firebase và xóa tài khoản của mình khỏi danh sách người dùng. Sau đó, đăng nhập lại.
- Sau khi bạn đăng nhập, một thông báo chào mừng sẽ tự động hiển thị:
9. Kiểm duyệt hình ảnh
Người dùng có thể tải lên tất cả các loại hình ảnh trong cuộc trò chuyện và điều quan trọng là luôn kiểm duyệt những hình ảnh phản cảm, đặc biệt là trên các nền tảng xã hội công cộng. Trong FriendlyChat, những hình ảnh đang được xuất bản lên cuộc trò chuyện được lưu trữ trong Google Cloud Storage .
Với Cloud Functions, bạn có thể phát hiện các hình ảnh mới tải lên bằng cách sử dụng trình kích hoạt functions.storage().onFinalize
. Điều này sẽ chạy mỗi khi một tệp mới được tải lên hoặc sửa đổi trong Cloud Storage.
Để kiểm duyệt hình ảnh, chúng tôi sẽ thực hiện quy trình sau:
- Kiểm tra xem hình ảnh có bị gắn cờ là Người lớn hoặc Bạo lực hay không bằng API Cloud Vision .
- Nếu hình ảnh đã được gắn cờ, hãy tải xuống trên phiên bản Hàm đang chạy.
- Làm mờ hình ảnh bằng ImageMagick .
- Tải hình ảnh mờ lên Cloud Storage.
Bật API Cloud Vision
Vì chúng tôi sẽ sử dụng Google Cloud Vision API trong chức năng này nên bạn phải bật API trên dự án firebase của mình. Theo liên kết này , sau đó chọn dự án Firebase của bạn và bật API:
Cài đặt phụ thuộc
Để kiểm duyệt hình ảnh, chúng tôi sẽ sử dụng Thư viện ứng dụng Google Cloud Vision dành cho Node.js, @google-cloud/vision , để chạy hình ảnh thông qua API Cloud Vision nhằm phát hiện hình ảnh không phù hợp.
Để cài đặt gói này vào ứng dụng Chức năng đám mây của bạn, hãy chạy lệnh npm install --save
sau. Đảm bảo rằng bạn thực hiện việc này từ thư mục functions
.
npm install --save @google-cloud/vision@2.4.0
Thao tác này sẽ cài đặt gói cục bộ và thêm chúng dưới dạng phần phụ thuộc đã khai báo trong tệp package.json
của bạn.
Nhập và định cấu hình phụ thuộc
Để nhập các phần phụ thuộc đã được cài đặt và một số mô-đun lõi Node.js ( path
, os
và fs
) mà chúng ta sẽ cần trong phần này, hãy thêm các dòng sau vào đầu tệp index.js
của bạn:
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');
Vì chức năng của bạn sẽ chạy bên trong môi trường Google Cloud nên không cần định cấu hình thư viện Cloud Storage và Cloud Vision: chúng sẽ được định cấu hình tự động để sử dụng dự án của bạn.
Phát hiện hình ảnh không phù hợp
Bạn sẽ sử dụng trình kích hoạt functions.storage.onChange
Cloud Function, trình kích hoạt này sẽ chạy mã của bạn ngay khi một tệp hoặc thư mục được tạo hoặc sửa đổi trong bộ chứa Cloud Storage. Thêm chức năng blurOffensiveImages
vào tệp index.js
của bạn:
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.');
});
Lưu ý rằng chúng tôi đã thêm một số cấu hình của phiên bản Chức năng đám mây sẽ chạy chức năng này. Với .runWith({memory: '2GB'})
, chúng tôi yêu cầu phiên bản đó có bộ nhớ 2GB thay vì mặc định, vì chức năng này sử dụng nhiều bộ nhớ.
Khi chức năng này được kích hoạt, hình ảnh sẽ chạy qua Cloud Vision API để phát hiện xem nó có bị gắn cờ là người lớn hoặc bạo lực hay không. Nếu hình ảnh được phát hiện là không phù hợp dựa trên các tiêu chí này, chúng tôi sẽ làm mờ hình ảnh, điều này được thực hiện trong chức năng blurImage
như chúng ta sẽ thấy tiếp theo.
Làm mờ hình ảnh
Thêm chức năng blurImage
sau vào tệp index.js
của bạn:
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.');
}
Trong chức năng trên, tệp nhị phân hình ảnh được tải xuống từ Cloud Storage. Hình ảnh sau đó được làm mờ bằng công cụ convert
của ImageMagick và phiên bản làm mờ được tải lên lại trên Bộ lưu trữ. Tiếp theo, chúng tôi xóa tệp trên phiên bản Cloud Function để giải phóng một số dung lượng ổ đĩa và chúng tôi làm điều này vì cùng một phiên bản Cloud Function có thể được sử dụng lại và nếu các tệp không được dọn sạch, nó có thể hết dung lượng ổ đĩa. Cuối cùng, chúng tôi thêm một boolean vào tin nhắn trò chuyện cho biết hình ảnh đã được kiểm duyệt và điều này sẽ kích hoạt làm mới tin nhắn trên máy khách.
Triển khai chức năng
Chức năng sẽ chỉ hoạt động sau khi bạn đã triển khai nó. Trên dòng lệnh, hãy chạy firebase deploy --only functions
:
firebase deploy --only functions
Đây là đầu ra giao diện điều khiển bạn sẽ thấy:
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
Kiểm tra chức năng
Khi chức năng đã triển khai thành công:
- Mở ứng dụng của bạn trong trình duyệt bằng URL lưu trữ (ở dạng
https://<project-id>.firebaseapp.com
). - Sau khi đăng nhập vào ứng dụng, hãy tải lên một hình ảnh:
- Chọn hình ảnh xúc phạm tốt nhất của bạn để tải lên (hoặc bạn có thể sử dụng Zombie ăn thịt này!) và sau một lúc, bạn sẽ thấy bài đăng của mình được làm mới với phiên bản mờ của hình ảnh:
10. Thông báo tin nhắn mới
Trong phần này, bạn sẽ thêm Chức năng đám mây gửi thông báo cho những người tham gia trò chuyện khi có tin nhắn mới.
Sử dụng Nhắn tin qua đám mây Firebase (FCM), bạn có thể gửi thông báo cho người dùng trên nhiều nền tảng một cách đáng tin cậy. Để gửi thông báo cho người dùng, bạn cần có mã thông báo thiết bị FCM của họ. Ứng dụng web trò chuyện mà chúng tôi đang sử dụng đã thu thập mã thông báo thiết bị từ người dùng khi họ mở ứng dụng lần đầu tiên trên một trình duyệt hoặc thiết bị mới. Các mã thông báo này được lưu trữ trong Cloud Firestore trong bộ sưu tập fcmTokens
.
Nếu muốn tìm hiểu cách nhận mã thông báo thiết bị FCM trên ứng dụng web, bạn có thể truy cập Phòng thí nghiệm mã web Firebase .
Gửi thông báo
Để phát hiện thời điểm bài viết mới được đăng, bạn sẽ sử dụng trình kích hoạt functions.firestore.document().onCreate
Cloud Function. Trình kích hoạt này sẽ chạy mã của bạn khi một đối tượng mới được tạo tại một đường dẫn nhất định của Cloud Firestore. Thêm chức năng sendNotifications
vào tệp index.js
của bạn:
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.');
}
});
Trong Hàm ở trên, chúng tôi đang thu thập tất cả mã thông báo thiết bị của người dùng từ cơ sở dữ liệu Cloud Firestore và gửi thông báo tới từng người trong số này bằng cách sử dụng hàm admin.messaging().sendToDevice
.
Dọn dẹp các mã thông báo
Cuối cùng, chúng tôi muốn xóa các mã thông báo không còn hợp lệ. Điều này xảy ra khi mã thông báo mà chúng tôi từng nhận được từ người dùng không còn được trình duyệt hoặc thiết bị sử dụng nữa. Chẳng hạn, điều này xảy ra nếu người dùng đã thu hồi quyền thông báo đối với phiên trình duyệt. Để thực hiện việc này, hãy thêm hàm cleanupTokens
sau vào tệp index.js
của bạn:
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);
}
Triển khai chức năng
Chức năng này sẽ chỉ hoạt động sau khi bạn đã triển khai nó và để triển khai nó, hãy chạy chức năng này trong dòng lệnh:
firebase deploy --only functions
Đây là đầu ra giao diện điều khiển bạn sẽ thấy:
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
Kiểm tra chức năng
- Khi chức năng đã được triển khai thành công, hãy mở ứng dụng của bạn trong trình duyệt bằng cách sử dụng URL lưu trữ (ở dạng
https://<project-id>.firebaseapp.com
). - Nếu bạn đăng nhập ứng dụng lần đầu tiên, hãy đảm bảo rằng bạn cho phép thông báo khi được nhắc:
- Đóng tab ứng dụng trò chuyện hoặc hiển thị một tab khác: Thông báo chỉ xuất hiện nếu ứng dụng ở chế độ nền. Nếu bạn muốn tìm hiểu cách nhận tin nhắn trong khi ứng dụng của bạn ở nền trước, hãy xem tài liệu của chúng tôi .
- Sử dụng một trình duyệt khác (hoặc cửa sổ Ẩn danh), đăng nhập vào ứng dụng và đăng tin nhắn. Bạn sẽ thấy một thông báo được hiển thị bởi trình duyệt đầu tiên:
11. Xin chúc mừng!
Bạn đã sử dụng SDK Firebase cho Chức năng đám mây và thêm các thành phần phía máy chủ vào ứng dụng trò chuyện.
Những gì chúng tôi đã bảo hiểm
- Cấp quyền cho Chức năng đám mây bằng cách sử dụng SDK Firebase cho Chức năng đám mây.
- Kích hoạt các chức năng đám mây dựa trên các sự kiện Auth, Cloud Storage và Cloud Firestore.
- Thêm hỗ trợ Nhắn tin qua đám mây Firebase vào ứng dụng web của bạn.
- Triển khai các chức năng đám mây bằng Firebase CLI.
Bước tiếp theo
- Tìm hiểu về các loại trình kích hoạt Chức năng đám mây khác .
- Sử dụng Firebase và Chức năng đám mây với ứng dụng của riêng bạn.