Scaricare file con Cloud Storage su Flutter

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

Creazione di un riferimento

Per scaricare un file, crea prima 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 our 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 che hai 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 deve caricare l'intero contenuto di il tuo file in memoria. Se richiedi un file più grande della memoria disponibile dell'app, l'app si arresterà in modo anomalo. Per proteggerti dai problemi di memoria, getData() accetta una quantità massima di byte da scaricare. Imposta la dimensione massima su un valore che sai che la tua app può gestire oppure 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 questo metodo se gli 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 sugli URL o vuoi semplicemente un URL da condividere, puoi ottenere l'URL di download di un file chiamando il getDownloadURL() metodo su un riferimento Cloud Storage.

final imageUrl =
    await storageRef.child("users/me/profile.png").getDownloadURL();

Gestisci gli errori

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

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 ottenere e aggiornare i metadati dei file archiviati in Cloud Storage.