Listar arquivos com o Cloud Storage em plataformas da Apple

Com o Cloud Storage para Firebase, é possível listar o conteúdo do bucket do Cloud Storage. Os SDKs retornam os itens e os prefixos dos objetos de acordo com a referência atual do Cloud Storage.

Os projetos que usam a API List exigem a versão 2 das regras do Cloud Storage para Firebase. Se você tiver um projeto do Firebase, siga as etapas do guia de regras de segurança.

list() usa a API List do Google Cloud Storage. No Cloud Storage para Firebase, usamos / como delimitador para emular a semântica de sistemas de arquivos. Para permitir uma transferência eficiente de grandes buckets hierárquicos do Cloud Storage, a API List retorna prefixos e itens separadamente. Por exemplo, se você fizer o upload de um arquivo /images/uid/file1:

  • root.child('images').listAll() retornará /images/uid como um prefixo;
  • root.child('images/uid').listAll() retornará o arquivo como um item.

O SDK do Cloud Storage para Firebase não retorna caminhos de objetos que contêm duas / consecutivas ou terminam com /.. Por exemplo, considere um bucket que tenha os seguintes objetos:

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

As operações de lista nos itens desse bucket fornecerão os seguintes resultados:

  • A operação de lista na raiz retorna as referências a correctPrefix, wrongPrefix e lonelyItem como prefixes.
  • A operação de lista em correctPrefix/ retorna as referências a correctPrefix/happyItem como items.
  • A operação de lista em wrongPrefix/ não retorna referências porque wrongPrefix//sadItem contém duas /s consecutivas.
  • A operação de lista em lonelyItem/ não retorna referências porque o objeto lonelyItem/ termina com /.

Listar todos os arquivos

É possível usar listAll(completion:) para buscar todos os resultados de um diretório. Isso é mais indicado para diretórios pequenos porque todos os resultados são armazenados em buffer na memória. A operação também pode não retornar um snapshot consistente se os objetos forem adicionados ou removidos durante o processo.

Para uma lista maior, use o método list(withMaxResults:completion:) paginado porque listAll(completion:) armazena em buffer todos os resultados na memória.

O exemplo a seguir demonstra o 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

Paginar os resultados da lista

A API list(withMaxResults:completion:) estabelece um limite ao número de resultados retornados por ela. list(withMaxResults:completion) fornece uma visualização de página consistente e exibe um pageToken que permite controlar quando buscar resultados adicionais.

O pageToken codifica o caminho e a versão do último item retornado no resultado anterior. Em uma solicitação seguinte que usa o pageToken, os itens depois dele são exibidos.

Veja no exemplo a seguir como paginar um resultado:

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

Solucionar erros

Os métodos na API List falharão se você não tiver atualizado suas regras de segurança para a segunda versão. Atualize suas regras de segurança caso veja o seguinte erro:

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

Outros erros possíveis podem indicar que o usuário não tem a permissão correta. Veja mais informações sobre erros nesta página