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, in denen die List API verwendet wird, ist Cloud Storage for Firebase Rules Version 2 erforderlich. Wenn Sie bereits ein Firebase-Projekt haben, folgen Sie der Anleitung im Leitfaden zu Sicherheitsregeln.

list() verwendet die Google Cloud Storage List API In Cloud Storage for Firebase verwenden wir / als Trennzeichen. Semantik des Dateisystems emulieren. Für einen effizienten Durchlauf großer, hierarchischen Cloud Storage-Buckets, gibt die List API Präfixe und Elemente separat zu verwalten. Wenn Sie beispielsweise eine Datei /images/uid/file1 hochladen,

  • Für root.child('images').listAll() wird /images/uid als Präfix zurückgegeben.
  • 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 /s oder enden mit einem /. Angenommen, Sie haben einen Bucket mit den folgenden Objekten:

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

Die Listenvorgänge für Elemente in diesem Bucket führen zu den folgenden Ergebnissen:

  • Der list-Vorgang im Stammverzeichnis gibt die Verweise auf correctPrefix zurück. wrongPrefix und lonelyItem als prefixes.
  • Der Listenvorgang im correctPrefix/ gibt die Verweise auf correctPrefix/happyItem als items.
  • Der Listenvorgang für die wrongPrefix/ gibt keine Verweise zurück weil wrongPrefix//sadItem zwei aufeinanderfolgende /s enthält.
  • Der Listenvorgang für die 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 Option eignet sich am besten für kleine Verzeichnisse, da alle Ergebnisse im Arbeitsspeicher zwischengespeichert werden. Der Vorgang gibt möglicherweise auch keinen konsistenten Snapshot zurück, wenn Objekte hinzugefügt oder während des Prozesses entfernt werden.

Verwenden Sie für eine große Liste die paginated-Methode list(), da listAll() alle Ergebnisse im Arbeitsspeicher puffert.

Im folgenden Beispiel wird listAll veranschaulicht.

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 einheitlichen Seitenaufruf und gibt ein pageToken aus, mit dem gesteuert werden kann, wann zusätzliche Ergebnisse abgerufen werden.

Das pageToken codiert den Pfad und die Version des letzten Elements, das im vorheriges Ergebnis. In einer nachfolgenden Anfrage mit dem pageToken werden die nachdem „pageToken“ angezeigt wird.

Im folgenden Beispiel wird die Paginierung eines Ergebnisses veranschaulicht:

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 kein Upgrade ausführen die Sicherheitsregeln auf Version 2. Aktualisieren Sie Ihre Sicherheitsregeln, wenn Sie diese Fehlermeldung sehen:

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 hinweisen, dass der Nutzer nicht über die erforderliche Berechtigung verfügt. Weitere Informationen zu Fehlern finden Sie auf der Seite Fehler beheben.