使用 Java 管理容器屬性和中繼資料

發行項
03/23/2024

除了包含的資料之外，Blob 容器還支援系統屬性和使用者定義的中繼資料。此文章說明如何使用適用於 Java 的 Azure 儲存體用戶端程式庫，來管理系統屬性和使用者定義的中繼資料。

必要條件

本文會假設您已有專案設定好要使用適用於 Java 的 Azure Blob 儲存體用戶端程式庫。若要了解如何設定專案，包括套件安裝、新增 import 指示詞以及建立授權的用戶端物件，請參閱開始使用 Azure 儲存體和 Java。
授權機制必須含有處理容器屬性或中繼資料的權限。若要深入了解，請參閱下列 REST API 作業的授權指引：

關於屬性和中繼資料

系統屬性：系統屬性存在於每個 Blob 儲存體資源上。其中一些可以讀取或設定，另一些則是唯讀的。有些系統屬性會在幕後對應至特定的標準 HTTP 標頭。適用於 Java 的 Azure 儲存體用戶端程式庫會為您維護這些屬性。
使用者定義的中繼資料：使用者定義的中繼資料是由您為 Blob 儲存體資源所指定一或多個成對的名稱和數值所組成。您可以使用中繼資料來儲存資源的額外值。中繼資料值僅供您自己使用，並不會影響資源的運作方式。

中繼資料名稱/值組是有效的 HTTP 標頭，所以應該遵守控管 HTTP 標頭的所有限制。如需中繼資料命名需求的詳細資訊，請參閱中繼資料名稱。

擷取容器屬性

若要擷取容器屬性，請使用下列其中一種方法：

getProperties

下列程式碼範例會擷取容器的系統屬性，並將屬性值寫入主控台視窗：

public void getContainerProperties(BlobContainerClient blobContainerClient) {
    BlobContainerProperties properties = blobContainerClient.getProperties();
    System.out.printf("Public Access Type: %s, Legal Hold? %b, Immutable? %b%n",
            properties.getBlobPublicAccess(),
            properties.hasLegalHold(),
            properties.hasImmutabilityPolicy());
}

設定及擷取中繼資料

您可以將中繼資料指定為 blob 或容器資源上的一個或多個成對的名稱和數值。若要設定中繼資料，請使用下列方法：

setMetadata

設定容器中繼資料會覆寫與容器相關聯的所有現有中繼資料。您無法修改個別名稱/值組。

下列程式碼範例會在容器上設定中繼資料：

public void addContainerMetadata(BlobContainerClient blobContainerClient) {
    Map<String, String> metadata = new HashMap<String, String>();
    metadata.put("docType", "text");
    metadata.put("category", "reference");

    try {
        blobContainerClient.setMetadata(metadata);
        System.out.printf("Set metadata completed %n");
    } catch (UnsupportedOperationException error) {
        System.out.printf("Failure while setting metadata %n");
    }
}

若要擷取中繼資料，請呼叫下列方法：

getProperties

下列範例會在中繼資料值中讀取：

public void readContainerMetadata(BlobContainerClient blobContainerClient) {
    BlobContainerProperties properties = blobContainerClient.getProperties();

    System.out.printf("Container metadata: %n");
    properties.getMetadata().entrySet().forEach(metadataItem -> {
        System.out.printf(" %s = %s%n", metadataItem.getKey(), metadataItem.getValue());
    });
}

資源

若要深入了解如何使用適用於 Java 的 Azure Blob 儲存體用戶端程式庫來設定和擷取容器屬性和中繼資料，請參閱下列資源。

REST API 操作

適用於 Java 的 Azure SDK 包含建置在 Azure REST API 上的程式庫，可讓您透過熟悉的 Java 範例與 REST API 作業進行互動。用來設定與擷取屬性和中繼資料的用戶端程式庫方法會使用下列 REST API 作業：

getProperties 方法會藉由呼叫取得 Blob 屬性作業和取得 Blob 中繼資料作業來擷取 Blob 容器和中繼資料。

程式碼範例

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

共用方式為