Java を使用して BLOB を一覧表示する

[アーティクル]
09/02/2024

この記事では、Java 用の Azure Storage クライアントライブラリを使用して BLOB 一覧表示する方法について説明します。

前提条件

Azure サブスクリプション - 無料アカウントを作成する
Azure Storage アカウント - ストレージアカウントの作成
Java Development Kit (JDK) バージョン 8 以降 (最適なエクスペリエンスを得るために、バージョン 17 をお勧めします)
この例では、Apache Maven をプロジェクト管理に使用します

環境を設定する

既存のプロジェクトがない場合、Java 用 Azure Blob Storage クライアントライブラリを操作するためにプロジェクトをセットアップする方法について、このセクションで説明します。詳細については、「Azure Blob Storage と Java での作業開始」を参照してください。

この記事のコード例を使用するには、次の手順に従ってプロジェクトを設定します。

Note

この記事では Maven ビルドツールを使用して、コード例をビルドして実行します。 Gradle などの他のビルドツールも、Azure SDK for Java で動作します。

パッケージをインストールする

テキストエディターで 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 データ閲覧者以上が必要です。詳細については、List Blobs (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 件の結果が返されますが、各一覧表示操作で返される結果の数は指定できます。この記事の例は、結果をページに返す方法を示しています。改ページの概念の詳細については、「Azure SDK for Java を使用した改ページ」を参照してください。

プレフィックスを使用して結果をフィルター処理する

BLOB の一覧をフィルター処理するには、prefix パラメーターとして文字列を ListBlobsOptions.setPrefix(String prefix)に渡します。プレフィックス文字列には、1 つ以上の文字を含めることができます。 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

Note

次に示すサンプル出力では、フラット型名前空間を持つストレージアカウントがあることを前提としています。ストレージアカウントで階層型名前空間の機能を有効にしている場合、ディレクトリは仮想ではありません。そうではなく、具象の独立したオブジェクトです。その結果、ディレクトリは長さ 0 の BLOB として一覧に表示されます。

階層型名前空間を使って作業する場合の別のリストオプションについては、「ディレクトリの内容を一覧表示する (Azure Data Lake Storage)」を参照してください。

階層的な一覧表示を使用する

一覧表示操作を階層的に呼び出すと、Azure Storage は、階層の最初のレベルに仮想ディレクトリと BLOB を返します。

BLOB を階層的に一覧表示するには、次のメソッドを使用します。

listBlobsByHierarchy

次の例では、階層的な一覧表示を使用して、指定されたコンテナー内の 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

Note

BLOB のスナップショットは、階層的な一覧表示操作では一覧表示できません。

リソース

Java 用 Azure Blob Storage クライアントライブラリを使用して BLOB を一覧表示する方法について詳しくは、次のリソースを参照してください。

コードサンプル

この記事のコードサンプルを表示する (GitHub)

REST API の操作

Azure SDK for Java には Azure REST API に基づき構築されたライブラリが含まれるため、使い慣れた Java パラダイムを通じて REST API 操作を実施できます。 BLOB を一覧表示するためのクライアントライブラリメソッドは、次の REST API 操作を使用します。

List Blobs (REST API)

次の方法で共有

Java を使用して BLOB を一覧表示する

前提条件

環境を設定する

パッケージをインストールする

import ステートメントを追加する

承認

クライアントオブジェクトの作成

BLOB の一覧表示オプションについて

返される結果の数を管理する

プレフィックスを使用して結果をフィルター処理する

フラットな一覧表示と階層的な一覧表示

フラットな一覧表示を使用する

階層的な一覧表示を使用する

リソース

コードサンプル

REST API の操作

クライアントライブラリのリソース

関連項目

フィードバック

その他のリソース

次の方法で共有

Java を使用して BLOB を一覧表示する

前提条件

環境を設定する

パッケージをインストールする

import ステートメントを追加する

承認

クライアント オブジェクトの作成

BLOB の一覧表示オプションについて

返される結果の数を管理する

プレフィックスを使用して結果をフィルター処理する

フラットな一覧表示と階層的な一覧表示

フラットな一覧表示を使用する

階層的な一覧表示を使用する

リソース

コード サンプル

REST API の操作

クライアント ライブラリのリソース

関連項目

関連するコンテンツ

フィードバック

その他のリソース

クライアントオブジェクトの作成

コードサンプル

クライアントライブラリのリソース