Отправка сообщений в раздел Служебной шины Azure и получение сообщений из подписок в раздел (JavaScript)

Статья
12/08/2023

В этом руководстве выполняются следующие шаги:

Создание пространства имен служебной шины с помощью портала Azure.
Создание раздела служебной шины с помощью портала Azure.
Создание подписки на этот раздел служебной шины с помощью портала Azure.
Напишите приложение JavaScript для использования пакета @azure/служебной шины :
- Отправьте в раздел набор сообщений.
- Получение этих сообщений из подписки.

Примечание.

Это краткое руководство содержит пошаговые инструкции для простого сценария отправки пакета сообщений в раздел Служебной шины и получения этих сообщений из подписки раздела. Готовые примеры JavaScript и TypeScript для Служебной шины Azure находятся в репозитории пакета SDK Azure для JavaScript на GitHub.

Необходимые компоненты

Подписка Azure. Для работы с этим учебником требуется учетная запись Azure. Вы можете активировать преимущества подписчика MSDN или зарегистрироваться для получения бесплатной учетной записи.
LTS Node.js
Выполните действия, описанные в кратком руководстве. Используйте портал Azure для создания раздела служебная шина и подписок в этом разделе. При работе с этим кратким руководством вы будете использовать только одну подписку.

Без пароля
Строка соединения

Чтобы использовать это краткое руководство с собственной учетной записью Azure, вам потребуется:

Установите Azure CLI, которая обеспечивает проверку подлинности без пароля на компьютере разработчика.
Войдите с помощью учетной записи Azure в терминале или командной строке az login.
Используйте ту же учетную запись при добавлении соответствующей роли в ресурс.
Запустите код в том же терминале или командной строке.
Запишите имя раздела и подписку для пространства имен служебная шина. Вам потребуется это в коде.

Примечание.

Примеры для этого учебника вы можете скопировать и запустить с помощью Nodejs. Указания по созданию приложения Node.js можно найти в статьях Создание веб-приложений Node.js в Azure или Build and deploy a Node.js application to an Azure Cloud Service (Построение и развертывание приложения Node.js в облачной службе Azure).

Создание пространства имен на портале Azure

Чтобы приступить к использованию сущностей обмена сообщениями в служебной шине в Azure, сначала необходимо создать пространство имен с уникальным для Azure именем. Пространство имен предоставляет контейнер области для служебная шина ресурсов (очередей, тем и т. д.) в приложении.

Создание пространства имен службы:

Войдите на портал Azure.
Перейдите на страницу "Все службы".
На панели навигации слева выберите "Интеграция" из списка категорий, наведите указатель мыши на служебная шина, а затем нажмите + кнопку на плитке служебная шина.
В теге Основные сведения на странице Создание пространства имен выполните следующие действия:
1. Выберите подписку Azure, в которой будет создано пространство имен.
2. Выберите существующую группу ресурсов, в которую будет включено это пространство имен, или создайте новую.
3. Введите имя для пространства имен. В имени пространства имен должны соблюдаться следующие соглашения об именовании:
  - Это имя должно быть уникальным в пределах Azure. Система немедленно проверяет, доступно ли оно.
  - Длина имени составляет не менее 6 и не более 50 символов.
  - Имя может содержать только буквы, цифры и дефисы (-).
  - Имя должно начинаться с буквы или цифры и заканчиваться буквой или цифрой.
  - Имя не должно оканчиваться на -sb или -mgmt.
4. Укажите расположение — регион для размещения пространства имен.
5. Для параметра Ценовая категория выберите ценовую категорию ("Базовый", "Стандартный" или "Премиум") для пространства имен. Для работы с этим кратким руководством выберите вариант Стандартный.
  
  Внимание
  
  Чтобы использовать разделы и подписки, выберите категорию "Стандартный" или "Премиум". Разделы и подписки не поддерживаются в ценовой категории "Базовый".
  
  Если выбрана ценовая категория Премиум, укажите число единиц обмена сообщениями. В категории "Премиум" обеспечивается изоляция ресурсов на уровне ЦП и памяти, так что рабочая нагрузка выполняется изолированно от других. Контейнер ресурса называется единицей обмена сообщениями. Пространству имен ценовой категории "Премиум" выделяется по крайней мере одна единица обмена сообщениями. Для каждого пространства имен служебной шины Premium можно выбрать 1, 2, 4, 8 или 16 единиц обмена сообщениями. Дополнительные сведения см. в статье Уровни обмена сообщениями через служебную шину Premium и Standard.
6. В нижней части страницы выберите Review + create (Проверить и создать).
7. На странице Проверить и создать проверьте параметры и нажмите кнопку Создать.
После успешного развертывания ресурса выберите "Перейти к ресурсу " на странице развертывания.
Вы увидите домашнюю страницу пространства имен служебной шины.

Создание раздела с помощью портала Azure

