使用 Go 下载 Blob

本文介绍如何使用适用于 Go 的 Azure 存储客户端模块下载 Blob。 可以将 Blob 数据下载到各种目标，包括本地文件路径、流或文本字符串。

先决条件

• Azure 订阅 - 创建试用订阅。
• Azure 存储帐户 - 创建存储帐户
• Go 1.18+

设置你的环境

如果没有现有项目，请查看本部分，其中介绍了如何设置项目来使用适用于 Go 的 Azure Blob 存储客户端模块。 步骤包括模块安装、添加 import 路径以及创建授权的客户端对象。 有关详细信息，请参阅 Azure Blob 存储和 Go 入门。

安装模块

使用以下命令安装 azblob 模块：

go get github.com/Azure/azure-sdk-for-go/sdk/storage/azblob

若要使用 Microsoft Entra ID 进行身份验证（建议），请使用以下命令安装 azidentity 模块：

go get github.com/Azure/azure-sdk-for-go/sdk/azidentity

添加导入路径

在代码文件中添加以下导入路径：

import (
    "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/storage/azblob"
)

这些导入路径代表了开始之前需要满足的最低要求。 本文中的某些代码示例可能需要其他导入路径。 有关具体详细信息和示例用法，请参阅代码示例。

创建客户端对象

若要将应用连接到 Blob 存储，请使用 azblob.NewClient 创建客户端对象。 以下示例演示如何使用 DefaultAzureCredential 创建客户端对象进行授权：

func getServiceClientTokenCredential(accountURL string) *azblob.Client {
    // Create a new service client with token credential
    credential, err := azidentity.NewDefaultAzureCredential(nil)
    handleError(err)

    client, err := azblob.NewClient(accountURL, credential, nil)
    handleError(err)

    return client
}

授权

授权机制必须具有执行下载操作所需的权限。 若要使用 Microsoft Entra ID 进行授权（建议），需有 Azure RBAC 内置角色“存储 Blob 数据读取者”或更高级别的角色。 若要了解详细信息，请参阅获取 Blob (REST API) 的授权指南。

下载 Blob

可以使用以下任一方法来下载 Blob：

• DownloadBuffer
• DownloadFile
• DownloadStream

下载到文件路径

以下示例将 Blob 下载到一个文件路径：

func downloadBlobToFile(client *azblob.Client, containerName string, blobName string) {
    // Create or open a local file where we can download the blob
    file, err := os.Create("path/to/sample/file")
    handleError(err)

    // Download the blob to the local file
    _, err = client.DownloadFile(context.TODO(), containerName, blobName, file, nil)
    handleError(err)
}

下载到流

以下示例将 Blob 下载到流，并通过调用 NewRetryReader 方法从流中读取。

func downloadBlobToStream(client *azblob.Client, containerName string, blobName string) {
    // Download the blob
    get, err := client.DownloadStream(context.TODO(), containerName, blobName, nil)
    handleError(err)

    downloadedData := bytes.Buffer{}
    retryReader := get.NewRetryReader(context.TODO(), &azblob.RetryReaderOptions{})
    _, err = downloadedData.ReadFrom(retryReader)
    handleError(err)

    err = retryReader.Close()
    handleError(err)

    // Print the contents of the blob we created
    fmt.Println("Blob contents:")
    fmt.Println(downloadedData.String())
}

为下载指定数据传输选项

你可以设置下载 blob 时的配置选项，以优化性能。 以下配置选项可用于下载操作：

• BlockSize：下载块 blob 时每个块的大小。 默认值为 4 MB。
• Concurrency：下载期间要使用的并行连接的最大数目。 默认值为 5。

使用以下方法下载时，可以使用这些选项：

• DownloadBuffer
• DownloadFile

DownloadStream 方法不支持这些选项，并会在单个请求中下载数据。

若要详细了解 Blob 存储的传输大小限制，请参阅 Blob 存储的缩放目标。

下面的代码示例演示了如何使用 DownloadFileOptions 指定数据传输选项。 此示例中提供的值不作为建议。 若要正确优化这些值，需要考虑应用的特定需求。

func downloadBlobTransferOptions(client *azblob.Client, containerName string, blobName string) {
    // Create or open a local file where we can download the blob
    file, err := os.Create("path/to/sample/file")
    handleError(err)

    // Download the blob to the local file
    _, err = client.DownloadFile(context.TODO(), containerName, blobName, file,
        &azblob.DownloadFileOptions{
            BlockSize:   int64(4 * 1024 * 1024), // 4 MiB
            Concurrency: uint16(2),
        })
    handleError(err)
}

若要详细了解如何优化数据传输选项，请参阅优化 Go 的上传和下载性能。

资源

若要详细了解如何使用适用于 Go 的 Azure Blob 存储客户端模块来下载 Blob，请参阅以下资源。

代码示例

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

REST API 操作

Azure SDK for Go 包含基于 Azure REST API 而生成的库，允许你通过熟悉的 Go 范式来与 REST API 操作进行交互。 用于下载 blob 的客户端库方法使用以下 REST API 操作：

• 获取 Blob (REST API)

客户端模块资源

• 客户端模块参考文档
• 客户端模块源代码
• 包 (pkg.go.dev)

相关内容

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