快速入门：适用于 Java 的 Azure Blob 存储客户端库

项目
09/19/2024

开始使用适用于 Java 的 Azure Blob 存储客户端库来管理 Blob 和容器。

在本文中，你将按照步骤安装软件包，并试用基本任务的示例代码。

提示

如果在 Spring 应用程序中使用 Azure 存储资源，建议将 Spring Cloud Azure 视为替代方法。 Spring Cloud Azure 是一个开源项目，提供 Spring 与 Azure 服务的无缝集成。要详细了解 Spring Cloud Azure，并查看使用 Blob 存储的示例，请参阅将文件上传到 Azure 存储 Blob。

API 参考文档 | 库源代码 | 包 (Maven) | 示例

先决条件

具备有效订阅的 Azure 帐户 - 创建试用帐户。
Azure 存储帐户 - 创建存储帐户。
Java 开发工具包 (JDK) 8 或更高版本。
Apache Maven。

设置

本部分逐步指导如何准备一个项目，使其与适用于 Java 的 Azure Blob 存储客户端库配合使用。

创建项目

创建名为 blob-quickstart 的 Java 应用程序。

在控制台窗口（例如 PowerShell 或 Bash）中，使用 Maven 创建名为 blob-quickstart 的新控制台应用。键入以下 mvn 命令，以创建“Hello world!”Java 项目。

PowerShell
Bash

mvn archetype:generate `
    --define interactiveMode=n `
    --define groupId=com.blobs.quickstart `
    --define artifactId=blob-quickstart `
    --define archetypeArtifactId=maven-archetype-quickstart `
    --define archetypeVersion=1.4

mvn archetype:generate \
    --define interactiveMode=n \
    --define groupId=com.blobs.quickstart \
    --define artifactId=blob-quickstart \
    --define archetypeArtifactId=maven-archetype-quickstart \
    --define archetypeVersion=1.4

生成项目的输出应如下所示：

[INFO] Scanning for projects...
[INFO]
[INFO] ------------------< org.apache.maven:standalone-pom >-------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] --------------------------------[ pom ]---------------------------------
[INFO]
[INFO] >>> maven-archetype-plugin:3.1.2:generate (default-cli) > generate-sources @ standalone-pom >>>
[INFO]
[INFO] <<< maven-archetype-plugin:3.1.2:generate (default-cli) < generate-sources @ standalone-pom <<<
[INFO]
[INFO]
[INFO] --- maven-archetype-plugin:3.1.2:generate (default-cli) @ standalone-pom ---
[INFO] Generating project in Batch mode
[INFO] ----------------------------------------------------------------------------
[INFO] Using following parameters for creating project from Archetype: maven-archetype-quickstart:1.4
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: groupId, Value: com.blobs.quickstart
[INFO] Parameter: artifactId, Value: blob-quickstart
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: com.blobs.quickstart
[INFO] Parameter: packageInPathFormat, Value: com/blobs/quickstart
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: com.blobs.quickstart
[INFO] Parameter: groupId, Value: com.blobs.quickstart
[INFO] Parameter: artifactId, Value: blob-quickstart
[INFO] Project created from Archetype in dir: C:\QuickStarts\blob-quickstart
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  7.056 s
[INFO] Finished at: 2019-10-23T11:09:21-07:00
[INFO] ------------------------------------------------------------------------
    ```

切换到新创建的 blob-quickstart 文件夹。
```
cd blob-quickstart
```
在 blob-quickstart 目录中，另外创建一个名为 data 的目录。这个文件夹是创建和存储 Blob 数据文件的地方。
```
mkdir data
```

安装包

在文本编辑器中打开 pom.xml 文件。

添加 azure-sdk-bom，以在最新版本的库中采用一个依赖项。在以下代码片段中，将 {bom_version_to_target} 占位符替换为版本号。使用 azure-sdk-bom 则无需指定每个依赖项的版本。若要了解有关 BOM 的详细信息，请参阅 Azure SDK BOM 自述文件。

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.azure</groupId>
            <artifactId>azure-sdk-bom</artifactId>
            <version>{bom_version_to_target}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

将以下依赖项元素添加到依赖项组。与 Azure 服务建立无密码连接需要 azure-identity 依赖项。

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-storage-blob</artifactId>
</dependency>
<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-identity</artifactId>
</dependency>

设置应用框架

从项目目录中，按照以下步骤创建应用的基本结构：

