Điều kiện kích hoạt Cloud Storage


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.

Ví dụ trên 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 của sự kiện, cách tải tệp xuống một phiên bản Cloud Functions và những nguyên tắc cơ bản khác về cách xử lý sự kiện Cloud Storage.

Để biết thêm ví dụ về các trường hợp sử dụng, hãy xem phần Tôi có thể làm gì với Chức năng đám mây?

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

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

Ví dụ: mẫu trình tạo hình thu nhỏ nằm trong phạm vi 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 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 rằng phiên bản trực tiếp của một đối tượng đã trở thành phiên bản được lưu trữ, do đối tượng đó đã được lưu trữ hoặc đã bị ghi đè bằng cách tải lên đối tượng có cùng tên.
  • onDelete Được gửi khi một đối tượng đã bị xoá vĩnh viễn. Dữ liệu này bao gồm 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 tạo phiên bản đối tượng, giá trị 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 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 đối tượng hiện có) được tạo thành công trong bộ chứa. Điều này bao gồm việc sao chép hoặc viết 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 của đối tượng Cloud Storage

Chức năng đám mây hiển thị một số thuộc tính đối tượng Cloud Storage như sizecontentType cho tệp được cập nhật. Thuộc tính 'metagenerative' sẽ tăng lên bất cứ khi nào 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ị metageneration1.

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.

Mẫu tạo hình thu nhỏ sử dụng một số thuộc tính sau để 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.');
}

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

Đối với một số trường hợp, bạn có thể không cần phải 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ể của hàm, tức là máy ảo chạy mã của bạn.

Để dễ dàng tải và tải lại các đối tượng xuống Cloud Storage, hãy cài đặt gói Google Cloud Storage bằng npm install --save @google-cloud/storage rồi nhập gói đó. Để sử dụng hứa hẹn củ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, bạn cũng cần nhập 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');

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 phiên bản Cloud Functions của bạn. Ở vị trí này, bạn có thể xử lý tệp nếu cần, sau đó 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 hứa hẹn JavaScript trong lệnh gọi lại.

Ví dụ: chuyển đổi hình ảnh

Khi sử dụng Chức năng đám mây 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!");

Mã này sẽ 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 ảnh đó lên lại Cloud Storage.

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

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