Amplíe el almacenamiento en la nube con funciones en la nube


Puede activar una función en respuesta a la carga, actualización o eliminación de archivos y carpetas en Cloud Storage.

Los ejemplos de esta página se basan en una función de muestra que se activa cuando se cargan archivos de imagen en Cloud Storage. Esta función de muestra demuestra cómo acceder a los atributos de eventos, cómo descargar un archivo a una instancia de Cloud Functions y otros conceptos básicos del manejo de eventos de Cloud Storage.

Para obtener más ejemplos de casos de uso, consulte ¿Qué puedo hacer con Cloud Functions?

Activar una función en cambios de Cloud Storage

Usa functions.storage para crear una función que maneje eventos de Cloud Storage. Dependiendo de si deseas limitar el alcance de tu función a un depósito de Cloud Storage específico o usar el depósito predeterminado, usa una de las siguientes opciones:

Por ejemplo, el ejemplo del generador de miniaturas tiene como ámbito el depósito predeterminado del proyecto:

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

Cloud Storage admite estos eventos:

  • onArchive Solo se envía cuando un depósito ha habilitado el control de versiones de objetos . Este evento indica que la versión en vivo de un objeto se ha convertido en una versión archivada, ya sea porque fue archivada o porque fue sobrescrita por la carga de un objeto con el mismo nombre.
  • onDelete Se envía cuando un objeto se ha eliminado permanentemente. Esto incluye objetos que se sobrescriben o se eliminan como parte de la configuración del ciclo de vida del depósito. Para los depósitos con control de versiones de objetos habilitado, esto no se envía cuando se archiva un objeto (consulte onArchive ), incluso si el archivo se realiza mediante el método storage.objects.delete .
  • onFinalize Se envía cuando un nuevo objeto (o una nueva generación de un objeto existente) se crea correctamente en el depósito. Esto incluye copiar o reescribir un objeto existente. Una carga fallida no desencadena este evento.
  • onMetadataUpdate Se envía cuando cambian los metadatos de un objeto existente.

Configure el evento dentro del controlador de eventos on como se muestra arriba para onFinalize .

Acceder a los atributos de los objetos de Cloud Storage

Cloud Functions expone una serie de atributos de objetos de Cloud Storage, como size y contentType para el archivo actualizado. El atributo 'metageneración' se incrementa cada vez que hay un cambio en los metadatos del objeto. Para objetos nuevos, el valor metageneration es 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

El ejemplo de generación de miniaturas utiliza algunos de estos atributos para detectar casos de salida en los que la función devuelve:

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

Descargar, transformar y cargar un archivo

En algunos casos, puede que no sea necesario descargar archivos de Cloud Storage. Sin embargo, para realizar tareas intensivas, como generar una imagen en miniatura a partir de un archivo almacenado en Cloud Storage, necesita descargar archivos a la instancia de funciones, es decir, la máquina virtual que ejecuta su código.

Para descargar y volver a cargar objetos fácilmente en Cloud Storage, instale el paquete Google Cloud Storage usando npm install --save @google-cloud/storage e impórtelo. Para usar promesas de JavaScript para manejar procesos externos como las tareas de procesamiento de miniaturas en el ejemplo, importe también 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

Utilice gcs.bucket.file(filePath).download para descargar un archivo a un directorio temporal en su instancia de Cloud Functions. En esta ubicación, puede procesar el archivo según sea necesario y luego cargarlo en Cloud Storage. Al realizar tareas asincrónicas, asegúrese de devolver una promesa de JavaScript en su devolución de llamada.

Ejemplo: transformación de imagen

Al utilizar Cloud Functions junto con programas de procesamiento de imágenes como sharp , puede realizar manipulaciones en archivos de imágenes gráficas. El siguiente es un ejemplo de cómo crear una imagen en miniatura para un archivo de imagen cargado:

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

Este código crea una miniatura de 200x200 para la imagen guardada en un directorio temporal y luego la vuelve a cargar en Cloud Storage.

Explora más ejemplos

Más ejemplos de funciones comunes de transformación de medios que incluyen transcodificación de imágenes , moderación de contenido y extracción de metadatos EXIF . La lista completa de ejemplos está disponible en GitHub.