1. Tổng quan
Trong lớp học lập trình này, bạn sẽ tìm hiểu cách sử dụng Cloud Functions 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.
Kiến thức bạn sẽ học được
- Tạo Google Cloud Functions bằng SDK Firebase.
- Kích hoạt Cloud Functions dựa trên các sự kiện Auth, Cloud Storage và Cloud Firestore.
- Thêm tính năng hỗ trợ Giải pháp gửi thông báo qua đám mây của Firebase vào ứng dụng web.
Bạn cần có
- Thẻ tín dụng. Cloud Functions cho Firebase yêu cầu gói Firebase Blaze, tức là bạn sẽ phải bật tính năng thanh toán trên dự án Firebase 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 như Chrome.
- Mã mẫu. Hãy xem bước tiếp theo để biết cách thực hiện.
2. Tải 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, hãy mở hoặc nhập thư mục cloud-functions-start
từ thư mục mã mẫu. Thư mục này chứa mã khởi đầu cho lớp học lập trình, bao gồm một Ứng dụng web trò chuyện có đầy đủ chức năng.
3. Tạo dự án Firebase và Thiết lập ứng dụng
Tạo dự án
Trong Bảng điều khiển của Firebase, hãy nhấp vào Thêm dự án rồi đặt tên là FriendlyChat.
Nhấp vào Create Project (Tạo dự án).
Nâng cấp lên gói Blaze
Để sử dụng Cloud Functions cho Firebase và Cloud Storage cho Firebase, dự án Firebase của bạn cần sử dụng gói thanh toán theo mức sử dụng (Blaze), tức là dự án được liên kết với một tài khoản Cloud Billing.
- Tài khoản Cloud Billing cần có một phương thức thanh toán, chẳng hạn như thẻ tín dụng.
- Nếu bạn mới sử dụng Firebase và Google Cloud, hãy kiểm tra xem bạn có đủ điều kiện nhận khoản tín dụng 300 USD và tài khoản dùng thử miễn phí trên Cloud Billing hay không.
- Nếu bạn tham gia lớp học lập trình này trong một sự kiện, hãy hỏi người tổ chức xem có khoản tín dụng Google Cloud nào không.
Nếu bạn không có thẻ tín dụng hoặc không muốn tiếp tục sử dụng gói giá Blaze, hãy cân nhắc sử dụng Bộ trình mô phỏng Firebase. Bộ này cho phép bạn mô phỏng miễn phí các Hàm trên đám mây trên máy cục bộ.
Tất cả dự án Firebase, bao gồm cả những dự án sử dụng gói giá linh hoạt, vẫn có quyền sử dụng hạn mức không tính phí cho Cloud Functions. Các bước được nêu trong lớp học lập trình này sẽ nằm trong hạn mức sử dụng của gói miễn phí. Tuy nhiên, bạn sẽ thấy các khoản phí nhỏ (khoảng 0,03 USD) từ Cloud Storage dùng để lưu trữ hình ảnh bản dựng của Cloud Functions.
Để nâng cấp dự án lên gói Blaze, hãy làm theo các bước sau:
- Trong bảng điều khiển của Firebase, hãy chọn nâng cấp gói.
- Chọn gói Blaze. Làm theo hướng dẫn trên màn hình để liên kết tài khoản Cloud Billing với dự án của bạn.
Nếu cần tạo tài khoản Cloud Billing trong quá trình nâng cấp này, bạn có thể cần quay lại quy trình nâng cấp trong bảng điều khiển Firebase để hoàn tất quá trình nâng cấp.
Bật tính năng Uỷ quyền của Google
Để cho phép người dùng đăng nhập vào ứng dụng, chúng ta sẽ sử dụng tính năng xác thực của Google. Bạn cần bật tính năng này.
Trong Bảng điều khiển Firebase, hãy mở mục Tạo > thẻ Xác thực > Phương thức đăng nhập (hoặc nhấp vào đây để chuyển đến đó). Sau đó, hãy bật Nhà cung cấp dịch vụ đăng nhập Google rồi nhấp vào Lưu. Thao tác 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, bạn có thể đặt tên công khai của ứng dụng thành Friendly Chat (Ứng dụng trò chuyện thân thiện):
Thiết lập Cloud Storage cho Firebase
Ứng dụng sử dụng Cloud Storage để tải ảnh lên.
Sau đây là cách thiết lập Cloud Storage cho Firebase trong dự án Firebase:
- Trong bảng điều khiển bên trái của Firebase, hãy mở rộng mục Bản dựng rồi chọn Bộ nhớ.
- Nhấp vào Bắt đầu.
- Chọn vị trí cho bộ chứa Bộ nhớ mặc định.
Các bộ chứa trongUS-WEST1
,US-CENTRAL1
vàUS-EAST1
có thể tận dụng cấp"Luôn miễn phí" cho Google Cloud Storage. Các bộ chứa ở tất cả các vị trí khác tuân theo mức giá và mức sử dụng của Google Cloud Storage. - Nhấp vào Bắt đầu ở chế độ thử nghiệm. Đọc tuyên bố từ chối trách nhiệm về các quy tắc bảo mật.
Đừng phân phối hoặc công khai ứng dụng mà không thêm Quy tắc bảo mật cho bộ nhớ. - Nhấp vào Tạo.
Thêm ứng dụng web
Trên Bảng điều khiển Firebase, hãy thêm một ứng dụng web. Để thực hiện việc này, hãy chuyển đến phần Cài đặt dự án rồi di chuyển xuống phần Thêm ứng dụng. Chọn web làm nền tảng và đánh dấu vào hộp để thiết lập tính năng 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 (CLI) của Firebase sẽ cho phép bạn phân phát ứng dụng web cục bộ, đồng thời triển khai ứng dụng web và Cloud Functions.
Để 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ở một bảng điều khiển và chạy:
firebase --version
Đảm bảo phiên bản Giao diện dòng lệnh (CLI) của Firebase cao hơn 4.0.0 để có tất cả các tính năng mới nhất cần thiết cho Cloud Functions. Nếu không, hãy chạy npm install -g firebase-tools
để nâng cấp như minh hoạ ở trên.
Uỷ quyền cho Giao diện dòng lệnh (CLI) của Firebase bằng cách chạy:
firebase login
Đảm bảo bạn đang ở thư mục cloud-functions-start
, sau đó thiết lập Firebase CLI để sử dụng Dự án Firebase:
firebase use --add
Tiếp theo, hãy chọn Mã dự án của bạn rồi 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
Giờ đây, khi đã nhập và định cấu hình dự án, bạn đã sẵn sàng chạy ứng dụng web lần đầu tiên! Mở cửa sổ dòng lệnh, chuyển đến thư mục cloud-functions-start
rồi 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à kết quả bạn sẽ thấy trên bảng điều khiển:
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ữ. Ứng dụng web hiện sẽ được phân phát từ URL này, URL này phải ở dạng https://<project-id>.firebaseapp.com. Hãy mở URL đó. Bạn sẽ thấy giao diện người dùng đang hoạt động của một ứ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. Bạn có thể thêm một số tin nhắn và đăng hình ảnh:
Nếu bạn đăng nhập vào ứng dụng lần đầu tiên trên một trình duyệt mới, hãy nhớ cho phép thông báo khi được nhắc:
Chúng ta sẽ cần bật thông báo vào lúc khác.
Nếu vô tình nhấp vào Chặn, bạn có thể thay đổi chế độ cài đặt này bằng cách nhấp vào nút 🔒 Bảo mật ở bên trái URL trong thanh Omnibar của Chrome rồi bật/tắt thanh bên cạnh Thông báo:
Bây giờ, chúng ta sẽ thêm một số chức năng bằng cách sử dụng SDK Firebase cho các Hàm trên đám mây.
6. Thư mục hàm
Cloud Functions giúp bạn dễ dàng chạy mã trong đám mây mà không cần thiết lập máy chủ. Chúng ta sẽ tìm hiểu cách tạo các hàm 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 Cloud Functions, mã Hàm 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, do đó cần có package.json
cung cấp một số thông tin về ứng dụng và liệt kê các 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
để lưu mã của bạn. Bạn có thể kiểm tra tệp này trước khi tiếp tục.
cd functions
ls
Nếu bạn chưa quen thuộc với Node.js, hãy tìm hiểu thêm về công cụ này trước khi tiếp tục lớp học lập trình.
Tệp package.json
đã liệt kê hai phần phụ thuộc bắt buộc: SDK Firebase cho các Hàm trên đám mây và SDK Quản trị Firebase. Để cài đặt các thư viện này trên máy, hãy chuyển đến thư mục functions
rồi chạy:
npm install
Bây giờ, 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 ta sẽ nhập các mô-đun bắt buộc rồi viết ba Hàm thay cho TODO. Hãy bắt đầu bằng cách nhập các mô-đun Node bắt buộc.
7. Nhập các mô-đun Cloud Functions và Firebase Admin
Bạn sẽ cần đến 2 mô-đun trong lớp học lập trình này: firebase-functions
cho phép ghi trình kích hoạt và nhật ký của Cloud Functions, còn firebase-admin
cho phép sử dụng nền tảng Firebase trên một máy chủ có quyền quản trị để thực hiện các thao tác 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.
Bạn có thể tự động định cấu hình SDK quản trị Firebase khi triển khai SDK này cho môi trường Cloud Functions hoặc các vùng chứa khác trên Google Cloud Platform. Việc này xảy ra khi chúng ta gọi admin.initializeApp()
mà không có đối số nào.
Bây giờ, hãy thêm một Hàm chạy khi người dùng đăng nhập lần đầu tiên vào ứng dụng trò chuyện. Chúng ta cũng 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 vào trang trò chuyện FriendlyChat được lưu trữ trong Cloud Firestore. Hãy xem cấu trúc dữ liệu mà chúng ta sử dụng cho một thông báo. Để làm việc này, hãy đăng một tin nhắn mới có nội dung "Hello World" ("Xin chào thế giới") vào cuộc trò chuyện:
Mã này sẽ xuất hiện như sau:
Trong Bảng điều khiển của Firebase, hãy nhấp vào Cơ sở dữ liệu Firestore trong mục Bản 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 một tài liệu có các thuộc tính name
, profilePicUrl
, text
và timestamp
được thêm vào tập hợp messages
.
Thêm tin nhắn chào mừng
Hàm trên đám mây đầu tiên sẽ thêm một thông báo chào mừng người dùng mới tham gia cuộc trò chuyện. Để làm việc này, chúng ta có thể sử dụng trình kích hoạt functions.auth().onCreate
. Trình kích hoạt này sẽ chạy hàm mỗi khi người dùng đăng nhập lần đầu tiên trong ứng dụng Firebase. Thêm hàm addWelcomeMessages
vào tệp 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.');
});
Việc thêm hàm này vào đối tượng exports
đặc biệt là cách Node giúp bạn truy cập vào hàm bên ngoài tệp hiện tại và là yêu cầu bắt buộc đối với Hàm trên đám mây.
Trong hàm trên, chúng ta sẽ thêm một tin nhắn chào mừng mới do "Firebase Bot" đăng vào danh sách tin nhắn trò chuyện. Chúng ta thực hiện việc này bằng cách sử dụng phương thức add
trên tập hợp 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 thao tác không đồng bộ, nên chúng ta cần trả về Promise (Lời hứa) cho biết thời điểm Cloud Firestore hoàn tất quá trình ghi để các Hàm trên đám mây không thực thi quá sớm.
Triển khai Cloud Functions
Hàm trên đám mây sẽ chỉ hoạt động sau khi bạn triển khai. Để thực hiện việc này, hãy chạy lệnh sau trên dòng lệnh:
firebase deploy --only functions
Đây là kết quả bạn sẽ thấy trên bảng điều khiển:
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 thử hàm
Sau khi triển khai thành công hàm này, bạn cần có một người dùng đăng nhập lần đầu.
- Mở ứng dụng 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 bằng nút Đăng nhập.
- Nếu đã đă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à xoá tài khoản của mình khỏi danh sách người dùng. Sau đó, hãy đă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 xuất hiện:
9. Kiểm duyệt hình ảnh
Người dùng có thể tải mọi loại hình ảnh lên trong cuộc trò chuyện. Vì vậy, bạn luôn phải kiểm duyệt hình ảnh phản cảm, đặc biệt là trên các nền tảng mạng xã hội công khai. Trong FriendlyChat, hình ảnh được xuất bản vào cuộc trò chuyện sẽ được lưu trữ vào các bộ chứa Cloud Storage.
Với Cloud Functions, bạn có thể phát hiện các hình ảnh tải lên mới bằng cách sử dụng trình kích hoạt functions.storage().onFinalize
. Quy trình 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 Bộ nhớ trên đám mây.
Để 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à Nội dung người lớn hoặc Nội dung bạo lực hay không bằng API Cloud Vision.
- Nếu hình ảnh đã bị gắn cờ, hãy tải hình ảnh đó xuống trên thực thể đang chạy của Hàm.
- Làm mờ hình ảnh bằng ImageMagick.
- Tải hình ảnh đã làm mờ lên Cloud Storage.
Bật Cloud Vision API
Vì chúng ta sẽ sử dụng API Google Cloud Vision trong hàm này, nên bạn phải bật API trên dự án firebase. Truy cập vào đường liên kết này, sau đó chọn dự án Firebase và bật API:
Cài đặt phần phụ thuộc
Để kiểm duyệt hình ảnh, chúng ta sẽ sử dụng Thư viện ứng dụng Google Cloud Vision 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 Cloud Functions, hãy chạy lệnh npm install --save
sau. Hãy nhớ 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 trên máy và thêm gói đó dưới dạng phần phụ thuộc đã khai báo trong tệp package.json
.
Nhập và định cấu hình phần phụ thuộc
Để nhập các phần phụ thuộc đã cài đặt và một số mô-đun cốt lõi của Node.js (path
, os
và fs
) mà chúng ta cần trong phần này, hãy thêm các dòng sau vào đầu tệp 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');
Vì hàm của bạn sẽ chạy bên trong môi trường Google Cloud, nên bạn không cần định cấu hình thư viện Cloud Storage và Cloud Vision: các thư viện này sẽ được tự động định cấu hình để 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 Hàm trên đám mây functions.storage.onChange
. 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 trên Cloud Storage. Thêm Hàm blurOffensiveImages
vào tệp 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.');
});
Xin lưu ý rằng chúng tôi đã thêm một số cấu hình của thực thể Cloud Functions sẽ chạy hàm này. Với .runWith({memory: '2GB'})
, chúng ta yêu cầu thực thể nhận được 2GB bộ nhớ thay vì bộ nhớ mặc định, vì hàm này tiêu tốn nhiều bộ nhớ.
Khi hàm này được kích hoạt, hình ảnh sẽ được chạy qua API Cloud Vision để phát hiện xem hình ảnh đó có bị gắn cờ là nội dung người lớn hoặc bạo lực hay không. Nếu phát hiện hình ảnh không phù hợp dựa trên các tiêu chí này, chúng ta sẽ làm mờ hình ảnh đó trong hàm blurImage
như sẽ thấy ở phần tiếp theo.
Làm mờ hình ảnh
Thêm hàm blurImage
sau vào tệp index.js
:
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 hàm trên, tệp nhị phân hình ảnh được tải xuống từ Bộ nhớ trên đám mây. Sau đó, hình ảnh đượ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ộ chứa bộ nhớ. Tiếp theo, chúng ta xoá tệp trên thực thể Cloud Functions để giải phóng một số dung lượng ổ đĩa. Chúng ta làm việc này vì cùng một thực thể Cloud Functions có thể được sử dụng lại và nếu không xoá các tệp, thì thực thể đó có thể hết dung lượng ổ đĩa. Cuối cùng, chúng ta thêm một boolean vào tin nhắn trò chuyện để cho biết hình ảnh đã được kiểm duyệt. Thao tác này sẽ kích hoạt việc làm mới tin nhắn trên ứng dụng.
Triển khai hàm
Hàm sẽ chỉ hoạt động sau khi bạn triển khai hàm đó. Trên dòng lệnh, hãy chạy firebase deploy --only functions
:
firebase deploy --only functions
Đây là kết quả bạn sẽ thấy trên bảng điều khiển:
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 thử hàm
Sau khi triển khai thành công hàm:
- Mở ứng dụng 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 hình ảnh lên:
- Chọn hình ảnh phản cảm nhất để tải lên (hoặc bạn có thể sử dụng Zombie ăn thịt người này!) và sau vài phút, bạn sẽ thấy bài đăng của mình được làm mới với phiên bản hình ảnh mờ:
10. Thông báo về tin nhắn mới
Trong phần này, bạn sẽ thêm một Hàm trên đám mây để gửi thông báo cho những người tham gia cuộc trò chuyện khi có tin nhắn mới được đăng.
Khi sử dụng Giải pháp gửi thông báo qua đám mây của Firebase (FCM), bạn có thể gửi thông báo một cách đáng tin cậy cho người dùng trên nhiều nền tảng. Để 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 ta đang sử dụng đã thu thập mã thông báo thiết bị của 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 lấy mã thông báo thiết bị FCM trên ứng dụng web, bạn có thể tham khảo Lớp học lập trình Firebase Web.
Gửi thông báo
Để phát hiện thời điểm đăng tin nhắn mới, bạn sẽ sử dụng trình kích hoạt Cloud Functions functions.firestore.document().onCreate
. 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 hàm sendNotifications
vào tệp 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.');
}
});
Trong Hàm ở trên, chúng ta đ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 đến từng mã thông báo đó bằng hàm admin.messaging().sendToDevice
.
Dọn dẹp mã thông báo
Cuối cùng, chúng ta muốn xoá các mã thông báo không còn hợp lệ. Điều này xảy ra khi trình duyệt hoặc thiết bị không còn sử dụng mã thông báo mà chúng ta từng nhận được từ người dùng. Ví dụ: điều này xảy ra nếu người dùng đã thu hồi quyền gửi thông báo cho 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
:
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 hàm
Hàm này sẽ chỉ hoạt động sau khi bạn triển khai. Để triển khai hàm này, hãy chạy lệnh sau trong dòng lệnh:
firebase deploy --only functions
Đây là kết quả bạn sẽ thấy trên bảng điều khiển:
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 thử hàm
- Sau khi triển khai thành công hàm, hãy mở ứng dụng trong trình duyệt bằng URL lưu trữ (ở dạng
https://<project-id>.firebaseapp.com
). - Nếu bạn đăng nhập vào ứng dụng lần đầu tiên, hãy nhớ cho phép thông báo khi được nhắc:
- Đóng thẻ ứng dụng trò chuyện hoặc hiển thị một thẻ khác: Thông báo chỉ xuất hiện nếu ứng dụng đang chạy ở chế độ nền. Nếu bạn muốn tìm hiểu cách nhận tin nhắn khi ứng dụng đang chạy ở 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 rồi đăng tin. Bạn sẽ thấy một thông báo do trình duyệt đầu tiên hiển thị:
11. Xin chúc mừng!
Bạn đã sử dụng SDK Firebase cho Cloud Functions và thêm các thành phần phía máy chủ vào ứng dụng trò chuyện.
Nội dung đã đề cập
- Soạn Cloud Functions bằng SDK Firebase cho Cloud Functions.
- Kích hoạt Cloud Functions dựa trên các sự kiện Auth, Cloud Storage và Cloud Firestore.
- Thêm tính năng hỗ trợ Giải pháp gửi thông báo qua đám mây của Firebase vào ứng dụng web.
- Triển khai Cloud Functions bằng Giao diện dòng lệnh (CLI) của Firebase.
Các bước tiếp theo
- Tìm hiểu về các loại điều kiện kích hoạt khác của Hàm trên đám mây.
- Sử dụng Firebase và Cloud Functions với ứng dụng của riêng bạn.