Buka konsol

Mendownload File di Android

Dengan Cloud Storage, developer dapat mendownload file dengan cepat dan mudah dari bucket Google Cloud Storage yang disediakan dan dikelola oleh Firebase.

Membuat Referensi

Untuk mendownload file, buat referensi Cloud Storage terlebih dahulu pada file yang ingin didownload.

Anda dapat membuat referensi dengan menambahkan lokasi turunan ke root penyimpanan atau membuat referensi dari URL gs:// atau https:// yang mereferensikan objek dalam Cloud Storage.

Java

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

// Create a reference with an initial file path and name
StorageReference pathReference = storageRef.child("images/stars.jpg");

// Create a reference to a file from a Google Cloud Storage URI
StorageReference gsReference = storage.getReferenceFromUrl("gs://bucket/images/stars.jpg");

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
StorageReference httpsReference = storage.getReferenceFromUrl("https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg");

Kotlin

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

// Create a reference with an initial file path and name
val pathReference = storageRef.child("images/stars.jpg")

// Create a reference to a file from a Google Cloud Storage URI
val gsReference = storage.getReferenceFromUrl("gs://bucket/images/stars.jpg")

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
val httpsReference = storage.getReferenceFromUrl(
        "https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg")

Mendownload File

Setelah memiliki referensi, Anda dapat mendownload file dari Cloud Storage dengan memanggil getBytes() atau getStream(). Jika ingin mendownload file dengan pustaka lain, Anda bisa mendapatkan URL download dengan getDownloadUrl().

Mendownload di memori

Download file ke byte[] dengan metode getBytes(). Ini adalah cara termudah untuk mendownload file, tapi cara ini akan memuat seluruh konten file Anda ke dalam memori. Jika Anda meminta file yang lebih besar daripada kapasitas memori aplikasi yang tersedia, aplikasi akan mengalami error. Untuk melindungi dari masalah memori, getBytes() menggunakan jumlah byte maksimum untuk mendownload. Setel ukuran maksimum ke kapasitas yang Anda yakin bisa ditangani oleh aplikasi atau gunakan metode download lain.

Java

StorageReference islandRef = storageRef.child("images/island.jpg");

final long ONE_MEGABYTE = 1024 * 1024;
islandRef.getBytes(ONE_MEGABYTE).addOnSuccessListener(new OnSuccessListener<byte[]>() {
    @Override
    public void onSuccess(byte[] bytes) {
        // Data for "images/island.jpg" is returns, use this as needed
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception exception) {
        // Handle any errors
    }
});

Kotlin

var islandRef = storageRef.child("images/island.jpg")

val ONE_MEGABYTE: Long = 1024 * 1024
islandRef.getBytes(ONE_MEGABYTE).addOnSuccessListener {
    // Data for "images/island.jpg" is returned, use this as needed
}.addOnFailureListener {
    // Handle any errors
}

Mendownload ke file lokal

Metode getFile() langsung mendownload file ke perangkat lokal. Gunakan metode ini jika pengguna Anda ingin memiliki akses ke file saat offline atau membagikan file di aplikasi lain. getFile() mengembalikan DownloadTask yang bisa digunakan untuk mengelola download dan memantau status download.

Java

islandRef = storageRef.child("images/island.jpg");

File localFile = File.createTempFile("images", "jpg");

islandRef.getFile(localFile).addOnSuccessListener(new OnSuccessListener<FileDownloadTask.TaskSnapshot>() {
    @Override
    public void onSuccess(FileDownloadTask.TaskSnapshot taskSnapshot) {
        // Local temp file has been created
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception exception) {
        // Handle any errors
    }
});

Kotlin

islandRef = storageRef.child("images/island.jpg")

val localFile = File.createTempFile("images", "jpg")

islandRef.getFile(localFile).addOnSuccessListener {
    // Local temp file has been created
}.addOnFailureListener {
    // Handle any errors
}

Jika ingin mengelola download secara aktif, lihat Mengelola Download untuk informasi lebih lanjut.

Mendownload Data lewat URL

Jika Anda sudah memiliki infrastruktur download berbasis beberapa URL, atau sekadar menginginkan satu URL untuk dibagikan, Anda dapat memperoleh URL download ke suatu file dengan memanggil metode getDownloadUrl() pada referensi penyimpanan.

Java

storageRef.child("users/me/profile.png").getDownloadUrl().addOnSuccessListener(new OnSuccessListener<Uri>() {
    @Override
    public void onSuccess(Uri uri) {
        // Got the download URL for 'users/me/profile.png'
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception exception) {
        // Handle any errors
    }
});

Kotlin

storageRef.child("users/me/profile.png").downloadUrl.addOnSuccessListener {
    // Got the download URL for 'users/me/profile.png'
}.addOnFailureListener {
    // Handle any errors
}

Mendownload Gambar dengan FirebaseUI

FirebaseUI menyediakan ikatan seluler bawaan yang mudah, dapat disesuaikan, dan siap produksi untuk menghilangkan kode boilerplate dan mendorong praktik terbaik Google. Dengan FirebaseUI, Anda dapat mendownload, membuat cache, dan menampilkan gambar dari Cloud Storage dengan cepat dan mudah menggunakan integrasi kami dengan Glide.

