Java를 사용하여 Blob 나열

  • 아티클

이 문서에서는 Java용 Azure Storage 클라이언트 라이브러리를 사용하여 Blob을 나열하는 방법을 보여 줍니다.

필수 조건

환경 설정

기존 프로젝트가 없는 경우, 이 섹션에서는 Java용 Azure Blob Storage 클라이언트 라이브러리를 사용해서 작동하도록 프로젝트를 설정하는 방법을 보여 줍니다. 자세한 내용은 Azure Blob Storage 및 Java 시작을 참조하세요.

이 문서의 코드 예제를 사용하려면 다음 단계에 따라 프로젝트를 설정합니다.

참고 항목

이 문서에서는 Maven 빌드 도구를 사용하여 코드 예를 빌드하고 실행합니다. Gradle과 같은 다른 빌드 도구도 Java용 Azure SDK에서 작동합니다.

패키지 설치

텍스트 편집기에서 pom.xml 파일을 엽니다. BOM 파일을 포함하거나 직접 종속성을 포함하여 패키지를 설치합니다.

Import 문 추가

다음 import 문을 추가합니다.

import com.azure.core.http.rest.*;
import com.azure.storage.blob.*;
import com.azure.storage.blob.models.*;

권한 부여

권한 부여 메커니즘에는 Blob을 나열하는 데 필요한 권한이 있어야 합니다. Microsoft Entra ID(권장)로 권한 부여하려면 Azure RBAC 기본 제공 역할 Storage Blob 데이터 읽기 권한자 이상이 필요합니다. 자세한 내용은 Blob 목록(REST API)에 대한 권한 부여 지침을 참조하세요.

클라이언트 개체 만들기

Blob Storage에 앱을 연결하려면 BlobServiceClient의 인스턴스를 만듭니다.

다음 예에서는 BlobServiceClientBuilder를 사용하여 DefaultAzureCredential을 사용해 BlobServiceClient 개체를 빌드하고 필요한 경우 컨테이너 및 Blob 클라이언트를 만드는 방법을 보여 줍니다.

// Azure SDK client builders accept the credential as a parameter
// TODO: Replace <storage-account-name> with your actual storage account name
BlobServiceClient blobServiceClient = new BlobServiceClientBuilder()
        .endpoint("https://<storage-account-name>.blob.core.windows.net/")
        .credential(new DefaultAzureCredentialBuilder().build())
        .buildClient();

// If needed, you can create a BlobContainerClient object from the BlobServiceClient
BlobContainerClient containerClient = blobServiceClient
        .getBlobContainerClient("<container-name>");

// If needed, you can create a BlobClient object from the BlobContainerClient
BlobClient blobClient = containerClient
        .getBlobClient("<blob-name>");

클라이언트 개체 만들기 및 관리에 대한 자세한 내용은 데이터 리소스와 상호 작용하는 클라이언트 개체 만들기 및 관리를 참조하세요.

Blob 목록 옵션 정보

코드에서 Blob을 나열하는 경우 Azure Storage에서 결과가 반환되는 방식을 관리하는 옵션을 지정할 수 있습니다. 각 결과 세트에서 반환할 결과 수를 지정하고 후속 세트를 검색할 수 있습니다. 이름이 해당 문자 또는 문자열로 시작하는 Blob을 반환하는 접두사를 지정할 수 있습니다. 플랫 목록 구조나 계층 구조로 Blob을 나열할 수 있습니다. 계층형 목록은 폴더로 구성된 것처럼 Blob을 반환합니다.

스토리지 계정의 Blob을 나열하려면 다음 메서드 중 하나를 호출합니다.

반환되는 결과 수 관리

기본적으로 목록 작업을 통해 반환되는 결과 수는 한 번에 최대 5,000개이지만 각 목록 작업을 통해 반환되도록 할 결과 수를 지정할 수 있습니다. 이 문서에 제공된 예제에서는 결과를 페이지에 반환하는 방법을 보여 줍니다. 페이지 매김 개념에 대한 자세한 내용은 Java용 Azure SDK를 사용하여 페이지 매김을 참조하세요.

접두사를 사용하여 결과 필터링

