向 Azure 服务总线队列发送消息并从中接收消息 (JavaScript)

Artículo
12/09/2024

在本教程中，将完成以下步骤：

使用 Azure 门户创建服务总线命名空间。
使用 Azure 门户创建服务总线队列。
编写 JavaScript 应用程序，以使用 @azure/service-bus 包来执行以下操作：
1. 将一组消息发送到队列。
2. 从队列接收这些消息。

注意

本快速入门分步介绍了一个简单方案，也就是将消息发送到服务总线队列并接收这些消息。可在 GitHub 上的 Azure SDK for JavaScript 存储库中找到预生成的 Azure 服务总线 JavaScript 和 TypeScript 示例。

先决条件

如果你是首次使用该服务，请在使用本快速入门之前先参阅服务总线概述。

Azure 订阅。若要完成本教程，需要一个 Azure 帐户。你可以激活 MSDN 订阅者权益或注册试用版订阅。
Node.js LTS

无密码
连接字符串

若要通过你自己的 Azure 帐户来使用本快速入门，你需要：

安装 Azure CLI，它提供向开发人员计算机进行无密码身份验证的功能。
在终端或命令提示符处通过 az login 使用 Azure 帐户登录。
将适当的数据角色添加到资源时，请使用同一帐户。
在同样的终端或命令提示符中运行代码。
记下服务总线命名空间的队列名称。需要在代码中使用它。

注意

本教程将演练可以使用 Nodejs 复制和运行的示例。有关如何创建 Node.js 应用程序的说明，请参阅创建 Node.js 应用程序并将其部署到 Azure 网站或使用 Windows PowerShell 创建 Node.js 云服务。

在 Azure 门户中创建命名空间

若要开始在 Azure 中使用服务总线消息实体，必须先使用在 Azure 中唯一的名称创建一个命名空间。命名空间提供了用于应用程序中的服务总线资源（队列、主题等）的范围容器。

创建命名空间：

登录 Azure 门户。
导航到“所有服务”页。
在左侧的导航栏中，从类别列表中选择“集成”，将鼠标悬停在“服务总线”上，然后选择“服务总线”磁贴上的 按钮。+。
在“创建命名空间”页的“基本信息”标记中，执行以下步骤：
1. 对于“订阅”，请选择要在其中创建命名空间的 Azure 订阅。
2. 对于“资源组”，请选择该命名空间驻留到的现有资源组，或创建一个新资源组。
3. 输入命名空间的名称。命名空间名称应遵循以下命名约定：
  - 该名称在 Azure 中必须唯一。系统会立即检查该名称是否可用。
  - 名称长度最少为 6 个字符，最多为 50 个字符。
  - 名称只能包含字母、数字和连字符“-”。
  - 名称必须以字母开头，并且必须以字母或数字结尾。
  - 名称不以“-sb”或“-mgmt”结尾。
4. 对于“位置”，请选择托管该命名空间的区域。
5. 对于“定价层”，请选择命名空间的定价层（“基本”、“标准”或“高级”）。对于本快速入门，请选择“标准”。
  
  重要
  
  若要使用主题和订阅，请选择“标准”或“高级”。基本定价层不支持主题/订阅。
  
  如果选择了“高级”定价层，请指定“消息传送单元”数。高级层在 CPU 和内存级别提供资源隔离，使每个工作负荷在隔离的环境中运行。此资源容器称为消息传送单元。高级命名空间至少具有一个消息传送单元。可为每个服务总线高级命名空间选择 1、2、4、8 或 16 个消息传送单元。有关详细信息，请参阅服务总线高级消息传送。
6. 在页面底部选择“查看 + 创建”。
7. 在“查看 + 创建”页上，查看设置，然后选择“创建” 。
资源部署成功后，在部署页上选择“转到资源”。
将会看到服务总线命名空间的主页。

在 Azure 门户中创建队列

在“服务总线命名空间”页面上，选择左侧导航菜单中的“队列”。
在“队列”页面上，选择工具栏上的“+ 队列”。
输入队列名称，其他值则保留默认值。
现在选择“创建”。

向 Azure 验证应用

本快速入门介绍了连接到 Azure 服务总线的两种方法：无密码和连接字符串方法。第一个选项展示如何使用 Azure Active Directory 中的安全主体和基于角色的访问控制 (RBAC) 连接到服务总线命名空间。无需担心代码、配置文件或安全存储（如 Azure Key Vault）中存在硬编码的连接字符串。第二个选项展示如何使用连接字符串连接到服务总线命名空间。如果不熟悉 Azure，你可能会感觉连接字符串选项更易于使用。建议在实际应用程序和生产环境中使用无密码选项。有关详细信息，请参阅身份验证和授权。还可以在概述页上阅读有关无密码身份验证的详细信息。

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

