Dateien mit Cloud Storage in Flutter herunterladen

Mit Cloud Storage for Firebase können Sie Dateien schnell und einfach aus einem Cloud Storage-Bucket herunterladen, der von Firebase bereitgestellt und verwaltet wird.

Referenz erstellen

Wenn Sie eine Datei herunterladen möchten, erstellen Sie zuerst eine Cloud Storage-Referenz für die Datei, die Sie herunterladen möchten.

Sie können eine Referenz erstellen, indem Sie dem Stammverzeichnis Ihres Cloud Storage-Buckets untergeordnete Pfade anhängen. Sie können auch eine Referenz über eine vorhandene 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 abrufen.

In den Arbeitsspeicher herunterladen

Laden Sie die Datei mit der Methode getData() auf eine UInt8List herunter. Dies ist die einfachste Methode zum Herunterladen einer Datei. Allerdings muss der gesamte Inhalt der Datei in den Arbeitsspeicher geladen werden. Wenn Sie eine Datei anfordern, die größer als der verfügbare Arbeitsspeicher Ihrer App ist, stürzt Ihre App ab. Zum Schutz vor Speicherproblemen lädt getData() nur eine bestimmte maximale Anzahl von Byte herunter. Legen Sie eine maximale Größe fest, die Ihre App verarbeiten kann, oder verwenden Sie eine andere Downloadmethode.

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

Mit der writeToFile()-Methode wird eine Datei direkt auf ein lokales Gerät heruntergeladen. Verwenden Sie diese Option, wenn Ihre Nutzer offline auf die Datei zugreifen oder sie in einer anderen App freigeben möchten. writeToFile() gibt eine DownloadTask zurück, mit der Sie den Download verwalten und den Status des Downloads im Blick behalten 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 per URL herunterladen

Wenn Sie bereits eine URL-basierte Downloadinfrastruktur haben oder nur eine URL zum Freigeben benötigen, können Sie die Download-URL für eine Datei abrufen, indem Sie die Methode getDownloadURL() für eine Cloud Storage-Referenz aufrufen.

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

Fehler behandeln

Es kann verschiedene Gründe dafür geben, dass beim Download Fehler auftreten. Beispielsweise kann die Datei nicht vorhanden sein oder der Nutzer hat keine Berechtigung zum Zugriff auf die gewünschte Datei. Weitere Informationen zu Fehlern finden Sie im Abschnitt Fehler beheben der Dokumentation.

Vollständiges Beispiel

Unten sehen Sie ein vollständiges Beispiel für einen Download mit Fehlerbehandlung:

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.