使用 Java 管理容器属性和元数据

项目
2024/10/15

除 Blob 容器包含的数据外，它们还支持系统属性和用户定义的元数据。本文介绍如何使用用于 Java 的 Azure 存储客户端库管理系统属性和用户定义元数据。

先决条件

Azure 订阅 - 创建试用订阅。
Azure 存储帐户 - 创建存储帐户
Java 开发工具包 (JDK) 8 或更高版本（我们建议使用版本 17 以获得最佳体验）
在本示例中，Apache Maven 用于项目管理

设置你的环境

如果没有现有项目，请查看本部分，其中介绍了如何设置项目来使用适用于 Java 的 Azure Blob 存储客户端库。有关详细信息，请参阅 Azure Blob 存储和 Java 入门。

要使用本文中的代码示例，请按照以下步骤设置项目。

备注

本文使用 Maven 生成工具来生成和运行示例代码。其他生成工具（例如 Gradle）也可与 Azure SDK for Java 一起使用。

安装包

在文本编辑器中打开 pom.xml 文件。通过包括 BOM 文件或包括直接依赖项来安装包。

添加 import 语句

添加以下 import 语句：

import com.azure.storage.blob.*;
import com.azure.storage.blob.models.*;
import java.util.*;

授权

授权机制必须具有处理容器属性或元数据所需的权限。若要使用 Microsoft Entra ID 进行授权（建议），需具有 Azure RBAC 内置角色“存储 Blob 数据读取者”或更高级别的角色以便能够执行获取操作，并具有“存储 Blob 数据参与者”或更高级别的角色以便能够执行设置操作。有关详细信息，请参阅获取容器属性 (REST API)、设置容器元数据 (REST API) 或获取容器元数据 (REST API) 的授权指南。

创建客户端对象

若要将应用连接到 Blob 存储，请创建 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.chinacloudapi.cn/")
        .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 存储资源上都存在系统属性。其中一些属性是可以读取或设置的，而另一些属性是只读的。部分系统属性在“幕后”是与某些标准 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 存储客户端库设置和检索容器属性和元数据，请参阅以下资源。

代码示例

查看本文中的代码示例 (GitHub)

REST API 操作

Azure SDK for Java 包含基于 Azure REST API 而生成的库，允许你通过熟悉的 Java 范例与 REST API 操作进行交互。用于设置和检索属性和元数据的客户端库方法使用以下 REST API 操作：

getProperties 方法通过调用获取 Blob 属性操作和获取 Blob 元数据操作来检索容器属性和元数据。

客户端库资源

本文是适用于 Java 的 Blob 存储开发人员指南的一部分。若要了解详细信息，请参阅生成 Java 应用中的开发人员指南文章的完整列表。

通过