将角色分配给 Azure AD 用户

在本地开发时，请确保连接到 Azure 服务总线的用户帐户具有正确的权限。你需要拥有 Azure 服务总线数据所有者角色才能发送和接收消息。若要为自己分配此角色，需要具有“用户访问管理员”角色，或者具有包含 Microsoft.Authorization/roleAssignments/write 操作的其他角色。可使用 Azure 门户、Azure CLI 或 Azure PowerShell 向用户分配 Azure RBAC 角色。可在范围概述页上详细了解角色分配的可用范围。

以下示例将 Azure Service Bus Data Owner 角色分配给用户帐户，该角色提供对 Azure 服务总线资源的完全访问权限。在实际方案中，遵循最小特权原则，仅向用户提供更安全的生产环境所需的最小权限。

适用于 Azure 服务总线的 Azure 内置角色

对于 Azure 服务总线，通过 Azure 门户和 Azure 资源管理 API 对命名空间和所有相关资源的管理已使用 Azure RBAC 模型进行了保护。 Azure 提供以下 Azure 内置角色，用于授予对服务总线命名空间的访问权限：

Azure 服务总线数据所有者：允许对服务总线命名空间及其实体（队列、主题、订阅和筛选器）进行数据访问。此角色的成员可以从队列或主题/订阅发送和接收消息。
Azure 服务总线数据发送者：使用此角色可以为服务总线命名空间及其实体提供发送访问权限。
Azure 服务总线数据接收者：使用此角色可以为服务总线命名空间及其实体提供接收访问权限。

如果要创建自定义角色，请参阅执行服务总线操作所需的权限。

将 Azure AD 用户添加到 Azure 服务总线所有者角色

将 Azure AD 用户名添加到服务总线命名空间级别的“Azure 服务总线数据所有者”角色。它将允许在用户帐户上下文中运行的应用将消息发送到队列或主题，并从队列或主题的订阅中接收消息。

重要

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

如果未在 Azure 门户中打开“服务总线命名空间”页，请使用主搜索栏或左侧导航找到你的服务总线命名空间。
在概述页面上，从左侧菜单中选择“访问控制(IAM)”。
在“访问控制 (IAM)”页上，选择“角色分配”选项卡。
从顶部菜单中选择“+ 添加”，然后从出现的下拉菜单中选择“添加角色分配”。
使用搜索框将结果筛选为所需角色。对于此示例，请搜索 Azure Service Bus Data Owner 并选择匹配的结果。然后选择“下一步” 。
在“访问权限分配对象”下，选择“用户、组或服务主体”，然后选择“+ 选择成员”。
在对话框中，搜索 Azure AD 用户名（通常为 user@domain 电子邮件地址），然后选择对话框底部的“选择”。
选择“查看 + 分配”转到最后一页，然后再次选择“查看 + 分配”完成该过程。

若要安装服务总线所需的 npm 包，请打开路径中包含 npm 的命令提示符，将目录更改为要包含示例的文件夹，然后运行此命令。

安装以下包：

npm install @azure/service-bus @azure/identity

若要安装服务总线所需的 npm 包，请打开路径中包含 npm 的命令提示符，将目录更改为要包含示例的文件夹，然后运行此命令。
安装以下包：
```
npm install @azure/service-bus
```

向队列发送消息

以下示例代码演示如何向队列发送消息。

无密码
连接字符串

必须已使用 Azure CLI 的 az login 进行登录，以便本地计算机提供此代码中所需的无密码身份验证。

打开偏好的编辑器，例如 Visual Studio Code。

创建一个名为 send.js 的文件，并将下面的代码粘贴到其中。此代码将科学家的名称作为消息发送到队列。

重要

无密码凭据随 DefaultAzureCredential 一起提供。

const { ServiceBusClient } = require("@azure/service-bus");
const { DefaultAzureCredential } = require("@azure/identity");

// Replace `<SERVICE-BUS-NAMESPACE>` with your namespace
const fullyQualifiedNamespace = "<SERVICE-BUS-NAMESPACE>.servicebus.chinacloudapi.cn";

// Passwordless credential
const credential = new DefaultAzureCredential();

// name of the queue
const queueName = "<QUEUE NAME>"

const messages = [
    { body: "Albert Einstein" },
    { body: "Werner Heisenberg" },
    { body: "Marie Curie" },
    { body: "Steven Hawking" },
    { body: "Isaac Newton" },
    { body: "Niels Bohr" },
    { body: "Michael Faraday" },
    { body: "Galileo Galilei" },
    { body: "Johannes Kepler" },
    { body: "Nikolaus Kopernikus" }
    ];

