Триггеры облачного хранилища


Вы можете активировать функцию в ответ на загрузку, обновление или удаление файлов и папок в Cloud Storage .

Примеры на этой странице основаны на примере функции, которая срабатывает при загрузке файлов изображений в Cloud Storage . Этот пример функции демонстрирует, как получить доступ к атрибутам событий, как загрузить файл в экземпляр Cloud Functions и другие основные принципы обработки событий Cloud Storage .

Дополнительные примеры использования см. в разделе Что можно сделать с помощью Cloud Functions ?

Запустить функцию при изменении Cloud Storage

Используйте functions.storage для создания функции, обрабатывающей события Cloud Storage . В зависимости от того, хотите ли вы ограничить область действия функции конкретным контейнером Cloud Storage или использовать контейнер по умолчанию, используйте один из следующих вариантов:

Например, пример генератора миниатюр ограничен областью действия по умолчанию для проекта: 

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

Cloud Storage поддерживает следующие события:

  • onArchive Отправляется только тогда, когда в контейнере включено управление версиями объектов . Это событие указывает на то, что текущая версия объекта стала архивной версией, либо потому, что она была заархивирована, либо потому, что она была перезаписана загрузкой объекта с тем же именем.
  • onDelete Отправляется при окончательном удалении объекта. Это включает в себя объекты, перезаписанные или удаленные в рамках конфигурации жизненного цикла контейнера. Для контейнеров с включенным управлением версиями объектов это событие не отправляется при архивации объекта (см. onArchive ), даже если архивация выполняется с помощью метода storage.objects.delete .
  • onFinalize Отправляется при успешном создании нового объекта (или нового поколения существующего объекта) в контейнере. Это включает копирование или перезапись существующего объекта. Неудачная загрузка не вызывает это событие.
  • onMetadataUpdate Отправляется при изменении метаданных существующего объекта.

Установите событие в обработчике событий on , как показано выше для onFinalize .

Доступ к атрибутам объекта Cloud Storage

Cloud Functions предоставляет доступ к ряду атрибутов объекта Cloud Storage , таких как size и contentType для обновлённого файла. Атрибут metageneration увеличивается при каждом изменении метаданных объекта. Для новых объектов значение metageneration равно 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

В примере генерации миниатюр некоторые из этих атрибутов используются для обнаружения случаев выхода, в которых функция возвращает: 

// 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

Загрузите, преобразуйте и загрузите файл

В некоторых случаях загрузка файлов из Cloud Storage может не потребоваться. Однако для выполнения ресурсоёмких задач, таких как создание миниатюры изображения из файла, хранящегося в Cloud Storage , необходимо загрузить файлы в экземпляр функций, то есть в виртуальную машину, на которой выполняется ваш код.

Чтобы легко загружать и повторно загружать объекты в Cloud Storage , установите пакет Google Cloud Storage с помощью npm install --save @google-cloud/storage и импортируйте его. Чтобы использовать обещания JavaScript для обработки внешних процессов, таких как задачи обработки миниатюр в примере, также импортируйте 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

Используйте gcs.bucket.file(filePath).download для загрузки файла во временный каталог вашего экземпляра Cloud Functions . В этом каталоге вы можете обработать файл по мере необходимости, а затем загрузить его в Cloud Storage . При выполнении асинхронных задач обязательно возвращайте JavaScript-обещание в обратном вызове.

Пример: преобразование изображения

Используя Cloud Functions вместе с программами обработки изображений, такими как sharp , вы можете выполнять различные операции с графическими файлами изображений. Ниже приведён пример создания миниатюры для загруженного файла изображения: 

// 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

Этот код создает миниатюру размером 200x200 для изображения, сохраненного во временном каталоге, а затем загружает ее обратно в Cloud Storage .

Посмотреть больше примеров

Больше примеров распространённых функций преобразования медиафайлов, включая перекодирование изображений , модерацию контента и извлечение метаданных EXIF . Полный список примеров доступен на GitHub.