Catch up on everthing we announced at this year's Firebase Summit. Learn more

Pemicu Cloud Storage

Anda dapat memicu fungsi sebagai respons terhadap upload, pembaruan, atau penghapusan file dan folder di Cloud Storage.

Contoh di halaman ini didasarkan pada fungsi contoh yang dipicu saat file gambar diupload ke Cloud Storage. Fungsi contoh ini menunjukkan cara mengakses atribut peristiwa, cara mendownload file ke instance Cloud Functions, dan hal mendasar lainnya terkait penanganan peristiwa Cloud Storage.

Untuk mengetahui contoh kasus penggunaan lainnya, baca artikel Apa yang bisa dilakukan dengan Cloud Functions?

Memicu fungsi saat terjadi perubahan di Cloud Storage

Gunakan functions.storage untuk membuat fungsi yang menangani peristiwa Cloud Storage. Gunakan salah satu fungsi berikut, tergantung apakah Anda ingin mencakup fungsi ke bucket Cloud Storage tertentu atau menggunakan bucket default:

Misalnya, contoh pembuat thumbnail ini tercakup dalam bucket default project ini:

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

Cloud Storage mendukung peristiwa ini:

  • onArchive Hanya dikirim saat bucket telah mengaktifkan pembuatan versi objek. Peristiwa ini menunjukkan bahwa versi aktif sebuah objek telah menjadi versi yang diarsipkan, baik karena versi tersebut memang telah diarsipkan maupun karena sudah ditimpa oleh objek yang diupload dengan nama yang sama.
  • onDelete Dikirim saat sebuah objek telah dihapus secara permanen. Ini mencakup objek yang ditimpa atau dihapus sebagai bagian dari konfigurasi siklus proses bucket. Untuk bucket yang telah mengaktifkan pembuatan versi objek, peristiwa ini tidak akan dikirim saat objek diarsipkan (lihat onArchive), meskipun pengarsipan terjadi melalui metode storage.objects.delete.
  • onFinalize Dikirim saat objek baru (atau pembuatan ulang objek yang sudah ada) berhasil dibuat dalam bucket. Hal ini meliputi penyalinan atau penulisan ulang objek yang sudah ada. Peristiwa ini tidak akan terpicu oleh upload yang gagal.
  • onMetadataUpdate Dikirim saat terjadi perubahan terhadap metadata objek yang ada.

Tetapkan peristiwa dalam pengendali peristiwa on seperti yang ditunjukkan di atas untuk onFinalize.

Mengakses atribut objek Cloud Storage

Cloud Functions menampilkan sejumlah atribut objek Cloud Storage, seperti size dan contentType, untuk file yang diperbarui. Atribut 'metageneration' bertambah setiap kali terjadi perubahan pada metadata objek. Untuk objek baru, nilai metageneration adalah 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.

Contoh pembuatan thumbnail ini menggunakan sejumlah atribut tersebut untuk mendeteksi kasus keluar. Dalam kasus tersebut, fungsi menampilkan:

// 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.');
}

Mendownload, mentransformasi, dan mengupload file

Untuk beberapa kasus, mendownload file dari Cloud Storage mungkin tidak diperlukan. Namun, untuk melakukan tugas intensif, seperti membuat gambar thumbnail dari file yang disimpan di Cloud Storage, Anda harus mendownload file ke instance fungsi—yakni, mesin virtual yang menjalankan kode Anda.

Untuk mendownload dan mengupload ulang objek ke Cloud Storage dengan mudah, instal paket Google Cloud Storage menggunakan npm install --save @google-cloud/storage, lalu impor paket tersebut. Untuk menggunakan promise JavaScript yang akan menangani proses eksternal, seperti tugas pemrosesan thumbnail dalam contoh, impor juga 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');

Gunakan gcs.bucket.file(filePath).download untuk mendownload file ke direktori sementara pada instance Cloud Functions Anda. Di lokasi ini, Anda dapat memproses file sesuai kebutuhan, kemudian menguploadnya ke Cloud Storage. Saat melakukan tugas asinkron, pastikan untuk menampilkan promise JavaScript di callback Anda.

Contoh: transformasi gambar

Cloud Functions menyediakan program pemrosesan gambar yang bernama ImageMagick. Program ini dapat digunakan untuk melakukan manipulasi pada file gambar grafis. Berikut ini adalah contoh cara membuat gambar thumbnail untuk file gambar yang diupload:

// 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});
functions.logger.log('Image downloaded locally to', tempFilePath);
// Generate a thumbnail using ImageMagick.
await spawn('convert', [tempFilePath, '-thumbnail', '200x200>', tempFilePath]);
functions.logger.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);

Kode ini mengeksekusi program command line ImageMagick, yaitu convert, untuk membuat thumbnail berukuran 200x200 untuk gambar yang disimpan dalam direktori sementara, lalu menguploadnya kembali ke Cloud Storage.

Mempelajari contoh lainnya

Contoh fungsi transformasi media umum lainnya meliputi transcoding gambar, memoderasi konten, mengekstrak metadata EXIF. Daftar lengkap contoh tersedia di GitHub.

Baca dokumentasi lengkap pemicu Google Cloud Storage untuk informasi lebih lanjut.