Share via

Listar blobs com Java

  • Artigo

Este artigo mostra como listar blobs com a biblioteca de cliente do Armazenamento do Azure para Java.

Pré-requisitos

  • Este artigo pressupõe que já tem um projeto configurado para funcionar com a biblioteca de cliente Armazenamento de Blobs do Azure para Java. Para saber mais sobre como configurar o seu projeto, incluindo a instalação de pacotes, a adição import de diretivas e a criação de um objeto de cliente autorizado, veja Introdução ao Armazenamento do Azure e Java.
  • O mecanismo de autorização tem de ter permissões para listar blobs. Para saber mais, veja a documentação de orientação de autorização para a seguinte operação da API REST:

Acerca das opções de listagem de blobs

Quando lista blobs do seu código, pode especificar opções para gerir a forma como os resultados são devolvidos do Armazenamento do Azure. Pode especificar o número de resultados a devolver em cada conjunto de resultados e, em seguida, obter os conjuntos subsequentes. Pode especificar um prefixo para devolver blobs cujos nomes começam com esse caráter ou cadeia. E pode listar blobs numa estrutura de listagem simples ou hierárquica. Uma listagem hierárquica devolve blobs como se estivessem organizados em pastas.

Para listar os blobs numa conta de armazenamento, chame um destes métodos:

Gerir quantos resultados são devolvidos

Por predefinição, uma operação de listagem devolve até 5000 resultados de cada vez, mas pode especificar o número de resultados que pretende que cada operação de listagem devolva. Os exemplos apresentados neste artigo mostram-lhe como devolver resultados em páginas. Para saber mais sobre os conceitos de paginação, veja Pagination with the Azure SDK for Java (Paginação com o SDK do Azure para Java).

Filtrar resultados com um prefixo

Para filtrar a lista de blobs, transmita uma cadeia como o prefix parâmetro para ListBlobsOptions.setPrefix(Prefixo de cadeia). A cadeia de prefixo pode incluir um ou mais carateres. Em seguida, o Armazenamento do Azure devolve apenas os blobs cujos nomes começam com esse prefixo.

Listagem simples versus listagem hierárquica

Os blobs no Armazenamento do Azure estão organizados num paradigma simples, em vez de num paradigma hierárquico (como um sistema de ficheiros clássico). No entanto, pode organizar blobs em diretórios virtuais para imitar uma estrutura de pastas. Um diretório virtual faz parte do nome do blob e é indicado pelo caráter delimitador.

Para organizar blobs em diretórios virtuais, utilize um caráter delimitador no nome do blob. O caráter delimitador predefinido é uma barra (/), mas pode especificar qualquer caráter como delimitador.

Se atribuir um nome aos blobs através de um delimitador, pode optar por listar os blobs hierárquicos. Para uma operação de listagem hierárquica, o Armazenamento do Azure devolve todos os diretórios virtuais e blobs abaixo do objeto principal. Pode chamar a operação de listagem de forma recursiva para percorrer a hierarquia, de forma semelhante à forma como percorreria um sistema de ficheiros clássico através de programação.

Utilizar uma listagem simples

Por predefinição, uma operação de listagem devolve blobs numa listagem simples. Numa listagem simples, os blobs não são organizados por diretório virtual.

O exemplo seguinte lista os blobs no contentor especificado com uma listagem simples:

public void listBlobsFlat(BlobContainerClient blobContainerClient) {
    System.out.println("List blobs flat:");

    blobContainerClient.listBlobs()
            .forEach(blob -> System.out.printf("Name: %s%n", blob.getName()));
}

A saída de exemplo é semelhante a:

List blobs flat:
Name: file4.txt
Name: folderA/file1.txt
Name: folderA/file2.txt
Name: folderA/folderB/file3.txt

Também pode especificar opções para filtrar os resultados da lista ou mostrar informações adicionais. O exemplo seguinte lista blobs com um prefixo especificado e também lista blobs eliminados:

public void listBlobsFlatWithOptions(BlobContainerClient blobContainerClient) {
    ListBlobsOptions options = new ListBlobsOptions()
            .setMaxResultsPerPage(2) // Low number for demonstration purposes
            .setDetails(new BlobListDetails()
                    .setRetrieveDeletedBlobs(true));

    System.out.println("List blobs flat:");

    int i = 0;
    Iterable<PagedResponse<BlobItem>> blobPages = blobContainerClient.listBlobs(options, null).iterableByPage();
    for (PagedResponse<BlobItem> page : blobPages) {
        System.out.printf("Page %d%n", ++i);
        page.getElements().forEach(blob -> {
            System.out.printf("Name: %s, Is deleted? %b%n",
                    blob.getName(),
                    blob.isDeleted());
        });
    }
}

A saída de exemplo é semelhante a:

List blobs flat:
Page 1
Name: file4.txt, Is deleted? false
Name: file5-deleted.txt, Is deleted? true
Page 2
Name: folderA/file1.txt, Is deleted? false
Name: folderA/file2.txt, Is deleted? false
Page 3
Name: folderA/folderB/file3.txt, Is deleted? false

Nota

O resultado de exemplo mostrado pressupõe que tem uma conta de armazenamento com um espaço de nomes simples. Se tiver ativado a funcionalidade de espaço de nomes hierárquico para a sua conta de armazenamento, os diretórios não são virtuais. Em vez disso, são objetos concretos e independentes. Como resultado, os diretórios aparecem na lista como blobs de comprimento zero.

Para obter uma opção de listagem alternativa ao trabalhar com um espaço de nomes hierárquico, consulte Listar conteúdos de diretórios (Azure Data Lake Storage Gen2).

Utilizar uma listagem hierárquica

Quando chama uma operação de listagem hierárquica, o Armazenamento do Azure devolve os diretórios virtuais e os blobs no primeiro nível da hierarquia.

Para listar blobs hierárquicos, utilize o seguinte método:

O exemplo seguinte lista os blobs no contentor especificado através de uma listagem hierárquica:

public void listBlobsHierarchicalListing(BlobContainerClient blobContainerClient, String prefix/* ="" */) {
    String delimiter = "/";
    ListBlobsOptions options = new ListBlobsOptions()
            .setPrefix(prefix);

    blobContainerClient.listBlobsByHierarchy(delimiter, options, null)
            .forEach(blob -> {
                if (blob.isPrefix()) {
                    System.out.printf("Virtual directory prefix: %s%n", delimiter + blob.getName());
                    listBlobsHierarchicalListing(blobContainerClient, blob.getName());
                } else {
                    System.out.printf("Blob name: %s%n", blob.getName());
                }
            });
}

A saída de exemplo é semelhante a:

List blobs hierarchical:
Blob name: file4.txt
Virtual directory prefix: /folderA/
Blob name: folderA/file1.txt
Blob name: folderA/file2.txt
Virtual directory prefix: /folderA/folderB/
Blob name: folderA/folderB/file3.txt

Nota

Não é possível listar instantâneos de blobs numa operação de listagem hierárquica.

Recursos

Para saber mais sobre como listar blobs com o Armazenamento de Blobs do Azure biblioteca de cliente para Java, veja os seguintes recursos.

Operações da API REST

O SDK do Azure para Java contém bibliotecas que se baseiam na API REST do Azure, permitindo-lhe interagir com operações da API REST através de paradigmas de Java familiares. Os métodos da biblioteca de cliente para listar blobs utilizam a seguinte operação da API REST:

Exemplos de código

Recursos da biblioteca de cliente

Ver também