Aktywatory Cloud Storage


Możesz aktywować funkcję w odpowiedzi na przesłanie, zaktualizowanie lub usunięcie plików i folderów w Cloud Storage.

Przykłady na tej stronie opierają się na przykładowej funkcji, która jest aktywowana, gdy pliki obrazów są przesyłane do Cloud Storage. Ta przykładowa funkcja pokazuje, jak uzyskać dostęp do atrybutów zdarzeń, jak pobrać plik do instancji Cloud Functions i jak wykonać inne podstawy obsługi zdarzeń Cloud Storage.

Więcej przykładów zastosowań znajdziesz w artykule Co mogę zrobić przy użyciu Cloud Functions?.

Aktywowanie funkcji w przypadku zmian w Cloud Storage

Użyj functions.storage, aby utworzyć funkcję obsługującą zdarzenia Cloud Storage. W zależności od tego, czy chcesz ograniczyć działanie funkcji do konkretnego zasobnika Cloud Storage, czy do domyślnego zasobnika, użyj jednej z tych opcji:

Na przykład próbka generatora miniatur jest ograniczona do domyślnego zasobnika w projekcie:

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

Cloud Storage obsługuje te zdarzenia:

  • onArchive Wysyłane tylko wtedy, gdy zasobnik ma włączoną obsługę wersji obiektu. To zdarzenie wskazuje, że bieżąca wersja obiektu stała się wersją archiwalną – została zarchiwizowana albo zastąpiona przez przesłany obiekt o tej samej nazwie.
  • onDelete Wysyłane, gdy obiekt został trwale usunięty. Obejmuje to obiekty, które zostały zastąpione lub usunięte w ramach konfiguracji cyklu życia zasobnika. W przypadku zasobników z włączoną obsługą wersji obiektów nie jest ona wysyłana po zarchiwizowaniu obiektu (patrz onArchive), nawet jeśli archiwizacja odbywa się za pomocą metody storage.objects.delete.
  • onFinalize Wysyłane po utworzeniu w zasobniku nowego obiektu (lub nowej generacji istniejącego obiektu). Obejmuje to skopiowanie lub ponowne zapisanie istniejącego obiektu. Zdarzenia tego nie aktywuje nieudane przesyłanie.
  • onMetadataUpdate Wysyłane po zmianie metadanych istniejącego obiektu.

Ustaw zdarzenie w module obsługi zdarzeń on w podany niżej sposób dla elementu onFinalize.

Dostęp do atrybutów obiektów Cloud Storage

Cloud Functions udostępnia wiele atrybutów obiektu w Cloud Storage, takich jak size i contentType, w przypadku aktualizacji pliku. Atrybut 'metageneration' zwiększa się po każdej zmianie metadanych obiektu. W przypadku nowych obiektów wartość metageneration wynosi 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

Przykładowy generowanie miniatury używa niektórych z tych atrybutów do wykrywania przypadków wyjścia, w których funkcja zwraca:

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

Pobieranie, przekształcanie i przesyłanie pliku

W niektórych przypadkach pobieranie plików z Cloud Storage może nie być konieczne. Jednak aby wykonać intensywne zadania, takie jak generowanie miniaturowego obrazu z pliku zapisanego w Cloud Storage, musisz pobrać pliki do instancji funkcji, czyli maszyny wirtualnej, która uruchamia Twój kod.

Aby łatwo pobierać i ponownie przesyłać obiekty do Cloud Storage, zainstaluj pakiet Google Cloud Storage za pomocą npm install --save @google-cloud/storage, a następnie zaimportuj go. Aby korzystać z obietnic JavaScript do obsługi procesów zewnętrznych, takich jak zadania przetwarzania miniatur w przykładzie, zaimportuj też 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

Użyj narzędzia gcs.bucket.file(filePath).download, aby pobrać plik do katalogu tymczasowego w instancji Cloud Functions. W tej lokalizacji możesz przetworzyć plik w razie potrzeby, a potem przesłać go do Cloud Storage. Podczas wykonywania zadań asynchronicznych pamiętaj, aby zwracać obietnicę JavaScript w wywołaniu zwrotnym.

Przykład: przekształcenie obrazu

Używając Cloud Functions razem z programami do przetwarzania obrazów, takimi jak sharp, możesz wykonywać operacje na plikach graficznych. Oto przykład tworzenia miniatury przesłanego pliku obrazu:

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

Ten kod tworzy miniaturę 200 × 200 obrazu zapisanego w katalogu tymczasowym, a następnie przesyła go z powrotem do Cloud Storage.

Zobacz więcej przykładów

Więcej przykładów typowych funkcji przekształcania multimediów, m.in. transkodowania obrazów, moderowania treści i wyodrębniania metadanych EXIF. Pełna lista przykładów jest dostępna na GitHubie.