На странице Пространство имен служебной шины выберите пункт Разделы в левом меню.
На панели инструментов выберите + Раздел.
Введите имя раздела. Для других параметров оставьте значения по умолчанию.
Нажмите кнопку создания.

Создание подписки на раздел

Выберите раздел, который был создан в предыдущем разделе.
На странице Раздел Служебной шины выберите + Подписка на панели инструментов.
На странице Создать подписку выполните следующие действия:
1. Введите S1 в качестве имени подписки.
2. Задайте для параметра Максимальное число доставок значение 3.
3. Выберите Создать, чтобы создать подписку.

Проверка подлинности приложения в Azure

В этом кратком руководстве показано два способа подключения к Служебная шина Azure: без пароля и строка подключения.

Первый вариант показывает, как использовать субъект безопасности в идентификаторе Microsoft Entra ID и управлении доступом на основе ролей (RBAC) для подключения к пространству имен служебная шина. Вам не нужно беспокоиться о наличии жестко закодированных строка подключения в коде или в файле конфигурации или в безопасном хранилище, например Azure Key Vault.

Второй вариант показывает, как использовать строка подключения для подключения к пространству имен служебная шина. Если вы не знакомы с Azure, вы можете найти вариант строка подключения проще следовать. Мы рекомендуем использовать параметр без пароля в реальных приложениях и рабочих средах. Дополнительные сведения см. в разделе "Проверка подлинности и авторизация". Дополнительные сведения о проверке подлинности без пароля см. на странице обзора.

Без пароля (рекомендуется)
Строка подключения

Назначение ролей пользователю Microsoft Entra

При локальной разработке убедитесь, что учетная запись пользователя, которая подключается к Служебная шина Azure имеет правильные разрешения. Для отправки и получения сообщений вам потребуется роль владельца данных Служебная шина Azure. Чтобы назначить себе эту роль, вам потребуется роль Администратор istrator пользователя или другую роль, которая включает Microsoft.Authorization/roleAssignments/write действие. Роли Azure RBAC можно назначить пользователю с помощью портала Azure, Azure CLI или Azure PowerShell. Узнайте больше о доступных область для назначений ролей на странице обзора область.

В следующем примере роль назначается Azure Service Bus Data Owner учетной записи пользователя, которая предоставляет полный доступ к ресурсам Служебная шина Azure. В реальном сценарии следуйте принципу наименьших привилегий , чтобы предоставить пользователям только минимальные разрешения, необходимые для более безопасной рабочей среды.

Встроенные роли Azure для служебной шины Azure

Для служебной шины Azure управление пространствами имен и всеми связанными ресурсами через портал Azure и API управления ресурсами Azure уже защищено с помощью модели Azure RBAC. Azure предоставляет следующие встроенные роли Azure для авторизации доступа к пространству имен служебной шины:

Служебная шина Azure Владелец данных: включает доступ к пространству имен служебная шина и его сущностям (очереди, разделы, подписки и фильтры). Участник этой роли может отправлять и получать сообщения из очередей или разделов или подписок.
Служебная шина Azure Отправителю данных: используйте эту роль, чтобы предоставить доступ к пространству имен служебная шина и его сущностям.
Служебная шина Azure приемник данных: используйте эту роль, чтобы предоставить доступ к пространству имен служебная шина и его сущностям.

Если вы хотите создать пользовательскую роль, см. раздел "Права", необходимые для операций служебная шина.

Добавление пользователя Microsoft Entra в роль владельца Служебная шина Azure

Добавьте имя пользователя Microsoft Entra в роль владельца данных Служебная шина Azure на уровне пространства имен служебная шина. Это позволит приложению, работающему в контексте учетной записи пользователя, отправлять сообщения в очередь или раздел, а также получать сообщения из очереди или подписки раздела.

Внимание

В большинстве случаев для распространения назначения ролей в Azure потребуется несколько минут. В редких случаях может потребоваться до восьми минут. Если при первом запуске кода возникают ошибки аутентификации, подождите несколько минут и повторите попытку.

Если в портал Azure нет страницы пространства имен служебная шина, найдите пространство имен служебная шина с помощью главной панели поиска или навигации слева.
На странице обзора выберите элемент управления доступом (IAM) в меню слева.
На странице Контроль доступа (IAM) откройте вкладку Назначения ролей.
Выберите + Добавить в верхнем меню, а затем выберите Добавить назначение роли в появившемся раскрывающемся меню.
Используйте поле поиска, чтобы отфильтровать результаты для отображения нужной роли. В этом примере найдите Azure Service Bus Data Owner и выберите соответствующий результат. Теперь щелкните Далее.
В разделе Назначение доступа для выберите Пользователь, группа или субъект-служба и + Выбрать членов.
В диалоговом окне найдите имя пользователя Microsoft Entra (обычно ваш user@domain адрес электронной почты), а затем выберите в нижней части диалогового окна.
Нажмите кнопку Проверить и назначить, чтобы перейти на последнюю страницу, а затем еще раз Проверить и назначить, чтобы завершить процесс.

