Listar arquivos com Cloud Storage no Flutter

O Cloud Storage para Firebase permite listar o conteúdo do seu intervalo do Cloud Storage. Os SDKs retornam os itens e os prefixos dos objetos na referência atual do Cloud Storage.

Os projetos que usam a API List exigem o Cloud Storage for Firebase Rules versão 2. Se você já tiver um projeto do Firebase, siga as etapas no Guia de regras de segurança .

list() usa a API de lista do Google Cloud Storage . No Cloud Storage para Firebase, usamos / como delimitador, o que nos permite emular a semântica do sistema de arquivos. Para permitir a passagem eficiente de intervalos grandes e hierárquicos do Cloud Storage, a API List retorna prefixos e itens separadamente. Por exemplo, se você fizer 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 contenham dois / s consecutivos ou terminem com / . Por exemplo, considere um bucket que tenha os seguintes objetos:

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

As operações de lista em itens neste intervalo 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 para correctPrefix/happyItem como items .
  • A operação de lista em wrongPrefix/ não retorna nenhuma referência porque wrongPrefix//sadItem contém dois / s consecutivos.
  • A operação de lista em lonelyItem/ não retorna nenhuma referência porque o objeto lonelyItem/ termina com / .

Listar todos os arquivos

Você pode usar listAll para buscar todos os resultados de um diretório. Isso é melhor usado para diretórios pequenos, pois todos os resultados são armazenados em buffer na memória. A operação também poderá não retornar um instantâneo consistente se objetos forem adicionados ou removidos durante o processo.

Para uma lista grande, use o método list() paginado, pois listAll() armazena todos os resultados 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.
}

Paginar resultados da lista

A API list() impõe um limite ao número de resultados que ela retorna. list() fornece uma visualização de página consistente e expõe 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 subsequente usando o pageToken, os itens que vêm depois do pageToken são mostrados.

O exemplo a seguir demonstra a paginação de 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);
}

Lidar com erros

list() e listAll() falharão se você não tiver atualizado as regras de segurança para a versão 2. Atualize suas regras de segurança se você vir este 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 possíveis erros podem indicar que o usuário não tem a permissão correta. Mais informações sobre erros podem ser encontradas na página Tratar erros .