JavaScript를 사용하여 Blob 나열
이 문서에서는 JavaScript용 Azure Storage 클라이언트 라이브러리를 사용하여 blob을 나열하는 방법을 보여 줍니다.
필수 조건
- 이 문서의 예제에서는 JavaScript용 Azure Blob Storage 클라이언트 라이브러리로 작업하도록 프로젝트가 이미 설정되어 있다고 가정합니다. 패키지 설치, 모듈 가져오기, 데이터 리소스 작업을 위한 권한 있는 클라이언트 개체 만들기 등 프로젝트를 설정하는 방법에 대한 자세한 내용은 Azure Blob Storage 및 JavaScript 시작을 참조하세요.
- 권한 부여 메커니즘에는 Blob을 나열할 수 있는 권한이 있어야 합니다. 자세한 내용은 다음 REST API 작업에 대한 권한 부여 지침을 참조하세요.
Blob 목록 옵션 정보
코드에서 Blob을 나열하는 경우 Azure Storage에서 결과가 반환되는 방식을 관리하는 다양한 옵션을 지정할 수 있습니다. 각 결과 세트에서 반환할 결과 수를 지정하고 후속 세트를 검색할 수 있습니다. 이름이 해당 문자 또는 문자열로 시작하는 Blob을 반환하는 접두사를 지정할 수 있습니다. 플랫 목록 구조나 계층 구조로 Blob을 나열할 수 있습니다. 계층형 목록은 폴더로 구성된 것처럼 Blob을 반환합니다.
스토리지 계정의 Blob을 나열하려면 ContainerClient를 만든 후 다음 메서드 중 하나를 호출합니다.
- ContainerClient.listBlobsByHierarcy
- ContainerClient.listBlobsFlat
관련 기능은 다음 메서드에서 찾을 수 있습니다.
- BlobServiceClient.findBlobsByTag
- ContainerClient.findBlobsByTag
반환되는 결과 수 관리
기본적으로 목록 작업을 통해 반환되는 결과 수는 한 번에 최대 5,000개이지만 각 목록 작업을 통해 반환되도록 할 결과 수를 지정할 수 있습니다. 이 문서에 제공된 예제에서는 결과를 페이지에 반환하는 방법을 보여 줍니다. 페이지 매김 개념에 대한 자세한 내용은 JavaScript용 Azure SDK를 사용하여 페이지 매김을 참조하세요.
접두사를 사용하여 결과 필터링
Blob 목록을 필터링하려면 ContainerListBlobsOptions에서 prefix 속성에 대한 문자열을 지정합니다. 접두사 문자열은 하나 이상의 문자를 포함할 수 있습니다. 그러면 Azure Storage는 이름이 해당 접두사로 시작하는 Blob만 반환합니다.
const listOptions = {
includeCopy: false, // include metadata from previous copies
includeDeleted: false, // include deleted blobs
includeDeletedWithVersions: false, // include deleted blobs with versions
includeLegalHold: false, // include legal hold
includeMetadata: true, // include custom metadata
includeSnapshots: true, // include snapshots
includeTags: true, // include indexable tags
includeUncommitedBlobs: false, // include uncommitted blobs
includeVersions: false, // include all blob version
prefix: '' // filter by blob name prefix
};
메타데이터 반환
list options에서 includeMetadata 속성을 지정하여 결과와 함께 Blob 메타데이터를 반환할 수 있습니다.
단순 목록 및 계층 구조 목록
Azure Storage Blob은 계층형 패러다임(예: 클래식 파일 시스템)이 아닌 플랫 패러다임으로 구성됩니다. 그러나 폴더 구조를 모방하기 위해 Blob을 가상 디렉터리로 구성할 수 있습니다. 가상 디렉터리는 Blob 이름의 일부를 형성하며 구분 기호 문자로 표시됩니다.
Blob을 가상 디렉터리로 구성하려면 Blob 이름에 구분 기호 문자를 사용합니다. 기본 구분 기호 문자는 정방향 슬래시(/)이지만 어떤 문자도 구분 기호로 지정할 수 있습니다.
구분 기호를 사용하여 Blob의 이름을 지정할 경우 Blob을 계층형으로 나열하도록 선택할 수 있습니다. 계층 구조 목록 작업의 경우 Azure Storage는 부모 개체 아래에 가상 디렉터리와 Blob을 반환합니다. 클래식 파일 시스템을 프로그래밍 방식으로 트래버스하는 방법과 비슷하게 목록 작업을 재귀적으로 호출하여 계층 구조를 트래버스할 수 있습니다.
플랫 목록 사용
기본적으로 목록 작업은 Blob을 플랫 목록으로 반환합니다. 플랫 목록에서 Blob은 가상 디렉터리로 구성되지 않습니다.
다음 예제에서는 단순 목록을 사용하여 지정된 컨테이너에 있는 Blob을 나열합니다.
async function listBlobsFlatWithPageMarker(containerClient) {
// page size - artificially low as example
const maxPageSize = 2;
let i = 1;
let marker;
// some options for filtering list
const listOptions = {
includeMetadata: false,
includeSnapshots: false,
includeTags: false,
includeVersions: false,
prefix: ''
};
let iterator = containerClient.listBlobsFlat(listOptions).byPage({ maxPageSize });
let response = (await iterator.next()).value;
// Prints blob names
for (const blob of response.segment.blobItems) {
console.log(`Flat listing: ${i++}: ${blob.name}`);
}
// Gets next marker
marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = containerClient.listBlobsFlat().byPage({
continuationToken: marker,
maxPageSize: maxPageSize * 2
});
response = (await iterator.next()).value;
// Prints next blob names
for (const blob of response.segment.blobItems) {
console.log(`Flat listing: ${i++}: ${blob.name}`);
}
}
샘플 출력은 다음과 유사합니다.
Flat listing: 1: a1
Flat listing: 2: a2
Flat listing: 3: folder1/b1
Flat listing: 4: folder1/b2
Flat listing: 5: folder2/sub1/c
Flat listing: 6: folder2/sub1/d
참고 항목
표시된 샘플 출력에서는 단일 구조 네임스페이스가 있는 스토리지 계정이 있다고 가정합니다. 스토리지 계정에서 계층 구조 네임스페이스 기능을 사용한 경우 디렉터리는 가상이 아닙니다. 구체적이고 독립적인 개체입니다. 결과적으로 디렉터리를 목록에 길이가 0인 Blob으로 표시합니다.
계층 구조 네임스페이스로 작업할 때 대체 목록 옵션은 디렉터리 콘텐츠 나열(Azure Data Lake Storage Gen2)을 참조하세요.
계층형 목록 사용
목록 작업을 계층형으로 호출하는 경우 Azure Storage는 계층의 첫 번째 수준에서 가상 디렉터리 및 Blob을 반환합니다.
BLOB을 계층형으로 나열하려면 BlobContainerClient.listBlobsByHierarchy 메서드를 호출합니다.
다음 예제에서는 BLOB을 지정된 컨테이너에 계층형 목록을 사용하여(선택적으로 세그먼트 크기를 지정) 나열하고 BLOB 이름을 콘솔 창에 씁니다.
// Recursively list virtual folders and blobs
// Pass an empty string for prefixStr to list everything in the container
async function listBlobHierarchical(containerClient, prefixStr) {
// page size - artificially low as example
const maxPageSize = 2;
// some options for filtering list
const listOptions = {
includeMetadata: false,
includeSnapshots: false,
includeTags: false,
includeVersions: false,
prefix: prefixStr
};
let delimiter = '/';
let i = 1;
console.log(`Folder ${delimiter}${prefixStr}`);
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 prefix from current virtual folder
await listBlobHierarchical(containerClient, 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을 나열하는 방법에 대해 자세히 알아보려면 다음 리소스를 참조하세요.
REST API 작업
JavaScript용 Azure SDK에는 Azure REST API를 기반으로 빌드되는 라이브러리가 포함되어 있어 친숙한 JavaScript 패러다임을 통해 REST API 작업과 상호 작용할 수 있습니다. Blob을 나열하기 위한 클라이언트 라이브러리 메서드는 다음 REST API 작업을 사용합니다.
- Blob 나열(REST API)
코드 샘플
클라이언트 라이브러리 리소스
참고 항목
- Blob 리소스 열거
- Blob 버전 관리