Mit Cloud Storage für 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.
Projekte, die die List API verwenden, erfordern Cloud Storage für Firebase Rules Version 2. Wenn Sie über ein bestehendes Firebase-Projekt verfügen, befolgen Sie die Schritte im Security Rules Guide .
list() verwendet die Google Cloud Storage List API . In Cloud Storage für Firebase verwenden wir / als Trennzeichen, wodurch wir die Dateisystemsemantik emulieren können. Um eine effiziente Durchquerung 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/uidals 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 / s 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,wrongPrefixundlonelyItemalsprefixeszurück. - Die Listenoperation bei „
correctPrefix/gibt die Verweise aufcorrectPrefix/happyItemalsitemszurück. - Die Listenoperation bei
wrongPrefix/gibt keine Referenzen zurück, dawrongPrefix//sadItemzwei aufeinanderfolgende/s enthält. - Die Listenoperation am
lonelyItem/gibt keine Referenzen zurück, da das ObjektlonelyItem/mit/endet.
Listen Sie alle Dateien auf
Mit listAll können Sie alle Ergebnisse für ein Verzeichnis abrufen. Dies eignet sich am besten für kleine Verzeichnisse, da alle Ergebnisse im Speicher zwischengespeichert werden. Der Vorgang gibt möglicherweise auch keinen konsistenten Snapshot zurück, wenn während des Prozesses Objekte hinzugefügt oder entfernt werden.
Verwenden Sie für eine große Liste die paginierte list() Methode, da listAll() alle Ergebnisse im Speicher puffert.
Das folgende Beispiel demonstriert 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() sorgt für einen konsistenten Seitenaufruf und stellt ein pageToken bereit, das die Kontrolle darüber ermöglicht, wann zusätzliche Ergebnisse abgerufen werden.
Das pageToken kodiert den Pfad und die Version des letzten im vorherigen Ergebnis zurückgegebenen Elements. In einer nachfolgenden Anfrage mit dem pageToken werden Elemente angezeigt, die nach dem pageToken folgen.
Das folgende Beispiel veranschaulicht die Paginierung eines Ergebnisses:
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);
}
Behandeln Sie Fehler
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 hinweisen, dass der Benutzer nicht über die richtige Berechtigung verfügt. Weitere Informationen zu Fehlern finden Sie auf der Seite Fehler behandeln .