Dateien mit Cloud Storage auf Apple-Plattformen 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 der Objekte unter der aktuellen Cloud Storage-Referenz zurück.

Für Projekte, die die Listen API verwenden, ist Cloud Storage for Firebase-Regeln Version 2 erforderlich. Wenn Sie bereits ein Firebase-Projekt haben, folgen Sie den Schritten in der Anleitung 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. Damit große, hierarchische Cloud Storage-Buckets effizient durchlaufen werden können, gibt die List API Präfixe und Elemente separat zurück. 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 enthalten oder mit einer /. enden. 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 Listenvorgang am Stamm gibt die Verweise auf correctPrefix, wrongPrefix und lonelyItem als prefixes zurück.
  • Der Listenvorgang bei correctPrefix/ gibt die Verweise auf correctPrefix/happyItem als items zurück.
  • Der Listenvorgang bei wrongPrefix/ gibt keine Verweise zurück, da wrongPrefix//sadItem zwei aufeinanderfolgende /s enthält.
  • Der Listenvorgang für das lonelyItem/ gibt keine Verweise zurück, da das Objekt lonelyItem/ mit / endet.

Alle Dateien auflisten

Mit listAll(completion:) 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. Außerdem wird möglicherweise kein konsistenter Snapshot zurückgegeben, wenn während des Vorgangs Objekte hinzugefügt oder entfernt werden.

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

Im folgenden Beispiel wird listAll(completion:) veranschaulicht.

Swift

let storageReference = storage.reference().child("files/uid")
do {
  let result = try await storageReference.listAll()
  for prefix in result.prefixes {
    // The prefixes under storageReference.
    // You may call listAll(completion:) recursively on them.
  }
  for item in result.items {
    // The items under storageReference.
  }
} catch {
  // ...
}
ViewController.swift

Objective-C

FIRStorageReference *storageReference = [storage reference];
[storageReference listAllWithCompletion:^(FIRStorageListResult *result, NSError *error) {
  if (error != nil) {
    // ...
  }

  for (FIRStorageReference *prefix in result.prefixes) {
    // All the prefixes under storageReference.
    // You may call listAllWithCompletion: recursively on them.
  }
  for (FIRStorageReference *item in result.items) {
    // All items under storageReference.
  }
}];
ViewController.m

Listenergebnisse paginieren

Die list(withMaxResults:completion:) API begrenzt die Anzahl der zurückgegebenen Ergebnisse. list(withMaxResults:completion) sorgt für einen konsistenten Seitenaufruf und stellt ein pageToken bereit, mit dem Sie steuern können, wann zusätzliche Ergebnisse abgerufen werden.

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

Im folgenden Beispiel wird die Paginierung eines Ergebnisses veranschaulicht:

Swift

func listAllPaginated(pageToken: String? = nil) async throws {
  let storage = Storage.storage()
  let storageReference = storage.reference().child("files/uid")

  let listResult: StorageListResult
  if let pageToken = pageToken {
    listResult = try await storageReference.list(maxResults: 100, pageToken: pageToken)
  } else {
    listResult = try await storageReference.list(maxResults: 100)
  }
  let prefixes = listResult.prefixes
  let items = listResult.items
  // Handle list result
  // ...

  // Process next page
  if let token = listResult.pageToken {
    try await listAllPaginated(pageToken: token)
  }
}
ViewController.swift

Objective-C

- (void)paginateFilesAtReference:(FIRStorageReference *)reference
                       pageToken:(nullable NSString *)pageToken {
  void (^pageHandler)(FIRStorageListResult *_Nonnull, NSError *_Nullable) =
      ^(FIRStorageListResult *result, NSError *error) {
        if (error != nil) {
          // ...
        }
        NSArray *prefixes = result.prefixes;
        NSArray *items = result.items;

        // ...

        // Process next page
        if (result.pageToken != nil) {
          [self paginateFilesAtReference:reference pageToken:result.pageToken];
        }
  };

  if (pageToken != nil) {
    [reference listWithMaxResults:100 pageToken:pageToken completion:pageHandler];
  } else {
    [reference listWithMaxResults:100 completion:pageHandler];
  }
}
ViewController.m

Fehler verarbeiten

Methoden in der List API schlagen fehl, wenn Sie Ihre 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 Nutzer nicht die richtigen Berechtigungen hat. Weitere Informationen zu Fehlern finden Sie unter Fehler verarbeiten.