Использование диспетчера пакета Node (NPM) для установки пакета

Без пароля
Строка соединения

Чтобы установить необходимые пакеты npm для служебная шина, откройте командную строку, которая имеет npm свой путь, измените каталог на папку, в которой вы хотите получить примеры, а затем выполните эту команду.
Установите следующие пакеты:
```
npm install @azure/service-bus @azure/identity
```

Чтобы установить необходимые пакеты npm для служебная шина, откройте командную строку, которая имеет npm свой путь, измените каталог на папку, в которой вы хотите получить примеры, а затем выполните эту команду.
Установите следующий пакет:
```
npm install @azure/service-bus
```

Отправка сообщений в раздел

В следующем примере кода показано, как отправить пакет сообщений в раздел служебной шины. Дополнительные сведения см. в комментариях к коду.

Без пароля
Строка соединения

Для обеспечения проверки подлинности без пароля, необходимо выполнить вход с помощью Azure CLI az login для локального компьютера.

Откройте редактор, например Visual Studio Code.

Создайте файл с именем sendtotopic.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.windows.net";

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

const topicName = "<TOPIC 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 queue.
    const sender = sbClient.createSender(topicName);

    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 topic
        await sender.sendMessages(batch);

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

        // 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 CONNECTION STRING> строкой подключения к пространству имен Служебной шины.
Затем замените <TOPIC NAME> именем раздела.
Затем в окне командной строки выполните команду, которая запускает этот файл.
```
node sendtotopic.js
```
Вы должны увидеть следующие выходные данные.
```
Sent a batch of messages to the topic: mytopic
```

Откройте редактор, например Visual Studio Code.

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

const connectionString = "<SERVICE BUS NAMESPACE CONNECTION STRING>"
const topicName = "<TOPIC 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 queue.
    const sender = sbClient.createSender(topicName);

    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 topic
        await sender.sendMessages(batch);

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

        // 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 CONNECTION STRING> строкой подключения к пространству имен Служебной шины.
Затем замените <TOPIC NAME> именем раздела.
Затем в окне командной строки выполните команду, которая запускает этот файл.
```
node sendtotopic.js
```
Вы должны увидеть следующие выходные данные.
```
Sent a batch of messages to the topic: mytopic
```

Откройте редактор, например Visual Studio Code.

Создайте файл с именем receivefromsubscription.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.windows.net";

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

const topicName = "<TOPIC NAME>";
const subscriptionName = "<SUBSCRIPTION 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 queue.
    const receiver = sbClient.createReceiver(topicName, subscriptionName);

    // 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(5000);

    await receiver.close();
    await sbClient.close();
}

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

Замените <SERVICE BUS NAMESPACE CONNECTION STRING> строкой подключения к пространству имен.
Затем замените <TOPIC NAME> именем раздела.
Замените <SUBSCRIPTION NAME> именем подписки на раздел.
Затем в окне командной строки выполните команду, которая запускает этот файл.
```
node receivefromsubscription.js
```

Откройте редактор, например Visual Studio Code.

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

const connectionString = "<SERVICE BUS NAMESPACE CONNECTION STRING>"
const topicName = "<TOPIC NAME>";
const subscriptionName = "<SUBSCRIPTION 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 queue.
    const receiver = sbClient.createReceiver(topicName, subscriptionName);

    // 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(5000);

    await receiver.close();
    await sbClient.close();
}

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

Замените <SERVICE BUS NAMESPACE CONNECTION STRING> строкой подключения к пространству имен.
Затем замените <TOPIC NAME> именем раздела.
Замените <SUBSCRIPTION NAME> именем подписки на раздел.
Затем в окне командной строки выполните команду, которая запускает этот файл.
```
node receivefromsubscription.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, выберите элемент Разделы в нижней области, а затем выберите свой раздел, чтобы просмотреть страницу для него страницу Раздел служебной шины. На этой странице вы увидите 10 входящих и 10 исходящих сообщений на диаграмме Сообщения.

Incoming and outgoing messages

Если в следующий раз запустить только приложение отправки, на странице Раздел служебной шины вы увидите 20 входящих сообщений (из них 10 новых),но только 10 исходящих.

Updated topic page

При выборе подписки в нижней части этой страницы вы будете перенаправлены на страницу Подписка служебной шины. Также на этой странице можно увидеть количество активных и недоставленных сообщений и многое другое. Из этого примера видно, что получатель еще не получил 10 активных сообщений.

Active message count

Устранение неполадок

Если при запуске без пароля версии кода JavaScript о необходимых утверждениях возникает ошибка, убедитесь, что вы выполнили вход с помощью команды Azure CLI, az login а соответствующая роль применяется к учетной записи пользователя Azure.

Очистка ресурсов

Перейдите к пространству имен служебная шина в портал Azure и выберите "Удалить" в портал Azure, чтобы удалить пространство имен и очередь в ней.

Следующие шаги

Ознакомьтесь со следующими примерами и документацией: