大网数据广告活动
Azure 存储与备份

快速入门:适用于 .NET 的 Azure Blob 存储客户端库

· 52CE 我爱测

本快速入门介绍如何使用适用于 .NET 的 Azure Blob 存储客户端库在 Blob(对象)存储中创建容器和 blob。 接下来,介绍如何将 blob 下载到本地计算机,以及如何列出容器中的所有 blob。

适用于 .NET 的 Azure Blob 存储客户端库 v11 入门。 Azure Blob 存储是 Microsoft 提供的适用于云的对象存储解决方案。 请按照步骤操作,安装程序包并试用基本任务的示例代码。 Blob 存储最适合存储巨量的非结构化数据。

Note: 此快速启动使用 Azure Blob 存储客户端库的旧版本。 若要开始使用最新版本,请参阅快速入门:适用于 .NET 的 Azure Blob 存储客户端库 v12。

使用适用于 .NET 的 Azure Blob 存储客户端库完成以下操作:

  • 创建容器
  • 设置容器权限
  • 在 Azure 存储中创建 blob
  • 将 blob 下载到本地计算机
  • 列出容器中所有的 blob
  • 删除容器

其他资源:

Note: 本文中所述的功能现在可用于具有分层命名空间的帐户。 若要查看限制,请参阅 Azure Data Lake Storage Gen2 中可用的 Blob 存储功能一文。

先决条件

设置

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

创建项目

首先,创建名为 blob-quickstart 的 .NET Core 应用程序。

  1. 在控制台窗口(例如 cmd、PowerShell 或 Bash)中,使用 dotnet new 命令创建名为 blob-quickstart 的新控制台应用程序。 此命令将创建包含单个源文件的简单“Hello World”C# 项目:Program.cs。

    dotnet new console -n blob-quickstart
    
  2. 切换到新建的 blob-quickstart 文件夹,并生成应用以验证一切是否正常。

    cd blob-quickstart
    
    dotnet build
    

内部版本的预期输出应如下所示:

C:\QuickStarts\blob-quickstart> dotnet build
Microsoft (R) Build Engine version 16.0.450+ga8dc7f1d34 for .NET Core
Copyright (C) Microsoft Corporation. All rights reserved.

  Restore completed in 44.31 ms for C:\QuickStarts\blob-quickstart\blob-quickstart.csproj.
  blob-quickstart -> C:\QuickStarts\blob-quickstart\bin\Debug\netcoreapp2.1\blob-quickstart.dll

Build succeeded.
    0 Warning(s)
    0 Error(s)

Time Elapsed 00:00:03.08

安装包

当仍在应用程序目录中时,使用 dotnet add package 命令安装适用于 .NET 包的 Azure Blob 存储客户端库。

dotnet add package Microsoft.Azure.Storage.Blob

设置应用框架

从项目目录中执行以下操作:

  1. 在编辑器中打开 Program.cs 文件
  2. 删除 Console.WriteLine 语句
  3. 添加 using 指令
  4. 创建一个 ProcessAsync 方法,其中包含示例的主代码
  5. 从 Main 异步调用 ProcessAsync 方法

代码如下:

using System;
using System.IO;
using System.Threading.Tasks;
using Microsoft.Azure.Storage;
using Microsoft.Azure.Storage.Blob;

namespace blob_quickstart
{
    class Program
    {
        public static async Task Main()
        {
            Console.WriteLine("Azure Blob Storage - .NET quickstart sample\n");

            await ProcessAsync();

            Console.WriteLine("Press any key to exit the sample application.");
            Console.ReadLine();
        }

        private static async Task ProcessAsync()
        {
        }
    }
}

从 Azure 门户复制凭据

当示例应用程序向 Azure 存储发出请求时,必须对其进行授权。 若要对请求进行授权,请将存储帐户凭据以连接字符串形式添加到应用程序中。 按照以下步骤查看存储帐户凭据:

  1. 导航到 Azure 门户。

  2. 找到自己的存储帐户。

  3. 在存储帐户概述的“设置”部分,选择“访问密钥”。 在这里,可以查看你的帐户访问密钥以及每个密钥的完整连接字符串。

  4. 找到“密钥 1”下面的“连接字符串”值,选择“复制”按钮复制该连接字符串。 下一步需将此连接字符串值添加到某个环境变量。

    显示如何从 Azure 门户复制连接字符串的屏幕截图

配置存储连接字符串

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

Windows
setx AZURE_STORAGE_CONNECTION_STRING "<yourconnectionstring>"

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

Linux
export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"
MacOS
export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