导航到 /src/main/java/com/blobs/quickstart 目录
在编辑器中打开 App.java 文件
删除 System.out.println("Hello world!"); 行
添加必要的 import 指令

代码应类似于以下框架：

package com.blobs.quickstart;

/**
 * Azure Blob Storage quickstart
 */
import com.azure.identity.*;
import com.azure.storage.blob.*;
import com.azure.storage.blob.models.*;
import java.io.*;

public class App
{
    public static void main(String[] args) throws IOException
    {
        // Quickstart code goes here
    }
}

对象模型

Azure Blob 存储最适合存储巨量的非结构化数据。非结构化数据并不遵循特定数据模型或定义（如文本或二进制数据）。 Blob 存储提供了三种类型的资源：

存储帐户
存储帐户中的容器
容器中的 blob

以下图示显示了这些资源之间的关系。

Blob 存储体系结构的示意图

使用以下 Java 类与这些资源进行交互：

BlobServiceClient：BlobServiceClient 类可用于操纵 Azure 存储资源和 blob 容器。存储帐户为 Blob 服务提供顶级命名空间。
BlobServiceClientBuilder：BlobServiceClientBuilder 类提供流畅的生成器 API，以帮助对 BlobServiceClient 对象的配置和实例化。
BlobContainerClient：BlobContainerClient 类可用于操纵 Azure 存储容器及其 blob。
BlobClient：BlobClient 类可用于操纵 Azure 存储 blob。
BlobItem：BlobItem 类表示从对 listBlobs 的调用返回的单个 blob。

代码示例

这些示例代码片段演示如何使用适用于 Java 的 Azure Blob 存储客户端库执行以下操作：

向 Azure 进行身份验证并授权访问 Blob 数据
创建容器
将 blob 上传到容器中
列出容器中的 blob
下载 blob
删除容器

重要

确保你在 pom.xml 中拥有正确的依赖项以及让代码示例正常工作的必要指令，如设置部分中所述。

向 Azure 进行身份验证并授权访问 Blob 数据

对 Azure Blob 存储的应用程序请求必须获得授权。要在代码中实现与 Azure 服务（包括 Blob 存储）的无密码连接，推荐使用 azure-identity 客户端库提供的 DefaultAzureCredential 类。

你还可以使用帐户访问密钥授权对 Azure Blob 存储的请求。但是，应谨慎使用此方法。开发人员必须尽量避免在不安全的位置公开访问密钥。具有访问密钥的任何人都可以授权针对存储帐户的请求，并且实际上有权访问所有数据。 DefaultAzureCredential 提供比帐户密钥更好的管理和安全优势，来实现无密码身份验证。以下示例演示了这两个选项。

无密码（推荐）
连接字符串

DefaultAzureCredential 是适用于 Java 的 Azure 标识客户端库提供的类。 DefaultAzureCredential 支持多种身份验证方法，并确定应在运行时使用哪种方法。通过这种方法，你的应用可在不同环境（本地与生产）中使用不同的身份验证方法，而无需实现特定于环境的代码。

有关 DefaultAzureCredential 查找凭据的顺序和位置，可查看 Azure 标识库概述。

例如，应用可在本地开发时使用 Visual Studio Code 登录凭据进行身份验证。应用在部署到 Azure 后就可以使用托管标识。此转换不需要进行任何代码更改。

将角色分配至 Microsoft Entra 用户帐户

在本地开发时，请确保访问 Blob 数据的用户帐户具有正确的权限。需有“存储 Blob 数据参与者”角色才能读取和写入 Blob 数据。若要为你自己分配此角色，需要具有“用户访问管理员”角色，或者具有包含 Microsoft.Authorization/roleAssignments/write 操作的其他角色。可使用 Azure 门户、Azure CLI 或 Azure PowerShell 向用户分配 Azure RBAC 角色。可以在范围概述页上详细了解角色分配的可用范围。

在此方案中，你将为用户帐户分配权限（范围为存储帐户）以遵循最低权限原则。这种做法仅为用户提供所需的最低权限，并创建更安全的生产环境。

以下示例将“存储 Blob 数据参与者”角色分配给用户帐户，该角色提供对存储帐户中 Blob 数据的读取和写入访问权限。

重要

在大多数情况下，角色分配在 Azure 中传播需要一两分钟的时间，但极少数情况下最多可能需要 8 分钟。如果在首次运行代码时收到身份验证错误，请稍等片刻再试。

