Dateien mit Cloud Storage in Flutter herunterladen

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

Referenz erstellen

Um eine Datei herunterzuladen, erstellen Sie zuerst eine Cloud Storage-Referenz zur gewünschten Datei.

Sie können eine Referenz erstellen, indem Sie untergeordnete Pfade an den Stamm Ihres Cloud Storage-Buckets anhängen. Alternativ können Sie 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() aufrufen. Wenn Sie die Datei 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 getData() Methode in eine UInt8List herunter. Dies ist die einfachste Möglichkeit, eine Datei herunterzuladen. Dabei muss jedoch der gesamte Inhalt der Datei in den Arbeitsspeicher geladen werden. Wenn Sie eine Datei anfordern, die größer ist als der verfügbare Arbeitsspeicher Ihrer App, stürzt die App ab. Um Speicherprobleme zu vermeiden, getData() wird eine maximale Anzahl von Byte heruntergeladen. Legen Sie die maximale Größe auf einen Wert fest, den 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 Methode writeToFile() wird eine Datei direkt auf ein lokales Gerät heruntergeladen. Verwenden Sie diese Methode, wenn Ihre Nutzer offline auf die Datei zugreifen oder sie in einer anderen App freigeben möchten. writeToFile() gibt ein DownloadTask zurück, mit dem Sie den Download verwalten und den Status des Downloads beobachten 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 eine Downloadinfrastruktur haben, die auf URLs basiert, oder einfach nur eine URL zum Freigeben benötigen, können Sie die Download-URL für eine Datei abrufen, indem Sie die getDownloadURL() Methode für eine Cloud Storage-Referenz aufrufen.

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

Fehlerbehebung

Es gibt eine Reihe von Gründen, warum beim Herunterladen Fehler auftreten können. Dazu gehören beispielsweise, dass die Datei nicht vorhanden ist oder der Nutzer keine Berechtigung hat, auf die gewünschte Datei zuzugreifen. Weitere Informationen zu Fehlern finden Sie im Abschnitt Fehlerbehebung in der Dokumentation.

Vollständiges Beispiel

Im Folgenden 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 abrufen und aktualisieren für Dateien, die in Cloud Storage gespeichert sind.