添加环境变量后,重启需要读取环境变量的任何正在运行的程序。 例如,重启开发环境或编辑器,然后再继续。

对象模型

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

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

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

Blob 存储体系结构的图示

使用以下 .NET 类与这些资源进行交互:

  • CloudStorageAccount:CloudStorageAccount 类表示 Azure 存储帐户。 借助此类,可使用帐户访问密钥授予对 Blob 存储的访问权限。
  • CloudBlobClient:CloudBlobClient 类提供对代码中 Blob 服务的访问点。
  • CloudBlobContainer:CloudBlobContainer 类表示代码中的 blob 容器。
  • CloudBlockBlob:CloudBlockBlob 对象表示代码中的块 blob。 块 Blob 由可以分别管理的数据块构成。

代码示例

这些示例代码片段演示如何使用适用于 .NET 的 Azure Blob 存储客户端库执行以下步骤:

验证客户端

以下代码检查环境变量是否包含一个连接字符串,该字符串在经过分析后可以创建一个指向存储帐户的 CloudStorageAccount 对象。 若要检查连接字符串是否有效,请使用 TryParse 方法。 如果 TryParse 成功,它将初始化 storageAccount 变量并返回 true。

在 ProcessAsync 方法内添加此代码:

// Retrieve the connection string for use with the application. The storage 
// connection string is stored in an environment variable on the machine 
// running the application called AZURE_STORAGE_CONNECTION_STRING. If the 
// environment variable is created after the application is launched in a 
// console or with Visual Studio, the shell or application needs to be closed
// and reloaded to take the environment variable into account.
string storageConnectionString = Environment.GetEnvironmentVariable("AZURE_STORAGE_CONNECTION_STRING");

// Check whether the connection string can be parsed.
CloudStorageAccount storageAccount;
if (CloudStorageAccount.TryParse(storageConnectionString, out storageAccount))
{
    // If the connection string is valid, proceed with operations against Blob
    // storage here.
    // ADD OTHER OPERATIONS HERE
}
else
{
    // Otherwise, let the user know that they need to define the environment variable.
    Console.WriteLine(
        "A connection string has not been defined in the system environment variables. " +
        "Add an environment variable named 'AZURE_STORAGE_CONNECTION_STRING' with your storage " +
        "connection string as a value.");
    Console.WriteLine("Press any key to exit the application.");
    Console.ReadLine();
}

Note: 若要执行本文中的其余操作,请使用以下部分中的代码片段替换上述代码中的 // ADD OTHER OPERATIONS HERE。

创建容器

若要创建容器,请先创建 CloudBlobClient 对象的实例,该对象指向存储帐户中的 Blob 存储。 接下来,请创建 CloudBlobContainer 对象的实例,然后创建容器。

在此示例中,代码调用 CreateAsync 方法来创建容器。 GUID 值会追加到容器名称,确保其是唯一的。 在生产环境中,通常情况下,首选使用 CreateIfNotExistsAsync 方法来创建容器的前提是该方法不存在。

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

// Create the CloudBlobClient that represents the 
// Blob storage endpoint for the storage account.
CloudBlobClient cloudBlobClient = storageAccount.CreateCloudBlobClient();

// Create a container called 'quickstartblobs' and 
// append a GUID value to it to make the name unique.
CloudBlobContainer cloudBlobContainer = 
    cloudBlobClient.GetContainerReference("quickstartblobs" + 
        Guid.NewGuid().ToString());
await cloudBlobContainer.CreateAsync();

设置容器权限

设置容器权限,使容器中的所有 blob 都是公共的。 如果某个 Blob 是公开的,则任何客户端都可以对其进行匿名访问。

// Set the permissions so the blobs are public.
BlobContainerPermissions permissions = new BlobContainerPermissions
{
    PublicAccess = BlobContainerPublicAccessType.Blob
};
await cloudBlobContainer.SetPermissionsAsync(permissions);

将 blob 上传到容器中

以下代码片段通过针对前面部分创建的容器调用 GetBlockBlobReference 方法,获取 CloudBlockBlob 对象的引用。 然后,它会通过调用 UploadFromFileAsync 方法将所选本地文件上传到 blob。 此方法将创建 Blob(如果该 Blob 尚不存在),或者覆盖 Blob(如果该 Blob 已存在)。

// Create a file in your local MyDocuments folder to upload to a blob.
string localPath = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
string localFileName = "QuickStart_" + Guid.NewGuid().ToString() + ".txt";
string sourceFile = Path.Combine(localPath, localFileName);
// Write text to the file.
File.WriteAllText(sourceFile, "Hello, World!");