在 Azure 门户中，使用主搜索栏或左侧导航找到存储帐户。
在存储帐户概述页的左侧菜单中选择“访问控制 (IAM)”。
在“访问控制 (IAM)”页上，选择“角色分配”选项卡。
从顶部菜单中选择“+ 添加”，然后从出现的下拉菜单中选择“添加角色分配”。
使用搜索框将结果筛选为所需角色。在此示例中，搜索“存储 Blob 数据参与者”并选择匹配的结果，然后选择“下一步”。
在“访问权限分配对象”下，选择“用户、组或服务主体”，然后选择“+ 选择成员”。
在对话框中，搜索 Microsoft Entra ID 用户名（通常是 user@domain 电子邮件地址），然后选中对话框底部的“选择”。
选择“查看 + 分配”转到最后一页，然后再次选择“查看 + 分配”完成该过程。

若要使用 Azure CLI 在资源级别分配角色，必须先使用 az storage account show 命令检索资源 ID。可以使用 --query 参数筛选输出属性。

az storage account show --resource-group '<your-resource-group-name>' --name '<your-storage-account-name>' --query id

复制上述命令的输出 Id。然后，可以使用 Azure CLI 的 az role 命令分配角色。

az role assignment create --assignee "<user@domain>" \
    --role "Storage Blob Data Contributor" \
    --scope "<your-resource-id>"

若要使用 Azure PowerShell 在资源级别分配角色，首先必须使用 Get-AzResource 命令检索资源 ID。

Get-AzResource -ResourceGroupName "<yourResourceGroupname>" -Name "<yourStorageAccountName>"

复制上述命令输出中的 Id 值。然后，可以使用 PowerShell 中的 New-AzRoleAssignment 命令分配角色。

New-AzRoleAssignment -SignInName <user@domain> `
    -RoleDefinitionName "Storage Blob Data Contributor" `
    -Scope <yourStorageAccountId>

可按照以下步骤授权访问存储帐户中的数据：

确保在存储帐户上向将角色分配到的同一 Microsoft Entra 帐户进行身份验证。可通过 Azure CLI、Visual Studio Code 或 Azure PowerShell 进行身份验证。
使用以下命令通过 Azure CLI 登录到 Azure：
```
az login
```
需要安装 Azure CLI 才能通过 Visual Studio Code 使用 DefaultAzureCredential。

在 Visual Studio Code 的主菜单上，导航到“终端”>“新建终端”。

使用以下命令通过 Azure CLI 登录到 Azure：
```
az login
```
通过以下命令使用 PowerShell 登录到 Azure：
```
Connect-AzAccount -Environment AzureChinaCloud
```

若要使用 DefaultAzureCredential，请确保在 pom.xml 中添加 azure-identity 依赖项：

<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-identity</artifactId>
</dependency>

将此代码添加到 Main 方法中。当代码在本地工作站上运行时，它将使用已登录的优先工具的开发人员凭据向 Azure 进行身份验证，例如 Azure CLI 或 Visual Studio Code。

 /*
  * The default credential first checks environment variables for configuration
  * If environment configuration is incomplete, it will try managed identity
  */
 DefaultAzureCredential defaultCredential = new DefaultAzureCredentialBuilder().build();

 // 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(defaultCredential)
         .buildClient();

请确保在 BlobServiceClient 的 URI 中更新存储帐户名称。可以在 Azure 门户的概述页上找到存储帐户名称。

注意

部署到 Azure 时，同样的代码可用于授权从 Azure 中运行的应用程序对 Azure 存储的请求。但是，需要在 Azure 中的应用上启用托管标识。然后，配置你的存储帐户以允许该托管标识进行连接。有关在 Azure 服务之间配置此连接的详细说明，请参阅 Azure 托管应用中的身份验证教程。

连接字符串包括存储帐户访问密钥，并使用它来授权请求。请始终小心，不要在不安全的位置公开密钥。

注意

若要使用存储帐户访问密钥授权数据访问，需要以下 Azure RBAC 操作的权限：Microsoft.Storage/storageAccounts/listkeys/action。具有此操作权限的最小特权内置角色是读取者和数据访问，但包含此操作的任何角色都将起作用。

