Listar arquivos com o Cloud Storage na Web

OCloud Storage for Firebase permite listar o conteúdo do bucket do Cloud Storage. Os SDKs retornam os itens e os prefixos dos objetos conforme a referência atual do Cloud Storage.

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

O list() usa o API List do Google Cloud Storage. No Cloud Storage for Firebase, usamos / como delimitador, o que permite emular a semântica do sistema 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 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 for Firebase não retorna caminhos de objetos que contêm dois /s consecutivos ou terminam com um /.. 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 o listAll.

Web

import { getStorage, ref, listAll } from "firebase/storage";

const storage = getStorage();

// Create a reference under which you want to list
const listRef = ref(storage, 'files/uid');

// Find all the prefixes and items.
listAll(listRef)
  .then((res) => {
    res.prefixes.forEach((folderRef) => {
      // All the prefixes under listRef.
      // You may call listAll() recursively on them.
    });
    res.items.forEach((itemRef) => {
      // All the items under listRef.
    });
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_list_all.js

Web

// Create a reference under which you want to list
var listRef = storageRef.child('files/uid');

// Find all the prefixes and items.
listRef.listAll()
  .then((res) => {
    res.prefixes.forEach((folderRef) => {
      // All the prefixes under listRef.
      // You may call listAll() recursively on them.
    });
    res.items.forEach((itemRef) => {
      // All the items under listRef.
    });
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
list-files.js

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. Na próxima solicitação que usar o pageToken, vão aparecer os itens depois dele.

Veja no exemplo a seguir como dividir um resultado em páginas usando async/await.

Web

import { getStorage, ref, list } from "firebase/storage";

async function pageTokenExample(){
  // Create a reference under which you want to list
  const storage = getStorage();
  const listRef = ref(storage, 'files/uid');

  // Fetch the first page of 100.
  const firstPage = await list(listRef, { maxResults: 100 });

  // Use the result.
  // processItems(firstPage.items)
  // processPrefixes(firstPage.prefixes)

  // Fetch the second page if there are more elements.
  if (firstPage.nextPageToken) {
    const secondPage = await list(listRef, {
      maxResults: 100,
      pageToken: firstPage.nextPageToken,
    });
    // processItems(secondPage.items)
    // processPrefixes(secondPage.prefixes)
  }
}
storage_list_paginate.js

Web

async function pageTokenExample(){
  // Create a reference under which you want to list
  var listRef = storageRef.child('files/uid');

  // Fetch the first page of 100.
  var firstPage = await listRef.list({ maxResults: 100});

  // Use the result.
  // processItems(firstPage.items)
  // processPrefixes(firstPage.prefixes)

  // Fetch the second page if there are more elements.
  if (firstPage.nextPageToken) {
    var secondPage = await listRef.list({
      maxResults: 100,
      pageToken: firstPage.nextPageToken,
    });
    // processItems(secondPage.items)
    // processPrefixes(secondPage.prefixes)
  }
}
list-files.js

Tratar erros

list() e listAll() retornam uma promessa rejeitada se você não atualizou as regras de segurança da versão 2. 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. Acesse Solucionar erros para saber mais.