Console.WriteLine("Temp file = {0}", sourceFile);
Console.WriteLine("Uploading to Blob storage as blob '{0}'", localFileName);

// Get a reference to the blob address, then upload the file to the blob.
// Use the value of localFileName for the blob name.
CloudBlockBlob cloudBlockBlob = cloudBlobContainer.GetBlockBlobReference(localFileName);
await cloudBlockBlob.UploadFromFileAsync(sourceFile);

列出容器中的 Blob

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

如果一次调用需要返回的 Blob 数过多(默认为超过 5000 个),则 ListBlobsSegmentedAsync 方法会返回总结果集的一部分和一个继续令牌。 若要检索下一部分的 Blob,请提供前一调用返回的继续令牌,依此类推,直至继续令牌为 null。 继续令牌为 null 表明已检索所有 Blob。 代码演示如何根据最佳做法使用继续令牌。

// List the blobs in the container.
Console.WriteLine("List blobs in container.");
BlobContinuationToken blobContinuationToken = null;
do
{
    var results = await cloudBlobContainer.ListBlobsSegmentedAsync(null, blobContinuationToken);
    // Get the value of the continuation token returned by the listing call.
    blobContinuationToken = results.ContinuationToken;
    foreach (IListBlobItem item in results.Results)
    {
        Console.WriteLine(item.Uri);
    }
} while (blobContinuationToken != null); // Loop while the continuation token is not null.

下载 Blob

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

// Download the blob to a local file, using the reference created earlier.
// Append the string "_DOWNLOADED" before the .txt extension so that you 
// can see both files in MyDocuments.
string destinationFile = sourceFile.Replace(".txt", "_DOWNLOADED.txt");
Console.WriteLine("Downloading blob to {0}", destinationFile);
await cloudBlockBlob.DownloadToFileAsync(destinationFile, FileMode.Create);

删除容器

以下代码使用 CloudBlobContainer.DeleteAsync 来删除整个容器,从而清除该应用所创建的资源。 也可根据需要删除本地文件。

Console.WriteLine("Press the 'Enter' key to delete the example files, " +
    "example container, and exit the application.");
Console.ReadLine();
// Clean up resources. This includes the container and the two temp files.
Console.WriteLine("Deleting the container");
if (cloudBlobContainer != null)
{
    await cloudBlobContainer.DeleteIfExistsAsync();
}
Console.WriteLine("Deleting the source, and downloaded files");
File.Delete(sourceFile);
File.Delete(destinationFile);

运行代码

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

导航到应用程序目录,然后生成并运行应用程序。

dotnet build
dotnet run

应用的输出类似于以下示例:

Azure Blob storage - .NET Quickstart example

Created container 'quickstartblobs33c90d2a-eabd-4236-958b-5cc5949e731f'

Temp file = C:\Users\myusername\Documents\QuickStart_c5e7f24f-a7f8-4926-a9da-96
97c748f4db.txt
Uploading to Blob storage as blob 'QuickStart_c5e7f24f-a7f8-4926-a9da-9697c748f
4db.txt'

Listing blobs in container.
https://storagesamples.blob.core.windows.net/quickstartblobs33c90d2a-eabd-4236-
958b-5cc5949e731f/QuickStart_c5e7f24f-a7f8-4926-a9da-9697c748f4db.txt

Downloading blob to C:\Users\myusername\Documents\QuickStart_c5e7f24f-a7f8-4926
-a9da-9697c748f4db_DOWNLOADED.txt

Press any key to delete the example files and example container.

按 Enter 键时,应用程序会删除存储容器和文件。 在删除之前,请在 MyDocuments 文件夹中查看这两个文件。 可以打开它们,然后就会观察到它们完全相同。 从控制台窗口复制 Blob 的 URL,将其粘贴到浏览器中,查看 Blob 的内容。

验证文件后,按任意键可完成演示并删除测试文件。

后续步骤

本快速入门介绍了如何使用 .NET 上传、下载和列出 Blob。

若要了解如何创建一个 Web 应用,以便将映像上传到 Blob 存储,请继续学习:

上传和处理图像

历史资料。此文对应 2022-08-12 的中文文档快照,适用产品版本和命令行为以原文为准。

来源与署名:Microsoft 和文档贡献者(原始作者元数据 mhopkins-msft)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体、发布器占位标签和导航标记。

资料来源与适用范围

资料来源
Microsoft / Azure 中文运维文档历史快照
适用范围
历史中文快照 2022-08-12;详见原文产品版本;文档日期 07/24/2020
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0(文档)/ MIT(示例代码)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。