使用 Java 列出 Blob

本文說明如何使用適用於 Java 的 Azure 儲存體用戶端程式庫列出 Blob。

必要條件

Azure 訂用帳戶 - 建立免費帳戶
Azure 儲存體帳戶 - 建立儲存體帳戶
JAVA 開發套件 (JDK) 第 8 版或更新版本 (建議使用第 17 版以獲得最佳體驗)
在此範例中，Apache Maven 用於專案管理

設定您的環境

如果沒有現有的專案，本章節會說明如何設定專案以使用適用於 JAVA 的 Azure Blob 儲存體用戶端程式庫。如需詳細資訊，請參閱 Azure Blob 儲存體和 Java 快速入門。

若要使用本文中的程式碼範例，請遵循下列步驟來設定您的專案。

注意

本文使用 Maven 建置工具來建置和執行範例程式碼。 Gradle 等其他建置工具也能與適用於 Java 的 Azure SDK 搭配運作。

安裝套件

在文字編輯器中開啟 pom.xml 檔案。可透過納入 BOM 檔案或加入直接依賴項來安裝套件。

新增匯入陳述句

加入下列 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 Data Reader 或更高層級的角色。若要深入了解，請參閱列出 Blob (REST API) 的授權指引。

建立用戶端物件

若要將應用程式連線至 Blob 儲存體，請建立 BlobServiceClient類別的執行個體。

下列範例會使用 BlobServiceClientBuilder，使用 BlobServiceClient 建置 DefaultAzureCredential 物件，並視需要示範如何建立容器和 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 儲存體傳回結果的方式。您可指定要在每一組結果中傳回的結果數目，然後擷取後續集合。您可以指定前置詞，以傳回名稱以該字元或字串開頭的 Blob。您也可以用簡單清單結構列出 Blob，或以階層方式列出 Blob。階層式清單會透過將 Blob 組織成資料夾的方式傳回 Blob。

若要列出儲存體帳戶中的 Blob 物件，請呼叫下列其中一個方法：

管理傳回的結果數目

根據預設，列出作業一次最多會傳回 5000 個結果，但您可以指定要讓每個列出作業傳回的結果數目。本文中顯示的範例會說明如何在頁面中傳回結果。若要深入了解分頁概念，請參閱使用 Azure SDK for Java 進行分頁。

使用前置詞篩選結果

若要篩選 Blob 清單，請將字串當作 prefix 參數傳遞至 ListBlobsOptions.setPrefix(String prefix)。前置詞字串可包含一或多個字元。 Azure 儲存體接著只會傳回名稱開頭為該前置詞的 Blob。

簡單列表與階層式清單

Azure 儲存體中的 Blob 是以簡單架構進行組織，而不是階層式架構 (例如傳統檔案系統)。不過，您可將 Blob 組織成「虛擬目錄」，以便模擬資料夾結構。虛擬目錄會形成 Blob 名稱的一部分，並以分隔符號表示。

若要將 Blob 組織成虛擬目錄，請在 Blob 名稱中使用分隔符號。預設的分隔符號是正斜線 (/)，但可指定任何字元作為分隔符號。

如果使用分隔符號來命名 Blob，則可選擇以階層方式列出 Blob。對於階層式清單作業，Azure 儲存體會傳回父物件下方的任何虛擬目錄和 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

注意

所示的範例輸出是假設您有一個採用扁平命名空間的儲存體帳戶。如果你啟用了儲存帳號的階層命名空間功能，目錄就不是虛擬的。相反地，它們是具體且獨立的物件。因此，目錄會以零長度 Blob 的形式出現在清單中。

如需使用階層命名空間時的替代清單選項，請參閱列出目錄內容 (Azure Data Lake Storage)。

使用階層式清單

當以階層方式呼叫清單作業時，Azure 儲存體會傳回階層第一層級的虛擬目錄和 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

注意

Blob 快照無法在階層式列出作業中列出。

以 Apache Arrow 格式列出 Blob (預覽)

Important

Apache Arrow 格式的 blob 列表目前處於預覽階段。此情境需要 Java Azure Blob 儲存體用戶端函式庫的測試版（預覽版）版本（例如 azure-storage-blob12.36.0-beta.1 或更新版本）。預覽功能是在沒有服務等級合約的情況下提供的，不建議用於生產工作負載。有些功能可能不支援，或功能有限。欲了解更多資訊，請參閱 Microsoft Azure 預覽版補充使用條款。

此功能建立在現有 List Blobs API 之上。它不是使用預設的 XML，而是使用精簡的欄式 Apache Arrow 格式作為線上傳輸的回應格式。你可以在容器列表呼叫中設定一個選項來啟用它。 Java SDK 在幕後解碼 Apache Arrow，仍然回傳相同的BlobItem物件。此方法提升列表吞吐量，並在列舉大型容器時減少客戶端 CPU。它保留了應用程式所依賴的回應合約。

Warning

啟用階層命名空間 (Azure Data Lake Storage) 的儲存體帳戶不支援以 Apache Arrow 格式列出 Blob。

若要請求 Apache Arrow 格式的結果，請在 ListBlobsOptions 上呼叫，將回應序列化格式設為 StorageResponseSerializationFormat.ARROWsetStorageResponseSerializationFormat，然後將選項傳給 BlobContainerClient.listBlobs。使用 Apache Arrow 輸出時，你也可以呼叫 setStartFrom 和 setEndBefore 來控制回傳路徑的範圍。

以下範例列出容器中的 blob，並以 Apache Arrow 格式請求結果：

ListBlobsOptions options = new ListBlobsOptions()
    .setPrefix("folderA/")
    .setStorageResponseSerializationFormat(StorageResponseSerializationFormat.ARROW);

for (BlobItem blobItem : containerClient.listBlobs(options, null)) {
    System.out.println("Blob name: " + blobItem.getName());
}

資源

想了解如何使用 Azure Blob 儲存體用戶端函式庫來列出 Java 的 blob，請參閱以下資源。

程式碼範例

檢視本文中的程式碼範例 (GitHub) (英文)

REST API 操作

Azure SDK for Java 包含建立在 Azure REST API 之上的函式庫。透過使用這些函式庫，你可以透過熟悉的 Java 範式與 REST API 操作互動。用來列出 Blob 的用戶端程式庫方法會使用下列 REST API 作業：

列出 Blob 清單 (REST API)

用戶端程式庫資源

另請參閱

本文是適用於 JAVA 的 Blob 儲存體開發人員指南的一部分。若要深入了解，請參閱位於建置 JAVA 應用程式 (部分機器翻譯) 的開發人員指南文章完整清單。

意見反應

此頁面對您有幫助嗎？

Last updated on 2026-09-02

使用 Java 列出 Blob

必要條件

設定您的環境

安裝套件

新增匯入陳述句

授權

建立用戶端物件

關於 Blob 清單選項

管理傳回的結果數目

使用前置詞篩選結果

簡單列表與階層式清單

使用簡單列表

使用階層式清單

以 Apache Arrow 格式列出 Blob (預覽)

資源

程式碼範例

REST API 操作

用戶端程式庫資源

另請參閱

相關內容

意見反應

其他資源