快速入门:在 Node.js 中使用 JavaScript SDK 管理 blob

本快速入门介绍如何使用 Node.js 管理 blob。 Blob 是可以保存大量文本或二进制数据(包括图像、文档、流媒体和存档数据)的对象。

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

先决条件

创建 Node.js 项目

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

  1. 在控制台窗口(例如 cmd、PowerShell 或 Bash)中,为项目创建新目录。

    mkdir blob-quickstart
    
  2. 切换到新创建的 blob-quickstart 目录。

    cd blob-quickstart
    
  3. 创建 package.json。

    npm init -y
    
  4. 在 Visual Studio Code 中打开项目:

    code .
    

安装包

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

  1. 安装 Azure 存储 npm 包:

    npm install @azure/storage-blob
    
  2. 安装用于无密码连接的 Azure 标识 npm 包:

    npm install @azure/identity
    
  3. 安装本快速入门中使用的其他依赖项:

    npm install uuid dotenv
    

创建 JavaScript 文件

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

  1. 创建名为 index.js 的新文件。
  2. 将以下代码复制到文件中。 在你完成本快速入门的过程中,还会添加更多代码。
const { BlobServiceClient } = require("@azure/storage-blob");
const { v1: uuidv1 } = require("uuid");
require("dotenv").config();

async function main() {
  try {
    console.log("Azure Blob storage v12 - JavaScript quickstart sample");

    // Quick start code goes here



  } catch (err) {
    console.err(`Error: ${err.message}`);
  }
}

main()
  .then(() => console.log("Done"))
  .catch((ex) => console.log(ex.message));

对象模型

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

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

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

Blob 存储体系结构的示意图

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

  • BlobServiceClientBlobServiceClient 类可用于操纵 Azure 存储资源和 blob 容器。
  • ContainerClientContainerClient 类可用于操纵 Azure 存储容器及其 blob。
  • BlobClientBlobClient 类可用于操纵 Azure 存储 blob。

代码示例

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

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

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

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

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

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

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

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

将角色分配给 Azure AD 用户帐户

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

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

以下示例将 Storage Blob Data Contributor 角色分配给用户帐户,该角色提供对存储帐户中 Blob 数据的读取和写入访问权限。

重要

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

  1. 在 Azure 门户中,使用主搜索栏或左侧导航找到存储帐户。

  2. 在存储帐户概述页的左侧菜单中选择“访问控制 (IAM)”。

  3. 在“访问控制 (IAM)”页上,选择“角色分配”选项卡。

  4. 从顶部菜单中选择“+ 添加”,然后从出现的下拉菜单中选择“添加角色分配”。

    显示如何分配角色的屏幕截图。

  5. 使用搜索框将结果筛选为所需角色。 在此示例中,搜索“存储 Blob 数据参与者”并选择匹配的结果,然后选择“下一步”。

  6. 在“访问权限分配对象”下,选择“用户、组或服务主体”,然后选择“+ 选择成员”。

  7. 在对话框中,搜索 Azure AD 用户名(通常为 user@domain 电子邮件地址),然后选择对话框底部的“选择”。

  8. 选择“查看 + 分配”转到最后一页,然后再次选择“查看 + 分配”完成该过程。

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

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

  1. 确保在存储帐户上向将角色分配到的同一 Azure AD 帐户进行身份验证。 可通过 Azure CLI、Visual Studio Code 或 Azure PowerShell 进行身份验证。

    使用以下命令通过 Azure CLI 登录到 Azure:

    az login
    
  2. 要使用 DefaultAzureCredential,请确保已安装 @azure\identity 包,并导入类:

    const { DefaultAzureCredential } = require('@azure/identity');
    
  3. try 块内添加此代码。 当代码在本地工作站上运行时,DefaultAzureCredential 使用你登录的优先工具的开发人员凭据向 Azure 进行身份验证。 这些工具的示例包括 Azure CLI 或 Visual Studio Code。

    const accountName = process.env.AZURE_STORAGE_ACCOUNT_NAME;
    if (!accountName) throw Error('Azure Storage accountName not found');
    
    const blobServiceClient = new BlobServiceClient(
      `https://${accountName}.blob.core.chinacloudapi.cn`,
      new DefaultAzureCredential()
    );
    
  4. 确保更新 .env 文件或环境变量中的存储帐户名称 AZURE_STORAGE_ACCOUNT_NAME。 可以在 Azure 门户的概述页上找到存储帐户名称。

    显示如何查找存储帐户名称的屏幕截图。

    注意

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

创建容器

  1. 确定新容器的名称。 容器名称必须为小写。

    有关命名容器和 Blob 的详细信息,请参阅命名和引用容器、Blob 和元数据

  2. 将此代码添加到 main 函数的末尾:

// Create a unique name for the container
const containerName = 'quickstart' + uuidv1();

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

// Get a reference to a container
const containerClient = blobServiceClient.getContainerClient(containerName);
// Create the container
const createContainerResponse = await containerClient.create();
console.log(
  `Container was created successfully.\n\trequestId:${createContainerResponse.requestId}\n\tURL: ${containerClient.url}`
);

上面的代码通过调用 fromConnectionString 方法,创建 BlobServiceClient 类的实例。 然后,调用 getContainerClient 方法以获取对容器的引用。 最后,调用 create 方法在存储帐户中实际创建容器。

将 blob 上传到容器中

将以下代码复制到 main 函数的末尾,以将文本字符串上传到 blob:

// Create a unique name for the blob
const blobName = 'quickstart' + uuidv1() + '.txt';

// Get a block blob client
const blockBlobClient = containerClient.getBlockBlobClient(blobName);

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

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

上面的代码通过从创建容器部分调用 ContainerClient 上的 getBlockBlobClient 方法,获取对 BlockBlobClient 对象的引用。 该代码通过调用 upload 方法,将文本字符串数据上传到 blob。

列出容器中的 Blob

将以下代码添加到 main 函数的末尾,以列出容器中的 blob。

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

// List the blob(s) in the container.
for await (const blob of containerClient.listBlobsFlat()) {
  // Get Blob Client from name, to get the URL
  const tempBlockBlobClient = containerClient.getBlockBlobClient(blob.name);

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

上面的代码调用 listBlobsFlat 方法。 在这种情况下,只向容器添加了一个 blob,因此列表操作只返回那个 blob。

下载 Blob

  1. 将以下代码添加到 main 函数的末尾,以将以前创建的 blob 下载到应用运行时。
// Get blob content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadBlockBlobResponse.readableStreamBody
// In browsers, get downloaded data by accessing downloadBlockBlobResponse.blobBody
const downloadBlockBlobResponse = await blockBlobClient.download(0);
console.log('\nDownloaded blob content...');
console.log(
  '\t',
  await streamToText(downloadBlockBlobResponse.readableStreamBody)
);

上面的代码调用 download 方法。

  1. 将以下代码复制到 main 函数的后面,以将流转换回字符串。
// Convert stream to text
async function streamToText(readable) {
  readable.setEncoding('utf8');
  let data = '';
  for await (const chunk of readable) {
    data += chunk;
  }
  return data;
}

删除容器

将此代码添加到 main 函数的末尾,以删除容器及其所有 blob:

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

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

上面的代码通过使用 delete 方法删除整个容器,清除该应用创建的资源。 也可根据需要删除本地文件。

运行代码

  1. 从 Visual Studio Code 终端运行应用。

    node index.js
    
  2. 应用的输出类似于以下示例:

    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 并查看内容。

清除

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

后续步骤

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

有关教程、示例、快速入门和其他文档,请访问: