Menggunakan metadata file dengan Cloud Storage di Android

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().

Kotlin+KTX

// Create a storage reference from our app
val storageRef = storage.reference

// Get reference to the file
val forestRef = storageRef.child("images/forest.jpg")
forestRef.metadata.addOnSuccessListener { metadata ->
    // Metadata now contains the metadata for 'images/forest.jpg'
}.addOnFailureListener {
    // Uh-oh, an error occurred!
}
StorageActivity.kt

Java

// Create a storage reference from our app
StorageReference storageRef = storage.getReference();

// Get reference to the file
StorageReference forestRef = storageRef.child("images/forest.jpg");
forestRef.getMetadata().addOnSuccessListener(new OnSuccessListener<StorageMetadata>() {
    @Override
    public void onSuccess(StorageMetadata storageMetadata) {
        // Metadata now contains the metadata for 'images/forest.jpg'
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception exception) {
        // Uh-oh, an error occurred!
    }
});
StorageActivity.java

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.

Kotlin+KTX

// Create a storage reference from our app
val storageRef = storage.reference

// Get reference to the file
val forestRef = storageRef.child("images/forest.jpg")
// Create file metadata including the content type
val metadata = storageMetadata {
    contentType = "image/jpg"
    setCustomMetadata("myCustomProperty", "myValue")
}

// Update metadata properties
forestRef.updateMetadata(metadata).addOnSuccessListener { updatedMetadata ->
    // Updated metadata is in updatedMetadata
}.addOnFailureListener {
    // Uh-oh, an error occurred!
}
StorageActivity.kt

Java

// Create a storage reference from our app
StorageReference storageRef = storage.getReference();

// Get reference to the file
StorageReference forestRef = storageRef.child("images/forest.jpg");
// Create file metadata including the content type
StorageMetadata metadata = new StorageMetadata.Builder()
        .setContentType("image/jpg")
        .setCustomMetadata("myCustomProperty", "myValue")
        .build();

// Update metadata properties
forestRef.updateMetadata(metadata)
        .addOnSuccessListener(new OnSuccessListener<StorageMetadata>() {
            @Override
            public void onSuccess(StorageMetadata storageMetadata) {
                // Updated metadata is in storageMetadata
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception exception) {
                // Uh-oh, an error occurred!
            }
        });
StorageActivity.java

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

Kotlin+KTX

// Create file metadata with property to delete
val metadata = storageMetadata {
    contentType = null
}

// Delete the metadata property
forestRef.updateMetadata(metadata).addOnSuccessListener { updatedMetadata ->
    // updatedMetadata.contentType should be null
}.addOnFailureListener {
    // Uh-oh, an error occurred!
}
StorageActivity.kt

Java

// Create file metadata with property to delete
StorageMetadata metadata = new StorageMetadata.Builder()
        .setContentType(null)
        .build();

// Delete the metadata property
forestRef.updateMetadata(metadata)
        .addOnSuccessListener(new OnSuccessListener<StorageMetadata>() {
            @Override
            public void onSuccess(StorageMetadata storageMetadata) {
                // metadata.contentType should be null
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception exception) {
                // Uh-oh, an error occurred!
            }
        });
StorageActivity.java

Menangani Error

Ada sejumlah alasan 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 metode setCustomMetadata() di class StorageMetadata.Builder.

Kotlin+KTX

val metadata = storageMetadata {
    setCustomMetadata("location", "Yosemite, CA, USA")
    setCustomMetadata("activity", "Hiking")
}
StorageActivity.kt

Java

StorageMetadata metadata = new StorageMetadata.Builder()
        .setCustomMetadata("location", "Yosemite, CA, USA")
        .setCustomMetadata("activity", "Hiking")
        .build();
StorageActivity.java

Anda dapat menyimpan data khusus aplikasi untuk setiap file di metadata kustom, tetapi sebaiknya Anda menggunakan database (seperti Firebase Realtime Database) untuk menyimpan dan menyinkronkan jenis data seperti ini.

Properti Metadata File

Berikut adalah daftar lengkap properti metadata di file:

Pengambil Properti Jenis Ada Penyetel
getBucket String TIDAK
getGeneration String BUKAN
getMetadataGeneration String BUKAN
getPath String BUKAN
getName String BUKAN
getSizeBytes long BUKAN
getCreationTimeMillis long BUKAN
getUpdatedTimeMillis long BUKAN
getMd5Hash String TIDAK
getCacheControl String YA
getContentDisposition String YA
getContentEncoding String YA
getContentLanguage String YA
getContentType String YA
getCustomMetadata String YA
getCustomMetadataKeys Set<String> TIDAK

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