Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

Déclencheurs Cloud Storage

Vous pouvez déclencher une fonction en réponse au téléchargement, à la mise à jour ou à la suppression de fichiers et de dossiers dans Cloud Storage.

Les exemples de cette page sont basés sur un exemple de fonction qui se déclenche lorsque des fichiers image sont téléchargés vers Cloud Storage. Cet exemple de fonction montre comment accéder aux attributs d'événements, comment télécharger un fichier sur une instance Cloud Functions et d'autres principes de base de la gestion des événements Cloud Storage.

Pour plus d'exemples de cas d'utilisation, consultez Que puis-je faire avec Cloud Functions?

Déclencher une fonction sur les modifications de Cloud Storage

Utilisez functions.storage pour créer une fonction qui gère les événements Cloud Storage. Selon que vous souhaitez étendre votre fonction à un bucket Cloud Storage spécifique ou utiliser le bucket par défaut, utilisez l'une des options suivantes:

Par exemple, l'exemple du générateur de vignettes est limité au compartiment par défaut du projet:

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

Cloud Storage prend en charge ces événements:

  • onArchive uniquement lorsqu'un onArchive a activé la gestion des versions d'objet . Cet événement indique que la version active d'un objet est devenue une version archivée, soit parce qu'elle a été archivée, soit parce qu'elle a été écrasée par le téléchargement d'un objet du même nom.
  • onDelete Envoyé lorsqu'un objet a été définitivement supprimé. Cela inclut les objets qui sont écrasés ou supprimés dans le cadre de la configuration du cycle de vie du compartiment . Pour les buckets avec la gestion des versions d'objet activée, cela n'est pas envoyé lorsqu'un objet est archivé (voir onArchive ), même si l'archivage se produit via la méthode storage.objects.delete .
  • onFinalize Envoyé lorsqu'un nouvel objet (ou une nouvelle génération d'un objet existant) est créé avec succès dans le compartiment. Cela inclut la copie ou la réécriture d'un objet existant. Un téléchargement échoué ne déclenche pas cet événement.
  • onMetadataUpdate Envoyé lorsque les métadonnées d'un objet existant changent.

Définir l'événement dans le on gestionnaire d'événements comme indiqué ci - dessus pour onFinalize .

Accéder aux attributs des objets de stockage

Cloud Functions expose un certain nombre d'attributs d'objets de stockage tels que la size et le contentType pour le fichier mis à jour. L'attribut 'metageneration' est incrémenté chaque fois qu'il y a un changement dans les métadonnées de l'objet. Pour les nouveaux objets, la valeur de la metageneration est 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.
const metageneration = object.metageneration; // Number of times metadata has been generated. New objects have a value of 1.

L'exemple de génération de vignettes utilise certains de ces attributs pour détecter les cas de sortie dans lesquels la fonction renvoie:

// Exit if this is triggered on a file that is not an image.
if (!contentType.startsWith('image/')) {
  return console.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 console.log('Already a Thumbnail.');
}

Télécharger, transformer et télécharger un fichier

Dans certains cas, il peut ne pas être nécessaire de télécharger des fichiers depuis Cloud Storage. Cependant, pour effectuer des tâches intensives telles que la génération d'une image miniature à partir d'un fichier stocké dans Cloud Storage, vous devez télécharger des fichiers sur l'instance de fonctions, c'est-à-dire la machine virtuelle qui exécute votre code.

Pour télécharger et réimporter facilement des objets sur Cloud Storage, installez le package Google Cloud Storage à l' aide de npm install --save @google-cloud/storage , puis importez-le. Pour utiliser JavaScript promet de gérer des processus externes tels que les tâches de traitement des vignettes dans l'exemple, importez également child-process-promise :

const functions = require('firebase-functions');
const admin = require('firebase-admin');
admin.initializeApp()
const spawn = require('child-process-promise').spawn;
const path = require('path');
const os = require('os');
const fs = require('fs');

Utilisez gcs.bucket.file(filePath).download pour télécharger un fichier dans un répertoire temporaire de votre instance Cloud Functions. À cet emplacement, vous pouvez traiter le fichier selon vos besoins, puis le télécharger sur Cloud Storage. Lorsque vous effectuez des tâches asynchrones, assurez-vous de renvoyer une promesse JavaScript dans votre rappel.

Exemple: transformation d'image

Cloud Functions fournit un programme de traitement d'image appelé ImageMagick qui peut effectuer des manipulations sur des fichiers d'images graphiques. Voici un exemple de création d'une image miniature pour un fichier image téléchargé:

// Download file from bucket.
const bucket = admin.storage().bucket(fileBucket);
const tempFilePath = path.join(os.tmpdir(), fileName);
const metadata = {
  contentType: contentType,
};
await bucket.file(filePath).download({destination: tempFilePath});
console.log('Image downloaded locally to', tempFilePath);
// Generate a thumbnail using ImageMagick.
await spawn('convert', [tempFilePath, '-thumbnail', '200x200>', tempFilePath]);
console.log('Thumbnail created at', tempFilePath);
// We add a 'thumb_' prefix to thumbnails file name. That's where we'll upload the thumbnail.
const thumbFileName = `thumb_${fileName}`;
const thumbFilePath = path.join(path.dirname(filePath), thumbFileName);
// Uploading the thumbnail.
await bucket.upload(tempFilePath, {
  destination: thumbFilePath,
  metadata: metadata,
});
// Once the thumbnail has been uploaded delete the local file to free up disk space.
return fs.unlinkSync(tempFilePath);

Ce code exécute la convert programme de ligne de commande ImageMagick pour créer une vignette 200x200 pour l'image enregistrée dans un répertoire temporaire, puis la télécharge à nouveau dans Cloud Storage.

Explorez plus d'exemples

Plus d'exemples de fonctions de transformation multimédia courantes, notamment le transcodage d'images , la modération de contenu , l' extraction de métadonnées EXIF . La liste complète des exemples est disponible sur GitHub.

Voir la pleine trigger Google Cloud Storage documentation pour plus d' informations.