快速入门：将适用于 Node.js 的 Azure Blob 存储客户端库与 TypeScript 配合使用

Artículo
12/10/2024

开始将适用于 Node.js 的 Azure Blob 存储客户端库与 TypeScript 配合使用来管理 blob 和容器。

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

API 参考 | 库源代码 | 包 (npm) | 示例

先决条件

具有有效订阅的 Azure 帐户 - 创建试用帐户
Azure 存储帐户 - 创建存储帐户
Node.js LTS
TypeScript

设置

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

创建 Node.js 项目

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

在控制台窗口（例如 cmd、PowerShell 或 Bash）中，为项目创建新目录：
```
mkdir blob-quickstart
```
切换到新创建的 blob-quickstart 目录：
```
cd blob-quickstart
```
创建 package.json 文件：
```
npm init -y
```
在 Visual Studio Code 中打开项目：
```
code .
```
编辑 package.json 文件来添加以下属性以支持在 TypeScript 中使用 ESM：
```
"type": "module",
```

安装包

从项目目录中，使用 npm install 命令安装以下包。

安装 Azure 存储 npm 包：
```
npm install @azure/storage-blob
```
安装本快速入门中使用的其他依赖项：
```
npm install uuid dotenv @types/node @types/uuid
```

在项目目录中创建一个名为 tsconfig.json 的文件，并添加以下内容。

{
"compilerOptions": {
  "target": "es2022",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
  "module": "ESNext",                                /* Specify what module code is generated. */
  "moduleResolution": "node",                     /* Specify how TypeScript looks up a file from a given module specifier. */
  "outDir": "dist",                                   /* Specify an output folder for all emitted files. */
  "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
  "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
  "strict": true,                                      /* Enable all strict type-checking options. */
  "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
  }
}

对象模型

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

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

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

Blob 存储体系结构的图示。

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

BlobServiceClient：BlobServiceClient 类可用于操纵 Azure 存储资源和 blob 容器。
ContainerClient：ContainerClient 类可用于操纵 Azure 存储容器及其 blob。
BlobClient：BlobClient 类可用于操纵 Azure 存储 blob。

代码示例

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

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

此外，GitHub 上也会提供示例代码。

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

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

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

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

DefaultAzureCredential 支持多种身份验证方法，并确定应在运行时使用哪种方法。通过这种方法，你的应用可在不同环境（本地与生产）中使用不同的身份验证方法，而无需实现特定于环境的代码。

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

例如，应用可在本地开发时使用 Azure CLI 登录凭据进行身份验证。一旦部署到 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，请确保已安装 @azure\identity 包，并导入类：
```
import { DefaultAzureCredential } from '@azure/identity';
```

在 try 块内添加此代码。当代码在本地工作站上运行时，DefaultAzureCredential 使用你登录的优先工具的开发人员凭据向 Azure 进行身份验证。这些工具的示例包括 Azure CLI 或 Visual Studio Code。

const accountName = process.env.AZURE_STORAGE_ACCOUNT_NAME as string;
if (!accountName) throw Error('Azure Storage accountName not found');

// Add `Storage Blob Data Contributor` role assignment to the identity
const blobServiceClient = new BlobServiceClient(
 `https://${accountName}.blob.core.chinacloudapi.cn`,
 new DefaultAzureCredential()
);

确保更新 .env 文件或环境变量中的存储帐户名称 AZURE_STORAGE_ACCOUNT_NAME。可以在 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>"

.env 文件：

AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

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

在 try/catch 块内添加此代码：

const connectionString = process.env.AZURE_STORAGE_CONNECTION_STRING as string; 
if (!connectionString) throw Error('Azure Storage connectionString not found');

重要

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

创建容器

在存储帐户中创建新容器。以下代码示例采用 BlobServiceClient 对象，并调用 getContainerClient 方法来获取对容器的引用。然后，代码调用 create 方法在存储帐户中实际创建容器。

将此代码添加到 try 块的末尾：

const containerName = 'quickstart' + uuidv4();

  console.log('\nCreating container...');
  console.log('\t', containerName);

  const containerClient = blobServiceClient.getContainerClient(containerName);
  const createContainerResponse: ContainerCreateResponse = await containerClient.create();
  console.log(
    `Container was created successfully.\n\trequestId:${createContainerResponse.requestId}\n\tURL: ${containerClient.url}`
  );

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

重要

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

将 blob 上传到容器中

