Listar arquivos com o Cloud Storage no Flutter

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 dois /s consecutivos 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 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 poderá não retornar um snapshot consistente se objetos forem adicionados ou removidos durante o processo.

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

O exemplo a seguir demonstra listAll.

final storageRef = FirebaseStorage.instance.ref().child("files/uid");
final listResult = await storageRef.listAll();
for (var prefix in listResult.prefixes) {
  // The prefixes under storageRef.
  // You can call listAll() recursively on them.
}
for (var item in listResult.items) {
  // The items under storageRef.
}

Resultados de lista de paginação

A API list() estabelece um limite ao número de resultados retornados por ela. list() 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:

Stream<ListResult> listAllPaginated(Reference storageRef) async* {
  String? pageToken;
  do {
    final listResult = await storageRef.list(ListOptions(
      maxResults: 100,
      pageToken: pageToken,
    ));
    yield listResult;
    pageToken = listResult.nextPageToken;
  } while (pageToken != null);
}

Solucionar erros

list() e listAll() falharão se você não tiver atualizado as 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 na página Solucionar erros.