Wyświetlaj pliki w Cloud Storage na platformach Apple

Cloud Storage dla Firebase umożliwia wyświetlenie zawartości zasobnika Cloud Storage. Pakiety SDK zwracają zarówno elementy, jak i przedrostki obiektów w ramach bieżącego odniesienia do Cloud Storage.

Projekty korzystające z interfejsu API list wymagają Cloud Storage for Firebase Rules w wersji 2. Jeśli masz istniejący projekt Firebase, wykonaj kroki opisane w Przewodniku po regułach bezpieczeństwa .

list() korzysta z interfejsu API listy Google Cloud Storage . W Cloud Storage dla Firebase używamy / jako separatora, co pozwala nam emulować semantykę systemu plików. Aby umożliwić efektywne przeglądanie dużych, hierarchicznych segmentów Cloud Storage, interfejs API listy zwraca oddzielnie prefiksy i elementy. Na przykład, jeśli prześlesz jeden plik /images/uid/file1 ,

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

Pakiet Cloud Storage for Firebase SDK nie zwraca ścieżek obiektów zawierających dwa kolejne znaki / lub kończących się znakiem /. . Rozważmy na przykład wiadro zawierające następujące obiekty:

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

Operacje listowe na elementach w tym segmencie dadzą następujące wyniki:

  • Operacja list w katalogu głównym zwraca odniesienia do correctPrefix , wrongPrefix i lonelyItem w postaci prefixes .
  • Operacja listowa na correctPrefix/ zwraca odniesienia do correctPrefix/happyItem jako items .
  • Operacja listowa pod wrongPrefix/ nie zwraca żadnych odniesień, ponieważ wrongPrefix//sadItem zawiera dwa kolejne / s.
  • Operacja listowa na lonelyItem/ nie zwraca żadnych referencji, ponieważ obiekt lonelyItem/ kończy się na / .

Lista wszystkich plików

Możesz użyć listAll(completion:) aby pobrać wszystkie wyniki dla katalogu. Najlepiej jest to stosować w przypadku małych katalogów, ponieważ wszystkie wyniki są buforowane w pamięci. Operacja może również nie zwrócić spójnej migawki, jeśli w trakcie procesu zostaną dodane lub usunięte obiekty.

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

Poniższy przykład ilustruje listAll(completion:) .

Szybki

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

Cel 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

Wyniki listy stronicowania

list(withMaxResults:completion:) nakłada ograniczenie na liczbę zwracanych wyników. list(withMaxResults:completion) zapewnia spójną odsłonę strony i udostępnia pageToken, który pozwala kontrolować, kiedy pobrać dodatkowe wyniki.

PageToken koduje ścieżkę i wersję ostatniego elementu zwróconego w poprzednim wyniku. W kolejnym żądaniu wykorzystującym pageToken wyświetlane są elementy następujące po pageToken.

Poniższy przykład ilustruje paginację wyniku:

Szybki

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

Cel 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

Obsługuj błędy

Metody w interfejsie API listy nie powiodą się, jeśli nie zaktualizowałeś reguł bezpieczeństwa do wersji 2. Zaktualizuj swoje reguły bezpieczeństwa, jeśli zobaczysz ten błąd:

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 na temat błędów można znaleźć w rozdziale Obsługa błędów .