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

Cloud Storage dla Firebase umożliwia wyświetlanie zawartości Zasobnik Cloud Storage. Pakiety SDK zwracają zarówno elementy, jak i prefiksy obiektów w bieżącym odniesieniu do Cloud Storage.

Projekty korzystające z interfejsu List API wymagają Cloud Storage dla Firebase Reguły w wersji 2. Jeśli masz już projekt Firebase, wykonaj czynności opisane w sekcji Przewodnik po regułach zabezpieczeń.

Funkcja list() używa funkcji Interfejs Google Cloud Storage List API. W Cloud Storage dla Firebase używamy / jako separatora, który pozwala nam emulować semantykę systemu plików. Aby umożliwić sprawne przemierzanie dużych, hierarchicznych zasobników Cloud Storage, interfejs List API zwraca prefiksy i elementy oddzielnie. Jeśli na przykład prześlesz 1 plik /images/uid/file1,

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

Pakiet SDK Cloud Storage dla Firebase nie zwraca ścieżek obiektów zawierających dwa następujących po sobie znaków / lub kończy się znakiem /.. Weźmy na przykład zasobnik z następujące obiekty:

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

Operacje wyświetlania listy elementów w tym zasobniku dają następujące wyniki:

  • Operacja na liście na poziomie głównym zwraca odwołania do correctPrefix, wrongPrefix i lonelyItem jako prefixes.
  • Operacja listy na elemencie correctPrefix/ zwraca odwołania do correctPrefix/happyItem jako items.
  • Operacja na liście w wrongPrefix/ nie zwraca żadnych odwołań ponieważ wrongPrefix//sadItem zawiera dwa kolejne elementy /.
  • Operacja na liście w lonelyItem/ nie zwraca żadnych odwołań ponieważ obiekt lonelyItem/ kończy się na /.

Wyświetl wszystkie pliki

Aby pobrać wszystkie wyniki z katalogu, możesz użyć narzędzia listAll(completion:). Najlepiej sprawdza się to w przypadku małych katalogów, ponieważ wszystkie wyniki są buforowane w pamięci. Operacja może też nie zwrócić spójnego zrzutu, jeśli obiekty zostały dodane lub usunięte w trakcie tego procesu.

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

Poniższy przykład pokazuje 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 {
  // ...
}
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

Wyniki dotyczące listy stron

Interfejs API list(withMaxResults:completion:) nakłada limit na liczbę w wynikach wyszukiwania. list(withMaxResults:completion) zapewnia spójność odsłonę i ujawnia element pageToken, który umożliwia kontrolę nad czasem pobierania. dodatkowe wyniki.

pageToken koduje ścieżkę i wersję ostatniego elementu zwróconego w metodzie poprzedniego wyniku. W kolejnym żądaniu używającym parametru pageToken, elementy pojawiające się po wyświetleniu tokena pageToken.

Ten przykład ilustruje dzielenie wyniku 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)
  }
}
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

Obsługa błędów

Metody z interfejsu API list zawodzą, jeśli nie uaktualnisz reguł zabezpieczeń do wersji 2. Jeśli widzisz ten błąd, uaktualnij reguły zabezpieczeń:

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 Obsługa błędów.