Laden Sie Dateien mit Cloud Storage auf Flutter herunter

Mit Cloud Storage für Firebase können Sie schnell und einfach Dateien aus einem von Firebase bereitgestellten und verwalteten Cloud Storage- Bucket herunterladen.

Erstellen Sie eine Referenz

Um eine Datei herunterzuladen, erstellen Sie zunächst einen Cloud Storage-Verweis auf die Datei, die Sie herunterladen möchten.

Sie können eine Referenz erstellen, indem Sie untergeordnete Pfade an das Stammverzeichnis Ihres Cloud Storage-Buckets anhängen, oder Sie können eine Referenz aus einer vorhandenen gs:// oder https:// URL erstellen, die auf ein Objekt in Cloud Storage verweist.

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

Dateien herunterladen

Sobald Sie eine Referenz haben, können Sie Dateien aus Cloud Storage herunterladen, indem Sie getData() oder getStream() aufrufen. Wenn Sie die Datei lieber mit einer anderen Bibliothek herunterladen möchten, können Sie mit getDownloadUrl() eine Download-URL erhalten.

Im Speicher herunterladen

Laden Sie die Datei mit der Methode getData() in eine UInt8List herunter. Dies ist die einfachste Möglichkeit, eine Datei herunterzuladen, es muss jedoch der gesamte Inhalt Ihrer Datei in den Speicher geladen werden. Wenn Sie eine Datei anfordern, die größer ist als der verfügbare Speicher Ihrer App, stürzt Ihre App ab. Zum Schutz vor Speicherproblemen benötigt getData() zum Herunterladen eine maximale Anzahl an Bytes. Legen Sie die maximale Größe auf einen Wert fest, von dem Sie wissen, dass Ihre App ihn verarbeiten kann, oder verwenden Sie eine andere Download-Methode.

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

In eine lokale Datei herunterladen

Die Methode writeToFile() lädt eine Datei direkt auf ein lokales Gerät herunter. Verwenden Sie diese Option, wenn Ihre Benutzer offline auf die Datei zugreifen oder die Datei in einer anderen App teilen möchten. writeToFile() gibt eine DownloadTask zurück, mit der Sie Ihren Download verwalten und den Status des Downloads überwachen können.

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;
  }
});

Daten über URL herunterladen

Wenn Sie bereits über eine auf URLs basierende Download-Infrastruktur verfügen oder einfach nur eine URL teilen möchten, können Sie die Download-URL für eine Datei abrufen, indem Sie die Methode getDownloadURL() in einer Cloud Storage-Referenz aufrufen.

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

Behandeln Sie Fehler

Es gibt eine Reihe von Gründen, warum beim Herunterladen Fehler auftreten können, darunter, dass die Datei nicht vorhanden ist oder der Benutzer keine Berechtigung zum Zugriff auf die gewünschte Datei hat. Weitere Informationen zu Fehlern finden Sie im Abschnitt „Fehler behandeln“ der Dokumentation.

Vollständiges Beispiel

Ein vollständiges Beispiel für einen Download mit Fehlerbehandlung ist unten dargestellt:

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;
  }
});

Sie können auch Metadaten für Dateien abrufen und aktualisieren , die in Cloud Storage gespeichert sind.