Dateien mit Cloud Storage auf Flutter hochladen

Mit Cloud Storage for Firebase können Sie Dateien schnell und einfach in einen Cloud Storage-Bucket hochladen, der von Firebase bereitgestellt und verwaltet wird.

Dateien hochladen

Wenn Sie eine Datei in Cloud Storage hochladen möchten, erstellen Sie zuerst einen Verweis auf den vollständigen Pfad der Datei, einschließlich des Dateinamens.

// Create a storage reference from our app
final storageRef = FirebaseStorage.instance.ref();

// Create a reference to "mountains.jpg"
final mountainsRef = storageRef.child("mountains.jpg");

// Create a reference to 'images/mountains.jpg'
final mountainImagesRef = storageRef.child("images/mountains.jpg");

// While the file names are the same, the references point to different files
assert(mountainsRef.name == mountainImagesRef.name);
assert(mountainsRef.fullPath != mountainImagesRef.fullPath);

Nachdem Sie eine entsprechende Referenz erstellt haben, rufen Sie die Methode putFile(), putString() oder putData() auf, um die Datei in Cloud Storage hochzuladen.

Sie können keine Daten mit einem Verweis auf das Stammverzeichnis Ihres Cloud Storage-Buckets hochladen. Der Verweis muss auf eine untergeordnete URL verweisen.

Aus einer Datei hochladen

Wenn Sie eine Datei hochladen möchten, müssen Sie zuerst den absoluten Pfad zu ihrem Speicherort auf dem Gerät abrufen. Wenn sich eine Datei beispielsweise im Dokumentenverzeichnis der Anwendung befindet, verwenden Sie das offizielle path_provider-Paket, um einen Dateipfad zu generieren und an putFile() zu übergeben:

Directory appDocDir = await getApplicationDocumentsDirectory();
String filePath = '${appDocDir.absolute}/file-to-upload.png';
File file = File(filePath);

try {
  await mountainsRef.putFile(file);
} on firebase_core.FirebaseException catch (e) {
  // ...
}

Aus einem String hochladen

Sie können Daten mit der Methode putString() als Rohdaten oder als base64-, base64url- oder data_url-codierten String hochladen. So laden Sie beispielsweise einen als Daten-URL codierten Textstring hoch:

String dataUrl = 'data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==';

try {
  await mountainsRef.putString(dataUrl, format: PutStringFormat.dataUrl);
} on FirebaseException catch (e) {
  // ...
}

Rohdaten hochladen

Sie können typisierte Daten auf niedrigerer Ebene in Form eines Uint8List hochladen, wenn das Hochladen eines Strings oder File nicht praktikabel ist. Rufen Sie in diesem Fall die Methode putData() mit Ihren Daten auf:

try {
  // Upload raw data.
  await mountainsRef.putData(data);
} on firebase_core.FirebaseException catch (e) {
  // ...
}

Download-URL abrufen

Nachdem Sie eine Datei hochgeladen haben, können Sie eine URL zum Herunterladen der Datei abrufen. Rufen Sie dazu die Methode getDownloadUrl() für Reference auf:

await mountainsRef.getDownloadURL();

Dateimetadaten hinzufügen

Sie können beim Hochladen von Dateien auch Metadaten angeben. Diese Metadaten enthalten typische Dateimetadatenattribute wie contentType (allgemein als MIME-Typ bezeichnet). Die Methode putFile() leitet den MIME-Typ automatisch aus der Erweiterung File ab. Sie können den automatisch erkannten Typ jedoch überschreiben, indem Sie contentType in den Metadaten angeben. Wenn Sie keinen contentType angeben und Cloud Storage keinen Standardwert aus der Dateiendung ableiten kann, verwendet Cloud Storage application/octet-stream. Weitere Informationen finden Sie unter Dateimetadaten verwenden.

try {
  await mountainsRef.putFile(file, SettableMetadata(
    contentType: "image/jpeg",
  ));
} on firebase_core.FirebaseException catch (e) {
  // ...
}