Blob 목록을 필터링하려면 문자열을 ListBlobsOptions.setPrefix(String 접두사)에 prefix 매개 변수로 전달합니다. 접두사 문자열은 하나 이상의 문자를 포함할 수 있습니다. 그러면 Azure Storage는 이름이 해당 접두사로 시작하는 Blob만 반환합니다.

단순 목록 및 계층 구조 목록

Azure Storage Blob은 계층형 패러다임(예: 클래식 파일 시스템)이 아닌 플랫 패러다임으로 구성됩니다. 그러나 폴더 구조를 모방하기 위해 Blob을 가상 디렉터리로 구성할 수 있습니다. 가상 디렉터리는 Blob 이름의 일부를 형성하며 구분 기호 문자로 표시됩니다.

Blob을 가상 디렉터리로 구성하려면 Blob 이름에 구분 기호 문자를 사용합니다. 기본 구분 기호 문자는 정방향 슬래시(/)이지만 어떤 문자도 구분 기호로 지정할 수 있습니다.

구분 기호를 사용하여 Blob의 이름을 지정할 경우 Blob을 계층형으로 나열하도록 선택할 수 있습니다. 계층 구조 목록 작업의 경우 Azure Storage는 부모 개체 아래에 가상 디렉터리와 Blob을 반환합니다. 클래식 파일 시스템을 프로그래밍 방식으로 트래버스하는 방법과 비슷하게 목록 작업을 재귀적으로 호출하여 계층 구조를 트래버스할 수 있습니다.

플랫 목록 사용

기본적으로 목록 작업은 Blob을 플랫 목록으로 반환합니다. 플랫 목록에서 Blob은 가상 디렉터리로 구성되지 않습니다.

다음 예제에서는 단순 목록을 사용하여 지정된 컨테이너에 있는 Blob을 나열합니다.

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

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

샘플 출력은 다음과 유사합니다.

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

목록 결과를 필터링하거나 추가 정보를 표시하는 옵션을 지정할 수도 있습니다. 다음 예제에서는 지정된 접두사를 가진 Blob을 나열하고 삭제된 Blob도 나열합니다.

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());
        });
    }
}

샘플 출력은 다음과 유사합니다.

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

참고 항목

표시된 샘플 출력에서는 단일 구조 네임스페이스가 있는 스토리지 계정이 있다고 가정합니다. 스토리지 계정에서 계층 구조 네임스페이스 기능을 사용한 경우 디렉터리는 가상이 아닙니다. 구체적이고 독립적인 개체입니다. 결과적으로 디렉터리를 목록에 길이가 0인 Blob으로 표시합니다.

계층 구조 네임스페이스로 작업할 때 대체 목록 옵션은 디렉터리 콘텐츠 나열(Azure Data Lake Storage)을 참조하세요.

계층형 목록 사용

목록 작업을 계층형으로 호출하는 경우 Azure Storage는 계층의 첫 번째 수준에서 가상 디렉터리 및 Blob을 반환합니다.

Blob을 계층적으로 나열하려면 다음 메서드를 사용합니다.

다음 예제에서는 계층적 목록을 사용하여 지정된 컨테이너에 있는 Blob을 나열합니다.

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());
                }
            });
}

샘플 출력은 다음과 유사합니다.

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

참고 항목

Blob 스냅샷은 계층형 목록 작업에 나열할 수 없습니다.

리소스

Java용 Azure Blob Storage 클라이언트 라이브러리를 사용하여 Blob을 나열하는 방법에 대해 자세히 알아보려면 다음 리소스를 참조하세요.

코드 샘플

REST API 작업

Java용 Azure SDK에는 Azure REST API를 기반으로 빌드되는 라이브러리가 포함되어 있으므로 익숙한 Java 패러다임을 통해 REST API 작업과 상호 작용할 수 있습니다. Blob을 나열하기 위한 클라이언트 라이브러리 메서드는 다음 REST API 작업을 사용합니다.

클라이언트 라이브러리 리소스

참고 항목

관련 콘텐츠

  • 이 문서는 Java용 Blob Storage 개발자 가이드의 일부입니다. 자세한 내용은 Java 앱 빌드에서 개발자 가이드 문서 전체 목록을 참조하세요.