Pertama, tambahkan FirebaseUI ke app/build.gradle:

dependencies {
    // FirebaseUI Storage only
    implementation 'com.firebaseui:firebase-ui-storage:4.3.1'
}

Anda dapat langsung memuat gambar dari Storage ke ImageView:

Java

// Reference to an image file in Cloud Storage
StorageReference storageReference = FirebaseStorage.getInstance().getReference();

// ImageView in your Activity
ImageView imageView = findViewById(R.id.imageView);

// Download directly from StorageReference using Glide
// (See MyAppGlideModule for Loader registration)
GlideApp.with(this /* context */)
        .load(storageReference)
        .into(imageView);

Kotlin

// Reference to an image file in Cloud Storage
val storageReference = FirebaseStorage.getInstance().reference

// ImageView in your Activity
val imageView = findViewById<ImageView>(R.id.imageView)

// Download directly from StorageReference using Glide
// (See MyAppGlideModule for Loader registration)
GlideApp.with(this /* context */)
        .load(storageReference)
        .into(imageView)

Menangani Perubahan Siklus Hidup Aktivitas

Download terus berlanjut di latar belakang bahkan setelah siklus proses aktivitas berubah (seperti menampilkan sebuah dialog atau memutar layar). Setiap listener yang telah terpasang juga akan tetap melekat. Listener yang dipanggil setelah aktivitas dihentikan dapat menyebabkan hasil yang tidak diharapkan.

Anda bisa mengatasi masalah ini dengan mendaftarkan listener ke cakupan aktivitas agar registrasinya dibatalkan secara otomatis saat aktivitas berhenti. Lalu, gunakan metode getActiveDownloadTasks saat aktivitas dimulai ulang untuk memperoleh tugas download yang masih berjalan atau baru saja diselesaikan.

Contoh di bawah memperlihatkan hal ini dan juga menampilkan cara mempertahankan lokasi referensi penyimpanan yang digunakan.

Java

@Override
protected void onSaveInstanceState(Bundle outState) {
    super.onSaveInstanceState(outState);

    // If there's a download in progress, save the reference so you can query it later
    if (mStorageRef != null) {
        outState.putString("reference", mStorageRef.toString());
    }
}

@Override
protected void onRestoreInstanceState(Bundle savedInstanceState) {
    super.onRestoreInstanceState(savedInstanceState);

    // If there was a download in progress, get its reference and create a new StorageReference
    final String stringRef = savedInstanceState.getString("reference");
    if (stringRef == null) {
        return;
    }
    mStorageRef = FirebaseStorage.getInstance().getReferenceFromUrl(stringRef);

    // Find all DownloadTasks under this StorageReference (in this example, there should be one)
    List<FileDownloadTask> tasks = mStorageRef.getActiveDownloadTasks();
    if (tasks.size() > 0) {
        // Get the task monitoring the download
        FileDownloadTask task = tasks.get(0);

        // Add new listeners to the task using an Activity scope
        task.addOnSuccessListener(this, new OnSuccessListener<FileDownloadTask.TaskSnapshot>() {
            @Override
            public void onSuccess(FileDownloadTask.TaskSnapshot state) {
                // Success!
                // ...
            }
        });
    }
}

Kotlin

override fun onSaveInstanceState(outState: Bundle) {
    super.onSaveInstanceState(outState)

    // If there's a download in progress, save the reference so you can query it later
    storageRef?.let {
        outState.putString("reference", it.toString())
    }
}

override fun onRestoreInstanceState(savedInstanceState: Bundle) {
    super.onRestoreInstanceState(savedInstanceState)

    // If there was a download in progress, get its reference and create a new StorageReference
    val stringRef = savedInstanceState.getString("reference") ?: return

    storageRef = FirebaseStorage.getInstance().getReferenceFromUrl(stringRef)

    // Find all DownloadTasks under this StorageReference (in this example, there should be one)
    val tasks = storageRef?.activeDownloadTasks

    tasks?.size?.let { it ->
        if (it > 0) {
            // Get the task monitoring the download
            val task = tasks[0]

            // Add new listeners to the task using an Activity scope
            task.addOnSuccessListener(this) {
                // Success!
                // ...
            }
        }
    }
}

Menangani Error

Ada sejumlah alasan penyebab terjadinya error pada download, 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 dokumen.

Contoh Lengkap

Contoh lengkap download dengan penanganan error ditampilkan di bawah ini:

Java

storageRef.child("users/me/profile.png").getBytes(Long.MAX_VALUE).addOnSuccessListener(new OnSuccessListener<byte[]>() {
    @Override
    public void onSuccess(byte[] bytes) {
        // Use the bytes to display the image
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception exception) {
        // Handle any errors
    }
});

Kotlin

storageRef.child("users/me/profile.png").getBytes(Long.MAX_VALUE).addOnSuccessListener {
    // Use the bytes to display the image
}.addOnFailureListener {
    // Handle any errors
}

Anda juga dapat mengambil dan mengupdate metadata untuk file yang disimpan di Cloud Storage.