async function main() {
    // create a Service Bus client using the passwordless authentication to the Service Bus namespace
    const sbClient = new ServiceBusClient(fullyQualifiedNamespace, credential);

    // createSender() can also be used to create a sender for a topic.
    const sender = sbClient.createSender(queueName);

    try {
        // Tries to send all messages in a single batch.
        // Will fail if the messages cannot fit in a batch.
        // await sender.sendMessages(messages);

        // create a batch object
        let batch = await sender.createMessageBatch();
        for (let i = 0; i < messages.length; i++) {
            // for each message in the array

            // try to add the message to the batch
            if (!batch.tryAddMessage(messages[i])) {
                // if it fails to add the message to the current batch
                // send the current batch as it is full
                await sender.sendMessages(batch);

                // then, create a new batch
                batch = await sender.createMessageBatch();

                // now, add the message failed to be added to the previous batch to this batch
                if (!batch.tryAddMessage(messages[i])) {
                    // if it still can't be added to the batch, the message is probably too big to fit in a batch
                    throw new Error("Message too big to fit in a batch");
                }
            }
        }

        // Send the last created batch of messages to the queue
        await sender.sendMessages(batch);

        console.log(`Sent a batch of messages to the queue: ${queueName}`);

        // Close the sender
        await sender.close();
    } finally {
        await sbClient.close();
    }
}

// call the main function
main().catch((err) => {
    console.log("Error occurred: ", err);
    process.exit(1);
    });

将 <SERVICE-BUS-NAMESPACE> 替换为服务总线命名空间。
将 <QUEUE NAME> 替换为该队列的名称。
然后，在命令提示符中运行该命令以执行此文件。
```
node send.js
```

你会看到以下输出。

Sent a batch of messages to the queue: myqueue

打开偏好的编辑器，例如 Visual Studio Code。

创建一个名为 send.js 的文件，并将下面的代码粘贴到其中。此代码将科学家的名称作为消息发送到队列。

const { ServiceBusClient } = require("@azure/service-bus");

// connection string to your Service Bus namespace
const connectionString = "<CONNECTION STRING TO SERVICE BUS NAMESPACE>"

// name of the queue
const queueName = "<QUEUE NAME>"

const messages = [
    { body: "Albert Einstein" },
    { body: "Werner Heisenberg" },
    { body: "Marie Curie" },
    { body: "Steven Hawking" },
    { body: "Isaac Newton" },
    { body: "Niels Bohr" },
    { body: "Michael Faraday" },
    { body: "Galileo Galilei" },
    { body: "Johannes Kepler" },
    { body: "Nikolaus Kopernikus" }
 ];

async function main() {
    // create a Service Bus client using the connection string to the Service Bus namespace
    const sbClient = new ServiceBusClient(connectionString);

    // createSender() can also be used to create a sender for a topic.
    const sender = sbClient.createSender(queueName);

    try {
        // Tries to send all messages in a single batch.
        // Will fail if the messages cannot fit in a batch.
        // await sender.sendMessages(messages);

        // create a batch object
        let batch = await sender.createMessageBatch();
        for (let i = 0; i < messages.length; i++) {
            // for each message in the array

            // try to add the message to the batch
            if (!batch.tryAddMessage(messages[i])) {
                // if it fails to add the message to the current batch
                // send the current batch as it is full
                await sender.sendMessages(batch);

                // then, create a new batch
                batch = await sender.createMessageBatch();

                // now, add the message failed to be added to the previous batch to this batch
                if (!batch.tryAddMessage(messages[i])) {
                    // if it still can't be added to the batch, the message is probably too big to fit in a batch
                    throw new Error("Message too big to fit in a batch");
                }
            }
        }

        // Send the last created batch of messages to the queue
        await sender.sendMessages(batch);

        console.log(`Sent a batch of messages to the queue: ${queueName}`);

        // Close the sender
        await sender.close();
    } finally {
        await sbClient.close();
    }
}

// call the main function
main().catch((err) => {
    console.log("Error occurred: ", err);
    process.exit(1);
 });

将 <CONNECTION STRING TO SERVICE BUS NAMESPACE> 替换为服务总线命名空间的连接字符串。
将 <QUEUE NAME> 替换为该队列的名称。
然后，在命令提示符中运行该命令以执行此文件。
```
node send.js
```

你会看到以下输出。

Sent a batch of messages to the queue: myqueue

从队列接收消息

无密码
连接字符串

必须已使用 Azure CLI 的 az login 进行登录，以便本地计算机提供此代码中所需的无密码身份验证。

打开你喜好的编辑器，例如 Visual Studio Code

创建名为 receive.js 的文件，然后将以下代码粘贴到其中。

const { delay, ServiceBusClient, ServiceBusMessage } = require("@azure/service-bus");
const { DefaultAzureCredential } = require("@azure/identity");

