Ir a la consola

Descarga archivos en Android

Cloud Storage permite a los programadores descargar archivos con rapidez y facilidad desde un depósito de Google Cloud Storage que proporciona y administra Firebase.

Crea una referencia

Para descargar un archivo, primero crea una referencia de Cloud Storage al archivo que deseas descargar.

Para crear una referencia, puedes anexar rutas secundarias a la raíz del almacenamiento o puedes crear una referencia a partir de una URL gs:// o https:// existente que haga referencia a un objeto de Cloud Storage.

Java
Android

// 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
Android

// 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")

Descarga archivos

Cuando tengas una referencia, puedes descargar archivos desde Cloud Storage con una llamada a getBytes() o a getStream(). Si prefieres descargar el archivo con otra biblioteca, puedes obtener una URL de descarga con getDownloadUrl().

Descarga en la memoria

Descarga el archivo a un byte[] con el método getBytes(). Esta es la forma más fácil de descargar un archivo, pero debe cargar todo el contenido de tu archivo en la memoria. Si solicitas un archivo más grande que la memoria disponible de tu app, esta fallará. Para brindar protección contra los problemas de memoria, getBytes() necesita una cantidad mínima de bytes para descargar. Establece el tamaño máximo con un valor que sabes que tu app puede administrar o usa otro método de descarga.

Java
Android

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
Android

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
}

Descarga en un archivo local

El método getFile() descarga un archivo directamente a un dispositivo local. Usa esto si tus usuarios quieren tener acceso al archivo sin conexión o para compartir el archivo en una app diferente. getFile() muestra un DownloadTask que puedes usar para administrar tu descarga y supervisar el estado de la descarga.

Java
Android

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
Android

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
}

Si deseas administrar tu descarga de forma activa, consulta cómo administrar descargas para obtener más información.

Descarga datos a través de URL

Si ya tienes una estructura de descarga a partir de URL, o solo quieres una URL para compartir, puedes llamar al método getDownloadUrl() en una referencia de almacenamiento a fin de obtener la URL de descarga de un archivo.

Java
Android

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
Android

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

Descarga imágenes con FirebaseUI

FirebaseUI proporciona vínculos nativos simples, personalizables y listos para la producción con el objetivo de eliminar el código estándar y promover las prácticas recomendadas de Google. Con FirebaseUI, puedes descargar, almacenar en caché y mostrar imágenes con rapidez y facilidad desde Cloud Storage, gracias a nuestra integración con Glide.

Primero, agrega FirebaseUI a tu app/build.gradle:

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

Luego, puedes cargar imágenes directamente desde Storage a una ImageView:

Java
Android

// 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
Android

// 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)

Administra cambios en el ciclo de vida de una actividad

Las descargas continúan en segundo plano incluso después de que cambie el ciclo de vida de una actividad (como la presentación de un diálogo o la rotación de la pantalla). Si agregaste agentes de escucha, estos permanecen vinculados. Esto podría generar resultados inesperados si se los llama después de que se detiene la actividad.

Para solucionar este problema, puedes suscribir tus agentes de escucha a un alcance de la actividad para anular su registro automáticamente cuando se detenga la actividad. Luego, usa el método getActiveDownloadTasks cuando se reinicie la actividad para obtener las tareas de descarga que aún están en ejecución o que se completaron recientemente.

El siguiente ejemplo demuestra esto y cómo conservar la ruta de acceso de la referencia de almacenamiento usada.

Java
Android

@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
Android

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!
                // ...
            }
        }
    }
}

Manejo de errores

Existen varios motivos por los cuales pueden ocurrir errores en una descarga: por ejemplo, es posible que el archivo no exista o que el usuario no tenga permiso para acceder al archivo deseado. Para obtener más información sobre los errores, consulta la sección de los documentos denominada Soluciona errores.

Ejemplo completo

A continuación, se muestra un ejemplo completo de una descarga con manejo de errores:

Java
Android

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
Android

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

También puedes obtener y actualizar metadatos para los archivos almacenados en Cloud Storage.