Mở rộng Cloud Storage bằng Cloud Functions


Bạn có thể kích hoạt một hàm để phản hồi việc tải lên, cập nhật hoặc xoá tệp và thư mục trong Cloud Storage.

Các ví dụ trong trang này dựa trên một hàm mẫu sẽ kích hoạt khi tệp hình ảnh được tải lên Cloud Storage. Hàm mẫu này minh hoạ cách truy cập vào các thuộc tính sự kiện, cách tải tệp xuống một thực thể Cloud Functions và các nguyên tắc cơ bản khác để xử lý sự kiện Cloud Storage.

Để biết thêm ví dụ về trường hợp sử dụng, hãy xem bài viết Tôi có thể làm gì với Cloud Functions?

Kích hoạt một hàm khi có thay đổi đối với Cloud Storage

Sử dụng functions.storage để tạo một hàm xử lý các sự kiện Cloud Storage. Tuỳ thuộc vào việc bạn muốn đặt phạm vi hàm vào một bộ chứa Cloud Storage cụ thể hay sử dụng bộ chứa mặc định, hãy sử dụng một trong những cách sau:

Ví dụ: mẫu trình tạo hình thu nhỏ được đặt trong bộ chứa mặc định cho dự án:

exports.firstGenGenerateThumbnail = functions.storage.object().onFinalize(async (object) => {
  // ...
});

Cloud Storage hỗ trợ các sự kiện sau:

  • onArchive Chỉ được gửi khi một bộ chứa đã bật tính năng tạo phiên bản đối tượng. Sự kiện này cho biết phiên bản trực tiếp của một đối tượng đã trở thành phiên bản đã lưu trữ, vì phiên bản đó đã được lưu trữ hoặc vì phiên bản đó đã bị ghi đè do quá trình tải một đối tượng có cùng tên lên.
  • onDelete Được gửi khi một đối tượng đã bị xoá vĩnh viễn. Điều này bao gồm cả các đối tượng bị ghi đè hoặc bị xoá trong cấu hình vòng đời của bộ chứa. Đối với các bộ chứa đã bật tính năng phiên bản đối tượng, thông báo này sẽ không được gửi khi một đối tượng được lưu trữ (xem onArchive), ngay cả khi quá trình lưu trữ diễn ra thông qua phương thức storage.objects.delete.
  • onFinalize Được gửi khi một đối tượng mới (hoặc một thế hệ mới của một đối tượng hiện có) được tạo thành công trong bộ chứa. Bao gồm cả việc sao chép hoặc ghi lại một đối tượng hiện có. Việc tải lên không thành công sẽ không kích hoạt sự kiện này.
  • onMetadataUpdate Được gửi khi siêu dữ liệu của một đối tượng hiện có thay đổi.

Đặt sự kiện trong trình xử lý sự kiện on như minh hoạ ở trên cho onFinalize.

Truy cập vào các thuộc tính đối tượng Cloud Storage

Cloud Functions hiển thị một số thuộc tính đối tượng Cloud Storage, chẳng hạn như size và contentType cho tệp đã cập nhật. Thuộc tính "metageneration" sẽ tăng lên mỗi khi có thay đổi đối với siêu dữ liệu của đối tượng. Đối với các đối tượng mới, giá trị metageneration là 1.

const fileBucket = object.bucket; // The Storage bucket that contains the file.
const filePath = object.name; // File path in the bucket.
const contentType = object.contentType; // File content type.
index.js

Mẫu tạo hình thu nhỏ sử dụng một số thuộc tính này để phát hiện các trường hợp thoát mà hàm trả về:

// Exit if this is triggered on a file that is not an image.
if (!contentType.startsWith('image/')) {
  return functions.logger.log('This is not an image.');
}

// Get the file name.
const fileName = path.basename(filePath);
// Exit if the image is already a thumbnail.
if (fileName.startsWith('thumb_')) {
  return functions.logger.log('Already a Thumbnail.');
}
index.js

Tải xuống, chuyển đổi và tải tệp lên

Trong một số trường hợp, bạn có thể không cần tải tệp xuống từ Cloud Storage. Tuy nhiên, để thực hiện các tác vụ chuyên sâu như tạo hình thu nhỏ từ một tệp được lưu trữ trong Cloud Storage, bạn cần tải tệp xuống thực thể hàm, tức là máy ảo chạy mã của bạn.

Để dễ dàng tải xuống và tải lại các đối tượng lên Cloud Storage, hãy cài đặt gói Google Cloud Storage bằng cách sử dụng npm install --save @google-cloud/storage và nhập gói đó. Để sử dụng lời hứa JavaScript để xử lý các quy trình bên ngoài như tác vụ xử lý hình thu nhỏ trong mẫu, hãy nhập cả child-process-promise:

const functions = require('firebase-functions/v1');
const admin = require('firebase-admin');
admin.initializeApp()
const path = require('path');

//library for resizing images
const sharp = require('sharp');
index.js

Sử dụng gcs.bucket.file(filePath).download để tải tệp xuống một thư mục tạm thời trên thực thể Cloud Functions. Ở vị trí này, bạn có thể xử lý tệp nếu cần rồi tải lên Cloud Storage. Khi thực hiện các tác vụ không đồng bộ, hãy đảm bảo bạn trả về một lời hứa JavaScript trong lệnh gọi lại.

Ví dụ: biến đổi hình ảnh

Khi sử dụng Cloud Functions cùng với các chương trình xử lý hình ảnh như sharp, bạn có thể thực hiện các thao tác trên tệp hình ảnh đồ hoạ. Sau đây là ví dụ về cách tạo hình thu nhỏ cho tệp hình ảnh đã tải lên:

// Download file from bucket.
const bucket = admin.storage().bucket(fileBucket);
const metadata = {
  contentType: contentType,
};
const downloadResponse = await bucket.file(filePath).download();
const imageBuffer = downloadResponse[0];
functions.logger.log("Image downloaded!");

// Generate a thumbnail using sharp.
const thumbnailBuffer = await sharp(imageBuffer).resize({
  width: 200,
  height: 200,
  withoutEnlargement: true,
}).toBuffer();
functions.logger.log("Thumbnail created");

// Upload the thumbnail with a 'thumb_' prefix.
const thumbFileName = `thumb_${fileName}`;
const thumbFilePath = path.join(path.dirname(filePath), thumbFileName);
await bucket.file(thumbFilePath).save(thumbnailBuffer, {
  metadata: metadata,
});
return functions.logger.log("Thumbnail uploaded!");
index.js

Mã này tạo một hình thu nhỏ 200x200 cho hình ảnh được lưu trong một thư mục tạm thời, sau đó tải hình thu nhỏ đó lên lại Cloud Storage.

Khám phá thêm ví dụ

Ví dụ khác về các hàm biến đổi nội dung đa phương tiện phổ biến, bao gồm cả việc chuyển mã hình ảnh, kiểm duyệt nội dung, trích xuất siêu dữ liệu EXIF. Bạn có thể xem danh sách đầy đủ các ví dụ trên GitHub.