使用 Java 删除和还原 Blob

项目
10/15/2024

本文介绍如何使用适用于 Java 的 Azure 存储客户端库删除 Blob，以及如何在保留期内还原软删除的 Blob。

先决条件

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.core.http.rest.*;
import com.azure.core.util.*;
import com.azure.storage.blob.*;
import com.azure.storage.blob.models.*;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

授权

授权机制必须具有删除 Blob 或还原软删除 Blob 所需的权限。若要使用 Microsoft Entra ID 进行授权（建议），需有 Azure RBAC 内置角色“存储 Blob 数据参与者”或更高级别的角色。要了解详细信息，请参阅删除 Blob (REST API) 和取消删除 Blob (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

注意

为存储帐户启用 Blob 软删除后，无法使用客户端库方法执行永久删除。如果使用本文中所述的方法，软删除的 Blob、Blob 版本或快照在保留期结束之前会一直保持可用，保留期结束后将被永久删除。若要详细了解基础 REST API 操作，请参阅删除 Blob (REST API)。

若要删除 Blob，请调用以下任一方法：

下面的示例删除 Blob：

public void deleteBlob(BlobClient blobClient) {
    blobClient.delete();
}

如果 Blob 具有任何关联的快照，则必须删除其所有快照才能删除该 Blob。以下示例删除一个 Blob 及其快照，并显示了响应：

public void deleteBlobWithSnapshots(BlobClient blobClient) {
    Response<Boolean> response = blobClient.deleteIfExistsWithResponse(DeleteSnapshotsOptionType.INCLUDE, null,
            null,
            new Context("key", "value"));
    if (response.getStatusCode() == 404) {
        System.out.println("Blob does not exist");
    } else {
        System.out.printf("Delete blob completed with status %d%n", response.getStatusCode());
    }
}

若要仅删除快照，而不删除 Blob 本身，可以传递参数 DeleteSnapshotsOptionType.ONLY。

还原已删除的 Blob

Blob 软删除会在系统中将已删除的数据保留指定的一段时间，可以在意外删除或覆盖单个 Blob 及其版本、快照和元数据时提供保护。在保留期内，可以将 Blob 还原到它在删除时的状态。在指定的保留期已过后，Blob 将永久被删除。有关 Blob 软删除的详细信息，请参阅 Blob 的软删除。

可以使用 Azure 存储客户端库来还原软删除的 Blob 或快照。

还原软删除的 Blob 的方式取决于存储帐户是否启用了 Blob 版本控制。有关 Blob 版本控制的详细信息，请参阅 Blob 版本控制。请根据你的情况，查看以下部分之一：

未启用 Blob 版本控制
已启用 Blob 版本控制

禁用版本控制时还原软删除的对象

若要还原已删除的 Blob，请调用以下方法：

undelete

此方法还原软删除的 Blob 以及任何关联的软删除快照的内容和元数据。对未删除的 Blob 调用此方法不会起作用。

public void restoreBlob(BlobClient blobClient) {
    blobClient.undelete();
}

启用版本控制时还原软删除的对象

如果将存储帐户配置为启用 blob 版本控制，则删除 blob 会导致 blob 的当前版本成为以前的版本。若要在启用了版本控制的情况下还原软删除的 Blob，请将前一个版本复制到基础 Blob。可使用以下方法：

copyFromUrl

此方法还原软删除的 Blob 以及任何关联的软删除快照的内容和元数据。对未删除的 Blob 调用此方法不会起作用。

public void restoreBlobVersion(BlobContainerClient containerClient, BlobClient blobClient){
    // List blobs in this container that match the prefix
    // Include versions in the listing
    ListBlobsOptions options = new ListBlobsOptions()
            .setPrefix(blobClient.getBlobName())
            .setDetails(new BlobListDetails()
                    .setRetrieveVersions(true));
    Iterator<BlobItem> blobItem = containerClient.listBlobs(options, null).iterator();
    List<String> blobVersions = new ArrayList<>();
    while (blobItem.hasNext()) {
        blobVersions.add(blobItem.next().getVersionId());
    }

    // Sort the list of blob versions and get the most recent version ID
    Collections.sort(blobVersions, Collections.reverseOrder());
    String latestVersion = blobVersions.get(0);

    // Get a client object with the name of the deleted blob and the specified version
    BlobClient blob = containerClient.getBlobVersionClient("sampleBlob.txt", latestVersion);

    // Restore the most recent version by copying it to the base blob
    blobClient.copyFromUrl(blob.getBlobUrl());
}

还原被软删除的 Blob 和目录（分层命名空间）

重要

本部分仅适用于具有分层命名空间的帐户。

若要开始操作，请在文本编辑器中打开 pom.xml 文件。将以下依赖项元素添加到依赖项组。

<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-storage-file-datalake</artifactId>
  <version>12.6.0</version>
</dependency>

然后将这些 imports 语句添加到代码文件。
```
Put imports here
```

以下代码片段将还原名为 my-file 的软删除文件。

此方法假定你已创建 DataLakeServiceClient 实例。若要了解如何创建 DataLakeServiceClient 实例，请参阅连接到帐户。


public void RestoreFile(DataLakeServiceClient serviceClient){

    DataLakeFileSystemClient fileSystemClient =
        serviceClient.getFileSystemClient("my-container");

    DataLakeFileClient fileClient =
        fileSystemClient.getFileClient("my-file");

    String deletionId = null;

    for (PathDeletedItem item : fileSystemClient.listDeletedPaths()) {

        if (item.getName().equals(fileClient.getFilePath())) {
           deletionId = item.getDeletionId();
        }
    }

    fileSystemClient.restorePath(fileClient.getFilePath(), deletionId);
 }

如果你重命名了包含软删除项的目录，则这些项会与目录断开连接。如果要还原这些项，则必须将目录的名称还原为原始名称，或者创建一个使用原始目录名称的单独目录。否则，在尝试还原这些软删除项时，会出现错误。

资源

若要详细了解如何使用适用于 Java 的 Azure Blob 存储客户端库来删除 Blob 和还原已删除的 Blob，请参阅以下资源。

代码示例

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

REST API 操作

Azure SDK for Java 包含基于 Azure REST API 而生成的库，允许你通过熟悉的 Java 范例与 REST API 操作进行交互。用于删除 Blob 和还原已删除 Blob 的客户端库方法使用以下 REST API 操作：

删除 Blob (REST API)
取消删除 Blob (REST API)

客户端库资源

另请参阅

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

通过