Scaricare file con Cloud Storage su Android

Cloud Storage for Firebase ti consente di scaricare in modo rapido e semplice i file da un bucket Cloud Storage fornito e gestito da Firebase.

Nota: per impostazione predefinita, un bucket Cloud Storage for Firebase richiede Firebase Authentication per eseguire qualsiasi azione sui dati o sui file del bucket. Puoi modificare il tuo Firebase Security Rules per Cloud Storage in modo da consentire l'accesso non autenticato per situazioni specifiche. Tuttavia, per la maggior parte delle situazioni, ti consigliamo vivamente di limitare l'accesso e configurare regole di sicurezza solide (soprattutto per le app di produzione). Tieni presente che se utilizzi Google App Engine e hai un bucket Cloud Storage predefinito con un formato del nome *.appspot.com, potresti dover considerare in che modo le regole di sicurezza influiscono sull'accesso ai file App Engine.

Creazione di un riferimento

Per scaricare un file, devi prima creare un riferimento Cloud Storage al file che vuoi scaricare.

Puoi creare un riferimento aggiungendo percorsi secondari alla radice del bucket Cloud Storage oppure puoi creare un riferimento da un URL gs:// o https:// esistente che fa riferimento a un oggetto in Cloud Storage.

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",
)
StorageActivity.kt

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");
StorageActivity.java

Scarica file

Una volta ottenuto un riferimento, puoi scaricare i file da Cloud Storage chiamando getBytes() o getStream(). Se preferisci scaricare il file con un'altra libreria, puoi ottenere un URL di download con getDownloadUrl().

Download in memoria

Scarica il file in un byte[] con il metodo getBytes(). Questo è il modo più semplice per scaricare un file, ma deve caricare l'intero contenuto del file in memoria. Se richiedi un file più grande della memoria disponibile della tua app, l'app si arresterà in modo anomalo. Per proteggere da problemi di memoria, getBytes() richiede un numero massimo di byte da scaricare. Imposta la dimensione massima su un valore che sai che la tua app può gestire o utilizza un altro metodo di download.

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
}
StorageActivity.kt

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
    }
});
StorageActivity.java

Scarica in un file locale

Il metodo getFile() scarica un file direttamente su un dispositivo locale. Utilizza questo metodo se i tuoi utenti vogliono accedere al file offline o condividerlo in un'altra app. getFile() restituisce un DownloadTask che puoi utilizzare per gestire il download e monitorarne lo stato.

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
}
StorageActivity.kt

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
    }
});
StorageActivity.java

Se vuoi gestire attivamente il download, consulta la sezione Gestire i download per ulteriori informazioni.

Scaricare dati tramite URL

Se disponi già di un'infrastruttura di download basata sugli URL o vuoi semplicemente un URL da condividere, puoi ottenere l'URL di download di un file chiamando il metodo getDownloadUrl() su un riferimento Cloud Storage.

Kotlin

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

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
    }
});
StorageActivity.java

Download di immagini con FirebaseUI

FirebaseUI fornisce binding per dispositivi mobili nativi semplici, personalizzabili e pronti per la produzione per eliminare il codice boilerplate e promuovere le best practice di Google. Utilizzando FirebaseUI puoi scaricare, memorizzare nella cache e visualizzare immagini da Cloud Storage in modo rapido e semplice utilizzando la nostra integrazione con Glide.

Innanzitutto, aggiungi FirebaseUI al tuo app/build.gradle:

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

A questo punto puoi caricare le immagini direttamente da Cloud Storage in un ImageView:

Kotlin

// Reference to an image file in Cloud Storage
val storageReference = Firebase.storage.reference

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

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

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)
Glide.with(context)
        .load(storageReference)
        .into(imageView);
FirebaseUIActivity.java

Gestire le modifiche al ciclo di vita dell'attività

I download continuano in background anche dopo le modifiche al ciclo di vita dell'attività (ad esempio, la visualizzazione di una finestra di dialogo o la rotazione dello schermo). Gli ascoltatori che avevi aggiunto rimarranno collegati. Ciò potrebbe causare risultati imprevisti se vengono chiamati dopo l'interruzione dell'attività.

Puoi risolvere questo problema registrando i tuoi ascoltatori con un ambito di attività per annullare automaticamente la loro registrazione quando l'attività si interrompe. Quindi, utilizza il metodo getActiveDownloadTasks quando l'attività viene riavviata per ottenere le attività di download ancora in esecuzione o completate di recente.

L'esempio seguente lo dimostra e mostra anche come rendere persistente il percorso di riferimento dell'archiviazione utilizzato.

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
    outState.putString("reference", storageRef.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 = Firebase.storage.getReferenceFromUrl(stringRef)

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

    if (tasks.size > 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!
            // ...
        }
    }
}
DownloadActivity.kt

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!
                // ...
            }
        });
    }
}
DownloadActivity.java

Gestisci gli errori

Esistono diversi motivi per cui potrebbero verificarsi errori durante il download, tra cui l'assenza del file o l'utente non dispone dell'autorizzazione per accedere al file desiderato. Per ulteriori informazioni sugli errori, consulta la sezione Gestire gli errori della documentazione.

Esempio completo

Di seguito è riportato un esempio completo di download con gestione degli errori:

Kotlin

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

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
    }
});
StorageActivity.java

Puoi anche recuperare e aggiornare i metadati per i file archiviati in Cloud Storage.