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 są oparte na przykładowej funkcji, która jest wywoływana, gdy pliki obrazów są przesyłane do Cloud Storage. Ta przykładowa funkcja pokazuje, jak uzyskiwać dostęp do atrybutów zdarzenia, jak pobierać pliki do instancji Cloud Functions oraz jak radzić sobie z innymi podstawami obsługi zdarzeń Cloud Storage.

Zaimportuj wymagane moduły

Aby rozpocząć, zaimportuj moduł wymagany do obsługi zdarzeń Cloud Storage:

Node.js

 const {onObjectFinalized} = require("firebase-functions/v2/storage");
index.js

Python

 from firebase_functions import storage_fn
main.py

Aby utworzyć pełną wersję przykładu, dodaj też zależności dla narzędzi Firebase Admin SDK i przetwarzania obrazu:

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 = require("sharp");

initializeApp();
index.js

Python

 import io
import pathlib

from PIL import Image

from firebase_admin import initialize_app

initialize_app()
from firebase_admin import storage
main.py

Zakres funkcji Cloud Storage

Aby ograniczyć zakres funkcji do konkretnego zasobnika Cloud Storage i ustawić odpowiednie opcje, użyj tego wzorca:

Node.js

// scope handler to a specific bucket, using storage options parameter
export 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]):
    # ...

Z kolei przykładowa funkcja generatora miniatur jest ograniczona do domyślnego zasobnika w projekcie:

Node.js

exports.generateThumbnail = onObjectFinalized({cpu: 2}, async (event) => {
// ...
});

Python

@storage_fn.on_object_archived()
def generatethumbnail(event: storage_fn.CloudEvent[storage_fn.StorageObjectData]):
    # ...

Ustawianie lokalizacji funkcji

Niezgodność między tymi lokalizacjami może spowodować niepowodzenie wdrożenia. Ponadto odległość między lokalizacją zasobnika Cloud Storage a lokalizacją funkcji może powodować znaczne opóźnienia w sieci. Aby uniknąć takich sytuacji, określ lokalizację funkcji tak, aby odpowiadała ona lokalizacji puli lub reguły w jednym z tych sposobów:

  • Lokalizacja funkcji jest taka sama jak lokalizacja reguły
  • Lokalizacja funkcji znajduje się w lokalizacji aktywatora (gdy region aktywatora jest regionem podwójnym lub regionem w wielu regionach).
  • Funkcja może być wykonywana w dowolnej lokalizacji, jeśli region reguły jest ustawiony na us-central1

Obsługa zdarzeń Cloud Storage

Dostępne są te moduły obsługi zdarzeń Cloud Storage:

Node.js

  • onObjectArchived Wysyłane tylko wtedy, gdy w zasobniku jest włączona obsługa wersji obiektów. 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.
  • onObjectDeleted Wysyłane po nieodwracalnym usunięciu obiektu. Dotyczy to obiektów, 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 wysyłane, gdy obiekt zostanie zarchiwizowany (patrz onArchive), nawet jeśli archiwizacja nastąpiła za pomocą metody storage.objects.delete.
  • onObjectFinalized 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.
  • onMetadataUpdated Wysyłane po zmianie metadanych istniejącego obiektu.

Python

  • on_object_archived Wysyłane tylko wtedy, gdy w zasobniku jest włączona obsługa wersji obiektów. 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.
  • on_object_deleted Wysyłane po nieodwracalnym usunięciu obiektu. Dotyczy to obiektów, 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 wysyłane, gdy obiekt zostanie zarchiwizowany (patrz onArchive), nawet jeśli archiwizacja nastąpiła za pomocą metody storage.objects.delete.
  • on_object_finalized 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.
  • on_metadata_updated Wysyłane po zmianie metadanych istniejącego obiektu.

Dostęp do atrybutów obiektu Cloud Storage

Cloud Functions udostępnia kilka atrybutów obiektu Cloud Storage, takich jak rozmiar obiektu i typ treści zaktualizowanego pliku. Atrybut metageneration zwiększa się za każdym razem, gdy nastąpi zmiana metadanych obiektu. W przypadku nowych obiektów wartość metageneration to 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.
index.js

Python

bucket_name = event.data.bucket
file_path = pathlib.PurePath(event.data.name)
content_type = event.data.content_type
main.py

Przykład generowania miniatur wykorzystuje niektóre z tych atrybutów do wykrywania przypadków wyjścia, w których funkcja zwraca:

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.");
}
index.js

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
main.py

Pobieranie, przekształcanie i przesyłanie pliku

W niektórych przypadkach pobieranie plików z Cloud Storage może nie być konieczne. Jednak aby wykonywać intensywne zadania, takie jak generowanie miniatury z pliku przechowywanego w Cloud Storage, musisz pobrać pliki do instancji funkcji, czyli maszyny wirtualnej, na której działa Twój kod.

Korzystając z Cloud Functions i programów do przetwarzania obrazów, takich jak sharp w przypadku Node.js oraz Pillow w przypadku Pythona, możesz manipulować plikami graficznymi. Oto przykład tworzenia miniatury przesłanego pliku graficznego:

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!");
});
index.js

Pobierz plik do tymczasowego katalogu na instancji Cloud Functions. W tym miejscu możesz przetworzyć plik zgodnie z potrzebami, a następnie przesłać go do Cloud Storage. Podczas wykonywania zadań asynchronicznych pamiętaj, aby zwrócić obietnicę JavaScriptu w funkcji wywołania zwrotnego.

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")
main.py

Ten kod tworzy miniaturę 200 x 200 dla obrazu zapisanego w tymczasowym katalogu, a potem przesyła go z powrotem do Cloud Storage.