Listar arquivos com o Cloud Storage no Android

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.

Kotlin+KTX

val storage = Firebase.storage
val listRef = storage.reference.child("files/uid")

// You'll need to import com.google.firebase.storage.component1 and
// com.google.firebase.storage.component2
listRef.listAll()
    .addOnSuccessListener { (items, prefixes) ->
        for (prefix in prefixes) {
            // All the prefixes under listRef.
            // You may call listAll() recursively on them.
        }

        for (item in items) {
            // All the items under listRef.
        }
    }
    .addOnFailureListener {
        // Uh-oh, an error occurred!
    }
StorageActivity.kt

Java

StorageReference listRef = storage.getReference().child("files/uid");

listRef.listAll()
        .addOnSuccessListener(new OnSuccessListener<ListResult>() {
            @Override
            public void onSuccess(ListResult listResult) {
                for (StorageReference prefix : listResult.getPrefixes()) {
                    // All the prefixes under listRef.
                    // You may call listAll() recursively on them.
                }

                for (StorageReference item : listResult.getItems()) {
                    // All the items under listRef.
                }
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Uh-oh, an error occurred!
            }
        });
StorageActivity.java

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:

Kotlin+KTX

fun listAllPaginated(pageToken: String?) {
    val storage = Firebase.storage
    val listRef = storage.reference.child("files/uid")

    // Fetch the next page of results, using the pageToken if we have one.
    val listPageTask = if (pageToken != null) {
        listRef.list(100, pageToken)
    } else {
        listRef.list(100)
    }

    // You'll need to import com.google.firebase.storage.component1 and
    // com.google.firebase.storage.component2
    listPageTask
        .addOnSuccessListener { (items, prefixes, pageToken) ->
            // Process page of results
            processResults(items, prefixes)

            // Recurse onto next page
            pageToken?.let {
                listAllPaginated(it)
            }
        }.addOnFailureListener {
            // Uh-oh, an error occurred.
        }
}
StorageActivity.kt

Java

public void listAllPaginated(@Nullable String pageToken) {
    FirebaseStorage storage = FirebaseStorage.getInstance();
    StorageReference listRef = storage.getReference().child("files/uid");

    // Fetch the next page of results, using the pageToken if we have one.
    Task<ListResult> listPageTask = pageToken != null
            ? listRef.list(100, pageToken)
            : listRef.list(100);

    listPageTask
            .addOnSuccessListener(new OnSuccessListener<ListResult>() {
                @Override
                public void onSuccess(ListResult listResult) {
                    List<StorageReference> prefixes = listResult.getPrefixes();
                    List<StorageReference> items = listResult.getItems();

                    // Process page of results
                    // ...

                    // Recurse onto next page
                    if (listResult.getPageToken() != null) {
                        listAllPaginated(listResult.getPageToken());
                    }
                }
            }).addOnFailureListener(new OnFailureListener() {
                @Override
                public void onFailure(@NonNull Exception e) {
                    // Uh-oh, an error occurred.
                }
            });
}
StorageActivity.java

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. Acesse Solucionar erros para saber mais.