登录 Azure 门户。
找到自己的存储帐户。
在存储帐户菜单窗格中的“安全性 + 网络”下，选择“访问密钥”。在这里，可以查看帐户访问密钥以及每个密钥的完整连接字符串。
在“访问密钥”窗格中，选择“显示密钥”。
在“key1”部分，找到“连接字符串”值。选择“复制到剪贴板”图标来复制该连接字符串。在下一部分，你要将此连接字符串值添加到某个环境变量。

可以使用 az storage account show-connection-string 命令查看存储帐户的连接字符串。

az storage account show-connection-string --name "<your-storage-account-name>"

可以使用 Get-AzStorageAccount 和 Get-AzStorageAccountKey 命令通过 PowerShell 组合连接字符串。

$saName = "yourStorageAccountName"
$rgName = "yourResourceGroupName"
$sa = Get-AzStorageAccount -StorageAccountName $saName -ResourceGroupName $rgName

$saKey = (Get-AzStorageAccountKey -ResourceGroupName $rgName -Name $saName)[0].Value

'DefaultEndpointsProtocol=https;AccountName=' + $saName + ';AccountKey=' + $saKey + ';EndpointSuffix=core.chinacloudapi.cn'

配置存储连接字符串

在复制连接字符串后，请将其写入到运行该应用程序的本地计算机上的新环境变量。若要设置环境变量，请打开控制台窗口，并遵照适用于操作系统的说明。将 <yourconnectionstring> 替换为实际的连接字符串。

Windows：

setx AZURE_STORAGE_CONNECTION_STRING "<yourconnectionstring>"

在 Windows 中添加环境变量后，必须启动命令窗口的新实例。

Linux：

export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

下面的代码从之前创建的环境变量中检索存储帐户的连接字符串，并使用连接字符串构造服务客户端对象。

将此代码添加到 Main 方法的末尾：

// Retrieve the connection string for use with the application. 
String connectStr = System.getenv("AZURE_STORAGE_CONNECTION_STRING");

// Create a BlobServiceClient object using a connection string
BlobServiceClient blobServiceClient = new BlobServiceClientBuilder()
    .connectionString(connectStr)
    .buildClient();

重要

应谨慎使用帐户访问密钥。如果帐户访问密钥丢失或意外放置在不安全的位置，服务可能会变得易受攻击。具有访问密钥的任何人都可以授权针对存储帐户的请求，并且实际上有权访问所有数据。 DefaultAzureCredential 提供增强的安全功能和优势，是管理 Azure 服务授权的推荐方法。

创建容器

通过在 blobServiceClient 对象上调用 createBlobContainer 方法，在存储帐户中新建容器。在此示例中，代码将 GUID 值追加到容器名称，以确保它是唯一的。

将此代码添加到 Main 方法的末尾：

// Create a unique name for the container
String containerName = "quickstartblobs" + java.util.UUID.randomUUID();

// Create the container and return a container client object
BlobContainerClient blobContainerClient = blobServiceClient.createBlobContainer(containerName);

若要详细了解如何创建容器并浏览更多代码示例，请参阅使用 Java 创建 Blob 容器。

重要

容器名称必须为小写。有关命名容器和 Blob 的详细信息，请参阅命名和引用容器、Blob 和元数据。

将 blob 上传到容器中

通过调用 uploadFromFile 方法将 Blob 上传到容器。示例代码将在本地数据目录中创建文本文件以上传到容器。

将此代码添加到 Main 方法的末尾：

// Create the ./data/ directory and a file for uploading and downloading
String localPath = "./data/";
new File(localPath).mkdirs();
String fileName = "quickstart" + java.util.UUID.randomUUID() + ".txt";

// Get a reference to a blob
BlobClient blobClient = blobContainerClient.getBlobClient(fileName);

// Write text to the file
FileWriter writer = null;
try
{
    writer = new FileWriter(localPath + fileName, true);
    writer.write("Hello, World!");
    writer.close();
}
catch (IOException ex)
{
    System.out.println(ex.getMessage());
}

System.out.println("\nUploading to Blob storage as blob:\n\t" + blobClient.getBlobUrl());

// Upload the blob
blobClient.uploadFromFile(localPath + fileName);

若要详细了解如何上传 Blob 并浏览更多代码示例，请参阅使用 Java 上传 Blob。

列出容器中的 Blob

通过调用 listBlobs 方法，列出容器中的 blob。在这种情况下，只向容器添加了一个 blob，因此列表操作只返回那个 blob。

将此代码添加到 Main 方法的末尾：

System.out.println("\nListing blobs...");

