Questa pagina descrive come utilizzare l'SDK Cloud Storage for Firebase per scaricare file da un bucket Cloud Storage.
Crea 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 tuo bucket Cloud Storage oppure puoi creare un riferimento da un URL gs:// o https:// esistente che fa riferimento a un oggetto in Cloud Storage.
// Create a storage reference from your app
final storageRef = FirebaseStorage.instance.ref();
// Create a reference with an initial file path and name
final pathReference = storageRef.child("images/stars.jpg");
// Create a reference to a file from a Google Cloud Storage URI
final gsReference =
FirebaseStorage.instance.refFromURL("gs://YOUR_BUCKET/images/stars.jpg");
// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
final httpsReference = FirebaseStorage.instance.refFromURL(
"https://firebasestorage.googleapis.com/b/YOUR_BUCKET/o/images%20stars.jpg");
Scarica file
Una volta ottenuto un riferimento, puoi scaricare i file da Cloud Storage chiamando getData(). Se preferisci scaricare il file con un'altra libreria, puoi ottenere un URL di download con getDownloadUrl().
Scarica in memoria
Scarica il file in un UInt8List con il metodo getData(). Questo è il modo più semplice per scaricare un file, ma richiede il caricamento dell'intero contenuto del file in memoria. Se richiedi un file di dimensioni superiori alla memoria disponibile dell'app, l'app si arresterà in modo anomalo. Per proteggersi da problemi di memoria, getData()
accetta 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.
final islandRef = storageRef.child("images/island.jpg");
try {
const oneMegabyte = 1024 * 1024;
final Uint8List? data = await islandRef.getData(oneMegabyte);
// Data for "images/island.jpg" is returned, use this as needed.
} on FirebaseException catch (e) {
// Handle any errors.
}
Scarica in un file locale
Il metodo writeToFile() scarica un file direttamente su un dispositivo locale. Utilizza questa opzione se i tuoi utenti vogliono avere accesso al file offline o condividerlo in un'altra app. writeToFile() restituisce un DownloadTask che puoi utilizzare per gestire il download e monitorarne lo stato.
final islandRef = storageRef.child("images/island.jpg");
final appDocDir = await getApplicationDocumentsDirectory();
final filePath = "${appDocDir.absolute}/images/island.jpg";
final file = File(filePath);
final downloadTask = islandRef.writeToFile(file);
downloadTask.snapshotEvents.listen((taskSnapshot) {
switch (taskSnapshot.state) {
case TaskState.running:
// TODO: Handle this case.
break;
case TaskState.paused:
// TODO: Handle this case.
break;
case TaskState.success:
// TODO: Handle this case.
break;
case TaskState.canceled:
// TODO: Handle this case.
break;
case TaskState.error:
// TODO: Handle this case.
break;
}
});
Scarica i dati tramite URL
Se hai già un'infrastruttura di download basata su 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.
final imageUrl =
await storageRef.child("users/me/profile.png").getDownloadURL();
Gestione degli errori
Esistono diversi motivi per cui potrebbero verificarsi errori durante il download, ad esempio il file non esiste o l'utente non dispone dell'autorizzazione per accedere al file previsto. Per saperne di più sugli errori, consulta Gestisci gli errori.
Esempio completo
Di seguito è riportato un esempio completo di download con gestione degli errori:
final islandRef = storageRef.child("images/island.jpg");
final appDocDir = await getApplicationDocumentsDirectory();
final filePath = "${appDocDir.absolute}/images/island.jpg";
final file = File(filePath);
final downloadTask = islandRef.writeToFile(file);
downloadTask.snapshotEvents.listen((taskSnapshot) {
switch (taskSnapshot.state) {
case TaskState.running:
// TODO: Handle this case.
break;
case TaskState.paused:
// TODO: Handle this case.
break;
case TaskState.success:
// TODO: Handle this case.
break;
case TaskState.canceled:
// TODO: Handle this case.
break;
case TaskState.error:
// TODO: Handle this case.
break;
}
});
Puoi anche recuperare e aggiornare i metadati per i file archiviati in Cloud Storage.