Dateien mit Cloud Storage in Flutter auflisten

Mit Cloud Storage for Firebase können Sie den Inhalt Ihres Cloud Storage-Buckets auflisten. Die SDKs geben sowohl die Elemente als auch die Präfixe von Objekten unter der aktuellen Cloud Storage-Referenz zurück.

Für Projekte, die die List API verwenden, ist Cloud Storage for Firebase-Regeln Version 2 erforderlich. Wenn Sie bereits ein Firebase-Projekt haben, folgen Sie der Anleitung in dem Leitfaden zu Sicherheitsregeln.

list() verwendet die Google Cloud Storage List API. In Cloud Storage for Firebase verwenden wir / als Trennzeichen, um die Semantik des Dateisystems zu emulieren. Um ein effizientes Durchlaufen großer, hierarchischer Cloud Storage-Buckets zu ermöglichen, gibt die List API Präfixe und Elemente separat zurück. Wenn Sie beispielsweise eine Datei /images/uid/file1 hochladen,

  • root.child('images').listAll() gibt /images/uid als Präfix zurück.
  • root.child('images/uid').listAll() gibt die Datei als Element zurück.

Das Cloud Storage for Firebase SDK gibt keine Objektpfade zurück, die zwei aufeinanderfolgende / enthalten oder mit einem / enden. Betrachten Sie beispielsweise einen Bucket mit den folgenden Objekten:

  • correctPrefix/happyItem
  • wrongPrefix//sadItem
  • lonelyItem/

Die Listenoperationen für Elemente in diesem Bucket führen zu den folgenden Ergebnissen:

  • Die Listenoperation im Stammverzeichnis gibt die Verweise auf correctPrefix, wrongPrefix und lonelyItem als prefixes zurück.
  • Die Listenoperation unter correctPrefix/ gibt die Verweise auf correctPrefix/happyItem als items zurück.
  • Die Listenoperation unter wrongPrefix/ gibt keine Verweise zurück da wrongPrefix//sadItem zwei aufeinanderfolgende / enthält.
  • Die Listenoperation unter lonelyItem/ gibt keine Verweise zurück , da das Objekt lonelyItem/ mit / endet.

Alle Dateien auflisten

Mit listAll können Sie alle Ergebnisse für ein Verzeichnis abrufen. Diese Methode eignet sich am besten für kleine Verzeichnisse, da alle Ergebnisse im Arbeitsspeicher gepuffert werden. Außerdem wird bei dieser Operation möglicherweise kein konsistenter Snapshot zurückgegeben, wenn während des Vorgangs Objekte hinzugefügt oder entfernt werden.

Verwenden Sie für eine lange Liste die paginierte Methode list(), da listAll() alle Ergebnisse im Arbeitsspeicher puffert.

Das folgende Beispiel zeigt listAll:

final storageRef = FirebaseStorage.instance.ref().child("files/uid");
final listResult = await storageRef.listAll();
for (var prefix in listResult.prefixes) {
  // The prefixes under storageRef.
  // You can call listAll() recursively on them.
}
for (var item in listResult.items) {
  // The items under storageRef.
}

Listenergebnisse paginieren

Die list() API begrenzt die Anzahl der zurückgegebenen Ergebnisse. list() bietet einen konsistenten Seitenaufruf und stellt ein pageToken zur Verfügung, mit dem Sie steuern können, wann zusätzliche Ergebnisse abgerufen werden sollen.

Das pageToken codiert den Pfad und die Version des letzten Elements, das im vorherigen Ergebnis zurückgegeben wurde. Bei einer nachfolgenden Anfrage mit dem pageToken werden Elemente angezeigt, die nach dem pageToken stehen.

Das folgende Beispiel zeigt, wie ein Ergebnis paginiert wird:

Stream<ListResult> listAllPaginated(Reference storageRef) async* {
  String? pageToken;
  do {
    final listResult = await storageRef.list(ListOptions(
      maxResults: 100,
      pageToken: pageToken,
    ));
    yield listResult;
    pageToken = listResult.nextPageToken;
  } while (pageToken != null);
}

Fehler verarbeiten

list() und listAll() schlagen fehl, wenn Sie die Sicherheitsregeln nicht auf Version 2 aktualisiert haben. Aktualisieren Sie Ihre Sicherheitsregeln, wenn dieser Fehler angezeigt wird:

Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.

Andere mögliche Fehler können darauf hindeuten, dass der Nutzer nicht die richtige Berechtigung hat. Weitere Informationen zu Fehlern finden Sie auf der Seite Fehler verarbeiten.