Uploads verwalten

Zusätzlich zum Starten von Uploads können Sie Uploads mit den Methoden pause(), resume() und cancel() pausieren, fortsetzen und abbrechen. Pausierungs- und Fortsetzungsereignisse lösen die Statusänderungen pause bzw. progress aus. Wenn Sie einen Upload abbrechen, schlägt er mit einem Fehler fehl, der darauf hinweist, dass der Upload abgebrochen wurde.

final task = mountainsRef.putFile(largeFile);

// Pause the upload.
bool paused = await task.pause();
print('paused, $paused');

// Resume the upload.
bool resumed = await task.resume();
print('resumed, $resumed');

// Cancel the upload.
bool canceled = await task.cancel();
print('canceled, $canceled');

Uploadfortschritt im Blick behalten

Sie können den Ereignisstream einer Aufgabe überwachen, um Erfolg, Fehler, Fortschritt oder Pausen in Ihrer Uploadaufgabe zu verarbeiten:

Ereignistyp Typische Verwendung
TaskState.running Wird regelmäßig ausgegeben, während Daten übertragen werden, und kann verwendet werden, um eine Upload-/Download-Anzeige zu füllen.
TaskState.paused Wird ausgegeben, wenn die Aufgabe pausiert wird.
TaskState.success Wird ausgegeben, wenn die Aufgabe erfolgreich abgeschlossen wurde.
TaskState.canceled Wird ausgegeben, wenn die Aufgabe abgebrochen wird.
TaskState.error Wird ausgegeben, wenn der Upload fehlgeschlagen ist. Dies kann aufgrund von Netzwerk-Timeouts, Autorisierungsfehlern oder wenn Sie die Aufgabe abbrechen, passieren. 
mountainsRef.putFile(file).snapshotEvents.listen((taskSnapshot) {
  switch (taskSnapshot.state) {
    case TaskState.running:
      // ...
      break;
    case TaskState.paused:
      // ...
      break;
    case TaskState.success:
      // ...
      break;
    case TaskState.canceled:
      // ...
      break;
    case TaskState.error:
      // ...
      break;
  }
});

Fehlerbehandlung

Es gibt eine Reihe von Gründen, warum beim Hochladen Fehler auftreten können, z. B. weil die lokale Datei nicht vorhanden ist oder der Nutzer keine Berechtigung zum Hochladen der gewünschten Datei hat. Weitere Informationen zu Fehlern finden Sie im Abschnitt Fehler beheben der Dokumentation.

Vollständiges Beispiel

Im Folgenden finden Sie ein vollständiges Beispiel für einen Upload mit Fortschrittsüberwachung und Fehlerbehandlung:

final appDocDir = await getApplicationDocumentsDirectory();
final filePath = "${appDocDir.absolute}/path/to/mountains.jpg";
final file = File(filePath);

// Create the file metadata
final metadata = SettableMetadata(contentType: "image/jpeg");

// Create a reference to the Firebase Storage bucket
final storageRef = FirebaseStorage.instance.ref();

// Upload file and metadata to the path 'images/mountains.jpg'
final uploadTask = storageRef
    .child("images/path/to/mountains.jpg")
    .putFile(file, metadata);

// Listen for state changes, errors, and completion of the upload.
uploadTask.snapshotEvents.listen((TaskSnapshot taskSnapshot) {
  switch (taskSnapshot.state) {
    case TaskState.running:
      final progress =
          100.0 * (taskSnapshot.bytesTransferred / taskSnapshot.totalBytes);
      print("Upload is $progress% complete.");
      break;
    case TaskState.paused:
      print("Upload is paused.");
      break;
    case TaskState.canceled:
      print("Upload was canceled");
      break;
    case TaskState.error:
      // Handle unsuccessful uploads
      break;
    case TaskState.success:
      // Handle successful uploads on complete
      // ...
      break;
  }
});

Nachdem Sie Dateien hochgeladen haben, erfahren Sie jetzt, wie Sie sie aus Cloud Storage herunterladen.