// List the blob(s) in the container.
for (BlobItem blobItem : blobContainerClient.listBlobs()) {
    System.out.println("\t" + blobItem.getName());
}

若要详细了解如何列出 Blob 并浏览更多代码示例，请参阅使用 Java 列出 Blob。

下载 Blob

通过调用 downloadToFile 方法，下载以前创建的 blob。示例代码将向文件名添加后缀“DOWNLOAD”，这样你就可以在本地文件系统中看到这两个文件。

将此代码添加到 Main 方法的末尾：

// Download the blob to a local file

// Append the string "DOWNLOAD" before the .txt extension for comparison purposes
String downloadFileName = fileName.replace(".txt", "DOWNLOAD.txt");

System.out.println("\nDownloading blob to\n\t " + localPath + downloadFileName);

blobClient.downloadToFile(localPath + downloadFileName);

若要详细了解如何下载 Blob 并浏览更多代码示例，请参阅使用 Java 下载 Blob。

删除容器

以下代码使用 delete 方法删除整个容器，从而清除该应用所创建的资源。它还会删除由应用创建的本地文件。

在删除 blob、容器和本地文件之前，应用会调用 System.console().readLine() 以暂停并等待用户输入。可以通过此机会验证是否已正确创建资源，然后再删除这些资源。

将此代码添加到 Main 方法的末尾：

File downloadedFile = new File(localPath + downloadFileName);
File localFile = new File(localPath + fileName);

// Clean up resources
System.out.println("\nPress the Enter key to begin clean up");
System.console().readLine();

System.out.println("Deleting blob container...");
blobContainerClient.delete();

System.out.println("Deleting the local source and downloaded files...");
localFile.delete();
downloadedFile.delete();

System.out.println("Done");

若要详细了解如何删除容器并浏览更多代码示例，请参阅使用 Java 删除和还原 Blob 容器。

运行代码

此应用在本地文件夹中创建测试文件，并将其上传到 Blob 存储。然后，该示例会列出容器中的 blob，并使用新名称下载文件，这样便可对新旧文件进行对比。

按照以下步骤编译、打包和运行代码

导航到包含 pom.xml 文件的目录，并使用以下 mvn 命令编译该项目：
```
mvn compile
```
以可分发格式打包已编译的代码：
```
mvn package
```

运行以下 mvn 命令以执行应用：

mvn exec:java -D exec.mainClass=com.blobs.quickstart.App -D exec.cleanupDaemonThreads=false

若要简化运行步骤，可以将 exec-maven-plugin 添加到 pom.xml 并进行如下配置：

<plugin>
  <groupId>org.codehaus.mojo</groupId>
  <artifactId>exec-maven-plugin</artifactId>
  <version>1.4.0</version>
  <configuration>
    <mainClass>com.blobs.quickstart.App</mainClass>
    <cleanupDaemonThreads>false</cleanupDaemonThreads>
  </configuration>
</plugin>

使用此配置，可以用以下命令执行应用：

mvn exec:java

应用的输出类似于以下示例（为便于阅读，省略了 UUID 值）：

Azure Blob Storage - Java quickstart sample

Uploading to Blob storage as blob:
        https://mystorageacct.blob.core.chinacloudapi.cn/quickstartblobsUUID/quickstartUUID.txt

Listing blobs...
        quickstartUUID.txt

Downloading blob to
        ./data/quickstartUUIDDOWNLOAD.txt

Press the Enter key to begin clean up

Deleting blob container...
Deleting the local source and downloaded files...
Done

在开始清理过程之前，请在“data”文件夹中查看这两个文件。可以将它们对比，然后就会看到它们完全相同。

清理资源

验证文件并完成测试后，请按 Enter 键删除测试文件以及在存储帐户中创建的容器。还可以使用 Azure CLI 来删除资源。

下一步

适用于 Java 的 Azure 存储示例和开发人员指南

通过

快速入门：适用于 Java 的 Azure Blob 存储客户端库

先决条件

设置

创建项目

安装包

设置应用框架

对象模型

代码示例

向 Azure 进行身份验证并授权访问 Blob 数据

将角色分配至 Microsoft Entra 用户帐户

使用 DefaultAzureCredential 登录并将应用代码连接到 Azure

创建容器

将 blob 上传到容器中

列出容器中的 Blob

下载 Blob

删除容器

运行代码

清理资源

下一步

其他资源