Wyświetlanie listy plików w Cloud Storage na platformach Apple

Cloud Storage for Firebase umożliwia wyświetlanie zawartości zasobnika Cloud Storage. Pakiety SDK zwracają zarówno elementy, jak i prefiksy obiektów w bieżącym Cloud Storage odwołaniu.

Projekty, które korzystają z interfejsu List API, wymagają Cloud Storage for Firebase reguł w wersji 2. Jeśli masz już projekt Firebase, wykonaj czynności opisane w przewodniku po regułach bezpieczeństwa.

list() korzysta z Google Cloud Storage interfejsu List API. W Cloud Storage for Firebase używamy znaku / jako separatora, co pozwala nam emulować semantykę systemu plików. Aby umożliwić wydajne przechodzenie przez duże, hierarchiczne Cloud Storage zasobniki, interfejs List API zwraca prefiksy i elementy oddzielnie. Jeśli na przykład prześlesz plik /images/uid/file1:

  • root.child('images').listAll() zwróci /images/uid jako prefiks.
  • root.child('images/uid').listAll() zwróci plik jako element.

Pakiet SDK Cloud Storage for Firebase nie zwraca ścieżek obiektów, które zawierają 2 kolejne znaki / lub kończą się znakiem /.. Rozważmy na przykład zasobnik, który zawiera te obiekty:

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

Operacje na elementach w tym zasobniku dadzą te wyniki:

  • Operacja listowania w katalogu głównym zwraca odwołania do correctPrefix, wrongPrefix i lonelyItem jako prefixes.
  • Operacja listowania w correctPrefix/ zwraca odwołania do correctPrefix/happyItem jako items.
  • Operacja listowania w wrongPrefix/ nie zwraca żadnych odwołań ponieważ wrongPrefix//sadItem zawiera 2 kolejne znaki /.
  • Operacja listowania w lonelyItem/ nie zwraca żadnych odwołań ponieważ obiekt lonelyItem/ kończy się znakiem /.

Wyświetlanie listy wszystkich plików

Aby pobrać wszystkie wyniki dla katalogu, możesz użyć listAll(completion:). Najlepiej używać tej metody w przypadku małych katalogów, ponieważ wszystkie wyniki są buforowane w pamięci. Jeśli obiekty są dodawane lub usuwane podczas procesu, operacja może też nie zwrócić spójnego stanu.

W przypadku długiej listy użyj metody list(withMaxResults:completion:) z podziałem na strony, ponieważ listAll(completion:) buforuje wszystkie wyniki w pamięci.

Ten przykład pokazuje, jak używać listAll(completion:).

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 {
  // ...
}

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.
  }
}];

Dzielenie wyników listy na strony

Interfejs list(withMaxResults:completion:) API ogranicza liczbę zwracanych wyników. list(withMaxResults:completion) zapewnia spójny widok strony i udostępnia token strony, który umożliwia kontrolowanie, kiedy pobierać dodatkowe wyniki.

Token strony koduje ścieżkę i wersję ostatniego elementu zwróconego w poprzednim wyniku. W kolejnym żądaniu z użyciem tokena strony wyświetlane są elementy, które znajdują się po tokenie strony.

Ten przykład pokazuje, jak podzielić wynik na strony:

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)
  }
}

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];
  }
}

Obsługuj błędy

Metody w interfejsie List API nie będą działać, jeśli nie zaktualizujesz reguł bezpieczeństwa do wersji 2. Jeśli widzisz ten błąd, zaktualizuj reguły bezpieczeństwa:

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

Inne możliwe błędy mogą wskazywać, że użytkownik nie ma odpowiednich uprawnień. Więcej informacji o błędach znajdziesz w sekcji Obsługa błędów.