Menggunakan metadata file dengan Cloud Storage di Flutter

Setelah mengupload file ke referensi Cloud Storage, Anda juga dapat mengambil dan memperbarui metadata file, misalnya untuk melihat atau memperbarui jenis konten. File juga dapat menyimpan key-value pair kustom dengan metadata file tambahan.

Mengambil Metadata File

Metadata file berisi properti umum, seperti name, size, dan contentType (sering disebut jenis MIME), serta beberapa properti yang jarang digunakan, seperti contentDisposition dan timeCreated. Metadata ini dapat diambil dari referensi Cloud Storage menggunakan metode getMetadata().

// Create reference to the file whose metadata we want to retrieve
final forestRef = storageRef.child("images/forest.jpg");

// Get metadata properties
final metadata = await forestRef.getMetadata();

// Metadata now contains the metadata for 'images/forest.jpg'

Memperbarui Metadata File

Anda dapat memperbarui metadata file kapan saja setelah file selesai diupload menggunakan metode updateMetadata(). Lihat daftar lengkap untuk mengetahui informasi lebih lanjut mengenai properti yang dapat diperbarui. Hanya properti yang ditetapkan dalam metadata yang akan diperbarui, sedangkan yang lainnya tidak berubah.

// Create reference to the file whose metadata we want to change
final forestRef = storageRef.child("images/forest.jpg");

// Create file metadata to update
final newMetadata = SettableMetadata(
  cacheControl: "public,max-age=300",
  contentType: "image/jpeg",
);

// Update metadata properties
final metadata = await forestRef.updateMetadata(newMetadata);

// Updated metadata for 'images/forest.jpg' is returned

Anda dapat menghapus properti metadata yang dapat ditulis dengan meneruskan null:

// Delete the cacheControl property
final newMetadata = SettableMetadata(cacheControl: null);
final metadata = await forestRef.updateMetadata(newMetadata);

Menangani Error

Ada sejumlah alasan penyebab terjadinya error saat mengambil atau memperbarui metadata, termasuk tidak adanya file atau pengguna tidak memiliki izin untuk mengakses file yang diinginkan. Informasi lebih lanjut mengenai error bisa dilihat di bagian Menangani Error pada dokumentasi.

Metadata Kustom

Anda dapat menentukan metadata kustom menggunakan parameter customMetadata dari konstruktor SettableMetadata:

// Create reference to the file whose metadata we want to change
final forestRef = storageRef.child("images/forest.jpg");

// Create file metadata to update
final newCustomMetadata = SettableMetadata(
  customMetadata: {
    "location": "Yosemite, CA, USA",
    "activity": "Hiking",
  },
);

// Update metadata properties
final metadata = await forestRef.updateMetadata(newCustomMetadata);

// Updated metadata for 'images/forest.jpg' is returned

Anda dapat menyimpan data khusus aplikasi untuk setiap file dalam metadata kustom, tetapi kami sangat menyarankan penggunaan database (seperti Firebase Realtime Database) untuk menyimpan dan menyinkronkan jenis data ini.

Properti Metadata File

Daftar lengkap properti metadata pada file tercantum di bawah ini:

Properti	Jenis	Dapat disetel?
`bucket`	`String`	Tidak
`generation`	`String`	Tidak
`metageneration`	`String`	Tidak
`metadataGeneration`	`String`	Tidak
`fullPath`	`String`	Tidak
`name`	`String`	Tidak
`size`	`int`	Tidak
`timeCreated`	`DateTime`	Tidak
`updated`	`DateTime`	Tidak
`md5Hash`	`String`	Tidak
`cacheControl`	`String`	Ya
`contentDisposition`	`String`	Ya
`contentEncoding`	`String`	Ya
`contentLanguage`	`String`	Ya
`contentType`	`String`	Ya
`customMetadata`	`Map<String, String>`	Ya

Mengupload, mendownload, dan memperbarui file itu penting, tetapi kita juga harus bisa menghapusnya. Mari pelajari cara menghapus file dari Cloud Storage.