Вы можете настроить запуск функции в ответ на загрузку, обновление или удаление файлов и папок в Cloud Storage.
Примеры на этой странице основаны на функции, которая активируется при загрузке файлов изображений в Cloud Storage. В этом примере функции показано, как получить доступ к атрибутам события, как скачать файл в экземпляр Cloud Functions и другие основы обработки событий Cloud Storage.
Импортируйте необходимые модули
Для начала импортируйте модуль, необходимый для обработки событий Cloud Storage:
Node.js
const {onObjectFinalized} = require("firebase-functions/storage");
Python
from firebase_functions import storage_fn
Чтобы создать полный образец, добавьте зависимости для инструментов обработки изображений и Firebase Admin SDK:
Node.js
const {initializeApp} = require("firebase-admin/app");
const {getStorage} = require("firebase-admin/storage");
const logger = require("firebase-functions/logger");
const path = require("path");
// library for image resizing
const sharp = /** @type {typeof import("sharp")} */ (require("sharp"));
initializeApp();
Python
import io
import pathlib
from PIL import Image
from firebase_admin import initialize_app
initialize_app()
from firebase_admin import storage
Как задать область действия функции Cloud Storage
Чтобы задать область действия функции для определенного сегмента Cloud Storage и настроить нужные параметры, используйте следующий шаблон:
Node.js
// scope handler to a specific bucket, using storage options parameter
exports.archivedopts = onObjectArchived({ bucket: "myBucket" }, (event) => {
//…
});
Python
# Scope handler to a specific bucket using storage options parameter
@storage_fn.on_object_archived(bucket="myBucket")
def archived_bucket(event: storage_fn.CloudEvent[storage_fn.StorageObjectData]):
# ...
В отличие от этого, функция генератора значков из примера относится к стандартному сегменту проекта:
Node.js
exports.generateThumbnail = onObjectFinalized({cpu: 2}, async (event) => { // ... });
Python
@storage_fn.on_object_archived()
def generatethumbnail(event: storage_fn.CloudEvent[storage_fn.StorageObjectData]):
# ...
Как задать местоположение функции
Несоответствие местоположений может привести к сбою развертывания. Кроме того, расстояние между местоположением сегмента Cloud Storage и местоположением функции может привести к значительной задержке сети. Чтобы избежать таких ситуаций, укажите местоположение функции, которое будет совпадать с местоположением сегмента или триггера одним из следующих способов:
- Местоположение функции совпадает с местоположением триггера
- Функция находится в регионе триггера (если регион триггера двойной или многорегиональный).
- Функция может находиться в любом месте, если в качестве региона активации указано значение
us-central1.
Как обрабатывать события Cloud Storage
Доступны следующие обработчики для реагирования на события Cloud Storage:
Node.js
onObjectArchivedОтправляется только в том случае, если для сегмента включено управление версиями объектов. Это событие означает, что рабочая версия объекта стала архивной. Это могло произойти, потому что объект был отправлен в архив или перезаписан при загрузке объекта с тем же названием.onObjectDeleted– отправляется, когда объект был удален без возможности восстановления. Сюда входят объекты, которые были перезаписаны или удалены в соответствии с конфигурацией жизненного цикла сегмента. Для сегментов с включенным управлением версиями объектов это значение не отправляется при архивации объекта (см.onArchive), даже если архивация выполняется с помощью методаstorage.objects.delete.onObjectFinalizedОтправляется, когда в сегменте успешно создан новый объект (или новое поколение существующего объекта). Это может быть копирование или перезапись существующего объекта. Событие не инициируется в случае сбоя загрузки.onMetadataUpdatedОтправляется при изменении метаданных существующего объекта.
Python
on_object_archivedОтправляется только в том случае, если для сегмента включено управление версиями объектов. Это событие означает, что рабочая версия объекта стала архивной. Это могло произойти, потому что объект был отправлен в архив или перезаписан при загрузке объекта с тем же названием.on_object_deleted– отправляется, когда объект был удален без возможности восстановления. Сюда входят объекты, которые были перезаписаны или удалены в соответствии с конфигурацией жизненного цикла сегмента. Для сегментов с включенным управлением версиями объектов это значение не отправляется при архивации объекта (см.onArchive), даже если архивация выполняется с помощью методаstorage.objects.delete.on_object_finalizedОтправляется, когда в сегменте успешно создан новый объект (или новое поколение существующего объекта). Это может быть копирование или перезапись существующего объекта. Событие не инициируется в случае сбоя загрузки.on_metadata_updatedОтправляется при изменении метаданных существующего объекта.
Как получить доступ к атрибутам объекта Cloud Storage
Cloud Functions предоставляет ряд атрибутов объекта Cloud Storage, например размер объекта и тип контента для обновленного файла. Значение атрибута metageneration увеличивается каждый раз, когда меняются метаданные объекта. Для новых объектов значение metageneration – 1.
Node.js
const fileBucket = event.data.bucket; // Storage bucket containing the file. const filePath = event.data.name; // File path in the bucket. const contentType = event.data.contentType; // File content type.
Python
bucket_name = event.data.bucket
file_path = pathlib.PurePath(event.data.name)
content_type = event.data.content_type
В примере создания эскизов некоторые из этих атрибутов используются для обнаружения случаев выхода, в которых функция возвращает:
Node.js
// Exit if this is triggered on a file that is not an image. if (!contentType.startsWith("image/")) { return logger.log("This is not an image."); } // Exit if the image is already a thumbnail. const fileName = path.basename(filePath); if (fileName.startsWith("thumb_")) { return logger.log("Already a Thumbnail."); }
Python
# Exit if this is triggered on a file that is not an image.
if not content_type or not content_type.startswith("image/"):
print(f"This is not an image. ({content_type})")
return
# Exit if the image is already a thumbnail.
if file_path.name.startswith("thumb_"):
print("Already a thumbnail.")
return
Как скачать, преобразовать и загрузить файл
В некоторых случаях скачивать файлы с сайта Cloud Storage не нужно. Однако для выполнения ресурсоемких задач, таких как создание эскиза из файла, хранящегося в Cloud Storage, необходимо скачать файлы в экземпляр функции, то есть на виртуальную машину, на которой выполняется ваш код.
Используя Cloud Functions вместе с программами для обработки изображений, такими как sharp для Node.js и Pillow для Python, вы можете выполнять различные действия с графическими файлами. Ниже приведен пример того, как создать значок для загруженного файла изображения:
Node.js
/**
* When an image is uploaded in the Storage bucket,
* generate a thumbnail automatically using sharp.
*/
exports.generateThumbnail = onObjectFinalized({cpu: 2}, async (event) => {
const fileBucket = event.data.bucket; // Storage bucket containing the file.
const filePath = event.data.name; // File path in the bucket.
const contentType = event.data.contentType; // File content type.
// Exit if this is triggered on a file that is not an image.
if (!contentType.startsWith("image/")) {
return logger.log("This is not an image.");
}
// Exit if the image is already a thumbnail.
const fileName = path.basename(filePath);
if (fileName.startsWith("thumb_")) {
return logger.log("Already a Thumbnail.");
}
// Download file into memory from bucket.
const bucket = getStorage().bucket(fileBucket);
const downloadResponse = await bucket.file(filePath).download();
const imageBuffer = downloadResponse[0];
logger.log("Image downloaded!");
// Generate a thumbnail using sharp.
const thumbnailBuffer = await sharp(imageBuffer).resize({
width: 200,
height: 200,
withoutEnlargement: true,
}).toBuffer();
logger.log("Thumbnail created");
// Prefix 'thumb_' to file name.
const thumbFileName = `thumb_${fileName}`;
const thumbFilePath = path.join(path.dirname(filePath), thumbFileName);
// Upload the thumbnail.
const metadata = {contentType: contentType};
await bucket.file(thumbFilePath).save(thumbnailBuffer, {
metadata: metadata,
});
return logger.log("Thumbnail uploaded!");
});
Скачайте файл во временный каталог экземпляра Cloud Functions. Здесь вы можете обработать файл и загрузить его в Cloud Storage. При выполнении асинхронных задач убедитесь, что в обратном вызове возвращается объект Promise JavaScript.
Python
@storage_fn.on_object_finalized()
def generatethumbnail(event: storage_fn.CloudEvent[storage_fn.StorageObjectData]):
"""When an image is uploaded in the Storage bucket, generate a thumbnail
automatically using Pillow."""
bucket_name = event.data.bucket
file_path = pathlib.PurePath(event.data.name)
content_type = event.data.content_type
# Exit if this is triggered on a file that is not an image.
if not content_type or not content_type.startswith("image/"):
print(f"This is not an image. ({content_type})")
return
# Exit if the image is already a thumbnail.
if file_path.name.startswith("thumb_"):
print("Already a thumbnail.")
return
bucket = storage.bucket(bucket_name)
image_blob = bucket.blob(str(file_path))
image_bytes = image_blob.download_as_bytes()
image = Image.open(io.BytesIO(image_bytes))
image.thumbnail((200, 200))
thumbnail_io = io.BytesIO()
image.save(thumbnail_io, format="png")
thumbnail_path = file_path.parent / pathlib.PurePath(f"thumb_{file_path.stem}.png")
thumbnail_blob = bucket.blob(str(thumbnail_path))
thumbnail_blob.upload_from_string(thumbnail_io.getvalue(), content_type="image/png")
Этот код создает уменьшенное изображение размером 200 x 200 пикселей для изображения, сохраненного во временном каталоге, а затем загружает его обратно в Cloud Storage.