// Replace `<SERVICE-BUS-NAMESPACE>` with your namespace
const fullyQualifiedNamespace = "<SERVICE-BUS-NAMESPACE>.servicebus.chinacloudapi.cn";

// Passwordless credential
const credential = new DefaultAzureCredential();

// name of the queue
const queueName = "<QUEUE NAME>"

 async function main() {
    // create a Service Bus client using the passwordless authentication to the Service Bus namespace
    const sbClient = new ServiceBusClient(fullyQualifiedNamespace, credential);

    // createReceiver() can also be used to create a receiver for a subscription.
    const receiver = sbClient.createReceiver(queueName);

    // function to handle messages
    const myMessageHandler = async (messageReceived) => {
        console.log(`Received message: ${messageReceived.body}`);
    };

    // function to handle any errors
    const myErrorHandler = async (error) => {
        console.log(error);
    };

    // subscribe and specify the message and error handlers
    receiver.subscribe({
        processMessage: myMessageHandler,
        processError: myErrorHandler
    });

    // Waiting long enough before closing the sender to send messages
    await delay(20000);

    await receiver.close();
    await sbClient.close();
}
// call the main function
main().catch((err) => {
    console.log("Error occurred: ", err);
    process.exit(1);
 });

将 <SERVICE-BUS-NAMESPACE> 替换为服务总线命名空间。
将 <QUEUE NAME> 替换为该队列的名称。
然后，在命令提示符中运行该命令以执行此文件。
```
node receive.js
```

打开你喜好的编辑器，例如 Visual Studio Code

创建名为 receive.js 的文件，然后将以下代码粘贴到其中。

const { delay, ServiceBusClient, ServiceBusMessage } = require("@azure/service-bus");

// connection string to your Service Bus namespace
const connectionString = "<CONNECTION STRING TO SERVICE BUS NAMESPACE>"

// name of the queue
const queueName = "<QUEUE NAME>"

 async function main() {
    // create a Service Bus client using the connection string to the Service Bus namespace
    const sbClient = new ServiceBusClient(connectionString);

    // createReceiver() can also be used to create a receiver for a subscription.
    const receiver = sbClient.createReceiver(queueName);

    // function to handle messages
    const myMessageHandler = async (messageReceived) => {
        console.log(`Received message: ${messageReceived.body}`);
    };

    // function to handle any errors
    const myErrorHandler = async (error) => {
        console.log(error);
    };

    // subscribe and specify the message and error handlers
    receiver.subscribe({
        processMessage: myMessageHandler,
        processError: myErrorHandler
    });

    // Waiting long enough before closing the sender to send messages
    await delay(20000);

    await receiver.close();
    await sbClient.close();
}
// call the main function
main().catch((err) => {
    console.log("Error occurred: ", err);
    process.exit(1);
 });

将 <CONNECTION STRING TO SERVICE BUS NAMESPACE> 替换为服务总线命名空间的连接字符串。
将 <QUEUE NAME> 替换为该队列的名称。
然后，在命令提示符中运行该命令以执行此文件。
```
node receive.js
```

你会看到以下输出。

Received message: Albert Einstein
Received message: Werner Heisenberg
Received message: Marie Curie
Received message: Steven Hawking
Received message: Isaac Newton
Received message: Niels Bohr
Received message: Michael Faraday
Received message: Galileo Galilei
Received message: Johannes Kepler
Received message: Nikolaus Kopernikus

在 Azure 门户中的服务总线命名空间的“概述”页上，可看到传入和传出消息计数。可能需要等待一分钟左右，然后刷新页面才会看到最新值。

传入和传出消息计数

在此“概述”页上选择队列，导航到“服务总线队列”页面。还可在此页上看到传入和传出消息计数。还可看到其他信息，如队列的当前大小、最大大小和活动消息计数等。

队列详细信息

疑难解答

如果在运行 JavaScript 代码的无密码版本时收到以下错误之一，请确保通过 Azure CLI 命令 az login 登录，并将相应的角色应用到 Azure 用户帐户：

执行此操作需要“Send”声明
执行此操作需要“Receive”声明

清理资源

导航到 Azure 门户中的服务总线命名空间，然后在 Azure 门户上选择“删除”以删除命名空间及其中的队列。

后续步骤

请参阅以下文档和示例：

Compartir a través de

向 Azure 服务总线队列发送消息并从中接收消息 (JavaScript)

先决条件

在 Azure 门户中创建命名空间

在 Azure 门户中创建队列

向 Azure 验证应用

将角色分配给 Azure AD 用户

适用于 Azure 服务总线的 Azure 内置角色

将 Azure AD 用户添加到 Azure 服务总线所有者角色

获取连接字符串

使用 Node 包管理器 (NPM) 安装包

向队列发送消息

从队列接收消息

疑难解答

清理资源

后续步骤

Recursos adicionales