JavaScript를 사용하여 Blob 나열

• .NET
• Java
• JavaScript
• Python
• Go

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

필수 조건

• 이 문서의 예제에서는 JavaScript용 Azure Blob Storage 클라이언트 라이브러리로 작업하도록 프로젝트가 이미 설정되어 있다고 가정합니다. 패키지 설치, 모듈 가져오기, 데이터 리소스 작업을 위한 권한 있는 클라이언트 개체 만들기 등 프로젝트를 설정하는 방법에 대한 자세한 내용은 Azure Blob Storage 및 JavaScript 시작을 참조하세요.
• 권한 부여 메커니즘에는 Blob을 나열할 수 있는 권한이 있어야 합니다. 자세한 내용은 다음 REST API 작업에 대한 권한 부여 지침을 참조하세요.
  • Blob 나열

Blob 목록 옵션 정보

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

단순 목록을 사용하여 컨테이너의 Blob을 나열하려면 다음 메서드를 호출합니다.

• ContainerClient.listBlobsFlat

계층적 목록을 사용하여 컨테이너의 Blob을 나열하려면 다음 메서드를 호출합니다.

• ContainerClient.listBlobsByHierarchy

반환되는 결과 수 관리

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

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

Blob 목록을 필터링하려면 ContainerListBlobsOptions에서 prefix 속성에 대한 문자열을 지정합니다. 접두사 문자열은 하나 이상의 문자를 포함할 수 있습니다. 그러면 Azure Storage는 이름이 해당 접두사로 시작하는 Blob만 반환합니다. 예를 들어 접두사 문자열 sample- 을 전달하면 이름이 .로 sample-시작하는 Blob만 반환됩니다.

Blob 메타데이터 또는 기타 정보 포함

결과에 Blob 메타데이터를 포함하려면 ContainerListBlobsOptions의 일부로 속성을 true 설정합니다includeMetadata. 적절한 속성을 으로 설정하여 결과에 스냅샷, 태그 또는 버전을 포함할 true수도 있습니다.

단순 목록 및 계층 구조 목록

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

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

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

플랫 목록 사용

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

다음 예제에서는 단순 목록을 사용하여 지정된 컨테이너에 있는 Blob을 나열합니다. 이 예제에는 Blob 스냅샷 및 Blob 메타데이터(있는 경우)가 포함됩니다.

JavaScript

async function listBlobsFlat(containerClient) {

  const maxPageSize = 2;

  // Some options for filtering results
  const listOptions = {
    includeMetadata: true,
    includeSnapshots: true,
    prefix: '' // Filter results by blob name prefix
  };

  console.log("Blobs flat list (by page):");
  for await (const response of containerClient
    .listBlobsFlat(listOptions)
    .byPage({ maxPageSize })) {
    console.log("- Page:");
    if (response.segment.blobItems) {
      for (const blob of response.segment.blobItems) {
        console.log(`  - ${blob.name}`);
      }
    }
  }
}

TypeScript

async function listBlobsFlat(
  containerClient: ContainerClient
): Promise<void> {
  
  const maxPageSize = 2;

  // Some options for filtering results
  const listOptions: ContainerListBlobsOptions = {
    includeMetadata: true,
    includeSnapshots: true,
    prefix: '' // Filter results by blob name prefix
  };

  console.log("Blobs flat list(by page):");
  for await (const response of containerClient
    .listBlobsFlat(listOptions)
    .byPage({ maxPageSize })) {
    console.log("- Page:");
    if (response.segment.blobItems) {
      for (const blob of response.segment.blobItems) {
        console.log(`  - ${blob.name}`);
      }
    }
  }
}

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

Blobs flat list (by page):
- Page:
  - a1
  - a2
- Page:
  - folder1/b1
  - folder1/b2
- Page:
  - folder2/sub1/c
  - folder2/sub1/d

참고 항목

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

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

계층형 목록 사용

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

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

• BlobContainerClient.listBlobsByHierarchy

다음 예제에서는 계층적 목록을 사용하여 지정된 컨테이너에 있는 Blob을 나열합니다. 이 예에서 prefix 매개 변수는 컨테이너의 모든 Blob을 나열하기 위해 처음에 빈 문자열로 설정됩니다. 그런 다음 이 예에서는 나열 작업을 재귀적으로 호출하여 가상 디렉터리 계층 구조를 트래버스하고 Blob을 나열합니다.

JavaScript

// Recursively list virtual folders and blobs
async function listBlobHierarchical(containerClient, delimiter='/') {
  
  const maxPageSize = 20;

  // Some options for filtering list
  const listOptions = {
    prefix: '' // Filter results by blob name prefix   
  };

  let i = 1;
  console.log(`Folder ${delimiter}`);

  for await (const response of containerClient
    .listBlobsByHierarchy(delimiter, listOptions)
    .byPage({ maxPageSize })) {

    console.log(`   Page ${i++}`);
    const segment = response.segment;

    if (segment.blobPrefixes) {

      // Do something with each virtual folder
      for await (const prefix of segment.blobPrefixes) {

        // Build new delimiter from current and next
        await listBlobHierarchical(containerClient, `${delimiter}${prefix.name}`);
      }
    }

    for (const blob of response.segment.blobItems) {

      // Do something with each blob
      console.log(`\tBlobItem: name - ${blob.name}`);
    }
  }
}

TypeScript

// Recursively list virtual folders and blobs
async function listBlobHierarchical(
  containerClient: ContainerClient,
  delimiter = '/'
): Promise<void> {

  const maxPageSize = 20;

  // Some options for filtering results
  const listOptions: ContainerListBlobsOptions = {
    prefix: '' // Filter results by blob name prefix
  };

  let i = 1;
  console.log(`Folder ${delimiter}`);

  for await (const response of containerClient
    .listBlobsByHierarchy(delimiter, listOptions)
    .byPage({ maxPageSize })) {
    console.log(`   Page ${i++}`);
    const segment = response.segment;

    if (segment.blobPrefixes) {
      // Do something with each virtual folder
      for await (const prefix of segment.blobPrefixes) {
        // Build new delimiter from current and next
        await listBlobHierarchical(
          containerClient,
          `${delimiter}${prefix.name}`
        );
      }
    }

    for (const blob of response.segment.blobItems) {
      // Do something with each blob
      console.log(`\tBlobItem: name - ${blob.name}`);
    }
  }
}

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

Folder /
   Page 1
        BlobItem: name - a1
        BlobItem: name - a2
   Page 2
Folder /folder1/
   Page 1
        BlobItem: name - folder1/b1
        BlobItem: name - folder1/b2
Folder /folder2/
   Page 1
Folder /folder2/sub1/
   Page 1
        BlobItem: name - folder2/sub1/c
        BlobItem: name - folder2/sub1/d
   Page 2
        BlobItem: name - folder2/sub1/e

참고 항목

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

리소스

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

코드 샘플

• 이 문서에서 JavaScript 및 TypeScript 코드 샘플 보기(GitHub)

REST API 작업

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

• Blob 나열(REST API)

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

• 클라이언트 라이브러리 참조 설명서
• 클라이언트 라이브러리 소스 코드
• 패키지(npm)

참고 항목

• Blob 리소스 열거
• Blob 버전 관리