将 blob 上传到容器。以下代码通过从创建容器部分调用 ContainerClient 上的 getBlockBlobClient 方法，获取对 BlockBlobClient 对象的引用。

该代码通过调用 upload 方法，将文本字符串数据上传到 blob。

将此代码添加到 try 块的末尾：

const blobName = 'quickstart' + uuidv4(); + '.txt';
  const blockBlobClient: BlockBlobClient = containerClient.getBlockBlobClient(blobName);

  console.log(
    `\nUploading to Azure storage as blob\n\tname: ${blobName}:\n\tURL: ${blockBlobClient.url}`
  );

  const data = 'Hello, World!';
  const uploadBlobResponse: BlockBlobUploadResponse = await blockBlobClient.upload(data, data.length);
  console.log(
    `Blob was uploaded successfully. requestId: ${uploadBlobResponse.requestId}`
  );

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

列出容器中的 Blob

列出容器中的 Blob。以下代码调用 listBlobsFlat 方法。在这种情况下，容器中只有一个 Blob，因此列表操作只返回那个 Blob。

将此代码添加到 try 块的末尾：

console.log('\nListing blobs...');

  for await (const blob of containerClient.listBlobsFlat()) {
    const tempBlockBlobClient: BlockBlobClient = containerClient.getBlockBlobClient(blob.name);

    console.log(
      `\n\tname: ${blob.name}\n\tURL: ${tempBlockBlobClient.url}\n`
    );
  }

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

下载 Blob

下载 Blob 并显示内容。以下代码调用 download 方法以下载 Blob。

将此代码添加到 try 块的末尾：

const offset = 0;         // start at beginning
  const length = undefined; // read all

  const downloadBlockBlobResponse: BlobDownloadResponseParsed = await blockBlobClient.download(offset, length);
  console.log('\nDownloaded blob content...');
  console.log(
    '\t',
    await streamToText(downloadBlockBlobResponse.readableStreamBody as NodeJS.ReadableStream)
  );

以下代码将流转换回字符串以显示内容。

将此代码添加到 main 函数之后：

// Convert stream to text
async function streamToText(readable: NodeJS.ReadableStream): Promise<string> {
  readable.setEncoding('utf8');
  let data = '';
  for await (const chunk of readable) {
    data += chunk;
  }
  return data;
}

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

删除容器

删除容器以及容器内的所有 Blob。以下代码使用 delete 方法删除整个容器，从而清除该应用所创建的资源。

将此代码添加到 try 块的末尾：

console.log('\nDeleting container...');

  const deleteContainerResponse: ContainerDeleteResponse = await containerClient.delete();
  console.log(
    'Container was deleted successfully. requestId: ',
    deleteContainerResponse.requestId
  );

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

运行代码

从 Visual Studio Code 终端构建应用。
```
tsc
```
运行应用。
```
node dist/index.js
```

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

Azure Blob storage - JavaScript quickstart sample

Creating container...
    quickstart4a0780c0-fb72-11e9-b7b9-b387d3c488da

Uploading to Azure Storage as blob:
    quickstart4a3128d0-fb72-11e9-b7b9-b387d3c488da.txt

Listing blobs...
    quickstart4a3128d0-fb72-11e9-b7b9-b387d3c488da.txt

Downloaded blob content...
    Hello, World!

Deleting container...
Done

在调试器中逐步执行代码，并在执行过程中反复检查 Azure 门户。检查是否正在创建容器。可以在容器中打开 blob 并查看内容。

清理资源

完成本快速入门后，请删除 blob-quickstart 目录。
如果你已使用完 Azure 存储资源，请使用 Azure CLI 删除存储资源。

下一步

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

Compartir a través de

快速入门：将适用于 Node.js 的 Azure Blob 存储客户端库与 TypeScript 配合使用

先决条件

设置

创建 Node.js 项目

安装包

对象模型

代码示例

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

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

配置存储连接字符串

创建容器

将 blob 上传到容器中

列出容器中的 Blob

下载 Blob

删除容器

运行代码

清理资源

下一步

Recursos adicionales

Compartir a través de

快速入门：将适用于 Node.js 的 Azure Blob 存储客户端库与 TypeScript 配合使用

先决条件

设置

创建 Node.js 项目

安装包

对象模型

代码示例

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

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

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

创建容器

将 blob 上传到容器中

列出容器中的 Blob

下载 Blob

删除容器

运行代码

清理资源

下一步

Recursos adicionales