Envío de mensajes a las colas de Azure Service Bus (JavaScript) y recepción desde allí

Artículo
12/08/2023

En este tutorial, va a completar los siguientes pasos:

Creación de un espacio de nombres de Service Bus mediante Azure Portal
Creación de una cola de Service Bus mediante Azure Portal.
Escriba una aplicación de JavaScript para usar el paquete @azure/service-bus para:
1. Enviar un conjunto de mensajes a la cola.
2. Recibir esos mensajes de la cola.

Nota

En este inicio rápido se proporcionan instrucciones paso a paso para un escenario sencillo de envío de mensajes a una cola de Service Bus y la recepción de estos. Puede encontrar ejemplos pregenerados de JavaScript y TypeScript para Azure Service Bus en el repositorio del SDK de Azure para JavaScript en GitHub.

Requisitos previos

Si no está familiarizado con el servicio, consulte la información general sobre Service Bus antes de seguir este artículo de inicio rápido.

Suscripción a Azure. Para completar este tutorial, deberá tener una cuenta de Azure. Puede activar sus ventajas de suscriptor a MSDN o registrarse para obtener una cuenta gratuita.
LTS de Node.js

Inicio de sesión sin contraseña
Cadena de conexión

Para usar este inicio rápido con su propia cuenta de Azure, debe hacer lo siguiente:

Instale la CLI de Azure, que proporciona la autenticación sin contraseña en la máquina del desarrollador.
Iniciar sesión con su cuenta de Azure en el terminal o en el símbolo del sistema con az login.
Usar la misma cuenta al agregar el rol de datos adecuado al recurso.
Ejecutar el código en el mismo terminal o símbolo del sistema.
Anote el nombre de la cola del espacio de nombres de Service Bus. Lo necesitará en el código.

Nota

En este tutorial se trabaja con ejemplos que puede copiar y ejecutar con Nodejs. Para obtener instrucciones acerca de cómo crear una aplicación de Node.js, consulte Creación e implementación de una aplicación Node.js en un sitio web de Azure o Servicio en la nube Node.js (con Windows PowerShell).

Creación de un espacio de nombres en Azure Portal

Para empezar a usar entidades de mensajería de Service Bus en Azure, primero hay que crear un espacio de nombres con un nombre que sea único en Azure. Un espacio de nombres proporciona un contenedor de ámbito para los recursos de Service Bus (colas, temas, etc.) que están dentro de la aplicación.

Para crear un espacio de nombres:

Inicie sesión en Azure Portal.
Vaya a la página Todos los servicios.
En la barra de navegación izquierda, seleccione Integration en la lista de categorías, mantenga el mouse sobre Service Bus, y a continuación, seleccione el botón + en el mosaico de Service Bus.
En la pestaña Datos básicos de la página Crear espacio de nombres, siga estos pasos:
1. En Suscripción, elija la suscripción de Azure en la que se va a crear el espacio de nombres.
2. Para Grupo de recursos, elija un grupo de recursos existente o cree uno nuevo.
3. Escriba nombre para el espacio de nombres. El nombre del espacio de nombres debe cumplir las siguientes convenciones de nomenclatura:
  - El nombre debe ser único en Azure. El sistema realiza la comprobación automáticamente para ver si el nombre está disponible.
  - La longitud del nombre es de 6 caracteres como mínimo y 50 como máximo.
  - El nombre solo puede contener letras, números y guiones -.
  - El nombre debe comenzar con una letra y terminar con una letra o un número.
  - El nombre no termina con -sb ni -mgmt.
4. En Ubicación, elija la región donde se debe hospedar el espacio de nombres.
5. En Plan de tarifa, seleccione el plan de tarifa (Básico, Estándar o Prémium) del espacio de nombres. Para este inicio rápido, seleccione Estándar.
6. Si selecciona nivel Premium, seleccione si puede habilitar la replicación geográfica para el espacio de nombres. La característica Replicación geográfica garantiza que los metadatos y los datos de un espacio de nombres se repliquen continuamente desde una región primaria a una o varias regiones secundarias.
  
  Importante
  
  Si desea usar temas y suscripciones, elija Estándar o Premium. El plan de tarifas Básico no admite temas o suscripciones.
  
  Si ha seleccionado el plan de tarifa Prémium, especifique el número de unidades de mensajería. El plan Premium proporciona aislamiento de recursos en el nivel de CPU y memoria para que cada carga de trabajo se ejecute de forma aislada. Este contenedor de recursos se llama unidad de mensajería. A cada espacio de nombres prémium se le asigna al menos una unidad de mensajería. Puede seleccionar 1, 2, 4, 8 o 16 unidades de mensajería para cada espacio de nombres prémium de Service Bus. Para más información, consulte Mensajería prémium de Service Bus.
7. En la parte inferior de la página, seleccione Revisar y crear.
8. En la página Revisar y crear, examine la configuración y seleccione Crear.
Una vez que la implementación del recurso sea correcta, seleccione Ir al recurso en la página de implementación.
Verá la página principal del espacio de nombres de Service Bus.

Creación de colas en Azure Portal

En la página Espacio de nombres de Service Bus, expanda Entidades en el menú de navegación a la izquierda y seleccione Colas.
En la página Colas, seleccione + Cola en la barra de herramientas.
Escriba un nombre para la cola y deje los restantes valores con sus valores predeterminados.
Ahora, seleccione Crear.

Autenticación de la aplicación en Azure

En este inicio rápido, se muestran dos maneras de conectarse a Azure Service Bus: sin contraseña y con la cadena de conexión.

La primera opción muestra cómo usar la entidad de seguridad en Microsoft Entra ID y el control de acceso basado en rol (RBAC) para conectarse a un espacio de nombres de Service Bus. No es necesario preocuparse por tener una cadena de conexión codificada de forma rígida en el código, en un archivo de configuración o en un almacenamiento seguro, como Azure Key Vault.

La segunda opción muestra cómo usar una cadena de conexión para conectarse a un espacio de nombres de Service Bus. Si no está familiarizado con Azure, puede que le resulte más fácil la opción de la cadena de conexión. Se recomienda usar la opción sin contraseña en aplicaciones reales y entornos de producción. Para más información, consulte Autenticación y autorización. También puede obtener más información sobre la autenticación sin contraseña en la página de información general.

Sin contraseña (recomendado)
Cadena de conexión

Asignación de roles al usuario de Microsoft Entra

Al desarrollar localmente, asegúrese de que la cuenta de usuario que se conecta a Azure Service Bus tenga los permisos correctos. Necesitará el rol propietario de datos Azure Service Bus para enviar y recibir mensajes. Para asignarse este rol, necesitará el rol Administrador de accesos de usuarios, u otro que incluya la acción Microsoft.Authorization/roleAssignments/write. Puede asignar roles RBAC de Azure a un usuario mediante Azure Portal, la CLI de Azure o Azure PowerShell. Puede obtener más información sobre los ámbitos disponibles para las asignaciones de roles en la página de información general del ámbito.

En el ejemplo siguiente se asigna el rol Azure Service Bus Data Owner a la cuenta de usuario, que proporciona un acceso completo a los recursos de Azure Service Bus. En un escenario real, siga el Principio de privilegios mínimos para conceder a los usuarios solo los permisos mínimos necesarios para un entorno de producción más seguro.

Roles integrados de Azure para Azure Service Bus

En el caso de Azure Service Bus, la administración de los espacios de nombres y de todos los recursos relacionados mediante Azure Portal y la API de administración de recursos de Azure, ya se ha protegido mediante el modelo de Azure RBAC. Azure proporciona los siguientes roles integrados de Azure para autorizar el acceso a un espacio de nombres de Service Bus:

Propietario de datos de Azure Service Bus: permite el acceso a datos en el espacio de nombres de Service Bus y sus entidades (colas, temas, suscripciones y filtros). Un miembro de este rol puede enviar y recibir mensajes de colas o temas y suscripciones.
Emisor de datos de Azure Service Bus: use este rol para proporcionar acceso de envío a un espacio de nombres de Service Bus y sus entidades.
Receptor de datos de Azure Service Bus: use este rol para proporcionar acceso de recepción a un espacio de nombres de Service Bus y sus entidades.

Si desea crear un rol personalizado, consulte Derechos necesarios para las operaciones de Service Bus.

Incorporación de un usuario de Microsoft Entra al rol Propietario de Azure Service Bus

Asigne el rol Propietario de datos de Azure Service Bus al nombre de usuario de Microsoft Entra en el nivel de espacio de nombres de Service Bus. Permitirá que una aplicación que se ejecuta en el contexto de la cuenta de usuario envíe mensajes a una cola o tema y reciba mensajes de la suscripción de una cola o tema.

Importante

En la mayoría de los casos, la asignación de roles tardará un minuto o dos en propagarse en Azure. En ocasiones excepcionales, puede tardar hasta ocho minutos. Si recibe errores de autenticación al ejecutar por primera vez el código, espere unos instantes e inténtelo de nuevo.

Si no tiene abierta la página Espacio de nombres de Service Bus en Azure-Portal, busque el espacio de nombres de Service Bus mediante la barra de búsqueda principal o el panel de navegación izquierdo.
En la página de información general, seleccione Control de acceso (IAM) en el menú de la izquierda.
En la página Control de acceso (IAM), seleccione la pestaña Asignación de roles.
Seleccione + Agregar en el menú superior y, a continuación, Agregar asignación de roles en el menú desplegable resultante.
Puede usar el cuadro de búsqueda para filtrar los resultados por el rol deseado. En este ejemplo, busque Azure Service Bus Data Owner y seleccione el resultado coincidente. Después, haga clic en Siguiente.
En la pestaña Asignar acceso a, seleccione Usuario, grupo o entidad de servicio y, a continuación, elija + Seleccionar miembros.
En el cuadro de diálogo, busque el nombre de usuario de Microsoft Entra (normalmente su dirección de correo electrónico de user@domain) y, a continuación, elija Seleccionar en la parte inferior del cuadro de diálogo.
Seleccione Revisar y asignar para ir a la página final y, a continuación, de nuevo Revisar y asignar para completar el proceso.

Uso del Administrador de paquetes para Node (NPM) para instalar el paquete

Inicio de sesión sin contraseña
Cadena de conexión

Para instalar los paquetes de npm necesarios para Service Bus, abra un símbolo del sistema que tenga npm en la ruta de acceso, cambie el directorio a la carpeta en la que quiere colocar los ejemplos y ejecute este comando.

Instale los siguientes paquetes:

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

Para instalar los paquetes de npm necesarios para Service Bus, abra un símbolo del sistema que tenga npm en la ruta de acceso, cambie el directorio a la carpeta en la que quiere colocar los ejemplos y ejecute este comando.
Instale el siguiente paquete:
```
npm install @azure/service-bus
```

mensajes a una cola

El código de ejemplo siguiente muestra cómo enviar un mensaje a una cola.

Inicio de sesión sin contraseña
Cadena de conexión

Debe haber iniciado sesión con el comando az login de la CLI de Azure para que la máquina local proporcione la autenticación sin contraseña necesaria en este código.

Abra el editor que prefiera, como Visual Studio Code.

Cree un archivo denominado send.js y pegue en él el código siguiente. Este código envía los nombres de los científicos como mensajes a la cola.

Importante

La credencial sin contraseña se proporciona con 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();

// 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);
    });

Reemplace <SERVICE-BUS-NAMESPACE> por el espacio de nombres de Service Bus.
Reemplace <QUEUE NAME> por el nombre de la cola.
Después, ejecute el comando en un símbolo del sistema para ejecutar este archivo.
```
node send.js
```

Debería ver la siguiente salida.

Sent a batch of messages to the queue: myqueue

Abra el editor que prefiera, como Visual Studio Code.

Cree un archivo denominado send.js y pegue en él el código siguiente. Este código envía los nombres de los científicos como mensajes a la cola.

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);
 });

Reemplace <CONNECTION STRING TO SERVICE BUS NAMESPACE> por la cadena de conexión del espacio de nombres de Service Bus.
Reemplace <QUEUE NAME> por el nombre de la cola.
Después, ejecute el comando en un símbolo del sistema para ejecutar este archivo.
```
node send.js
```

Debería ver la siguiente salida.

Sent a batch of messages to the queue: myqueue

Debe haber iniciado sesión con el comando az login de la CLI de Azure para que la máquina local proporcione la autenticación sin contraseña necesaria en este código.

Abra el editor que prefiera, como Visual Studio Code

Cree un archivo denominado receive.js y pegue en él el código siguiente.

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

// 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);
 });

Reemplace <SERVICE-BUS-NAMESPACE> por el espacio de nombres de Service Bus.
Reemplace <QUEUE NAME> por el nombre de la cola.
Después, ejecute el comando en un símbolo del sistema para ejecutar este archivo.
```
node receive.js
```

Abra el editor que prefiera, como Visual Studio Code

Cree un archivo denominado receive.js y pegue en él el código siguiente.

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);
 });

Reemplace <CONNECTION STRING TO SERVICE BUS NAMESPACE> por la cadena de conexión del espacio de nombres de Service Bus.
Reemplace <QUEUE NAME> por el nombre de la cola.
Después, ejecute el comando en un símbolo del sistema para ejecutar este archivo.
```
node receive.js
```

Debería ver la siguiente salida.

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

En la página Información general del espacio de nombres de Service Bus en Azure Portal, verá el recuento de mensajes entrantes y salientes. Es posible que tenga que esperar alrededor de un minuto y luego actualizar la página para ver los valores más recientes.

Recuento de mensajes entrantes y salientes

Seleccione la cola en esta página Información general para ir a la página Cola de Service Bus. En esta página también verá el recuento de mensajes entrantes y salientes. También verá otra información, como el tamaño actual de la cola, el tamaño máximo o el recuento de mensajes activos.

Detalles de la cola

Solución de problemas

Si recibe uno de los siguientes errores al ejecutar la versión sin contraseña del código JavaScript, asegúrese de que ha iniciado sesión mediante el comando az login de la CLI de Azure y que el rol adecuado se aplica a la cuenta de usuario de Azure:

Se requieren notificaciones de envío para realizar esta operación.
Se requieren notificaciones de recepción para realizar esta operación.

Limpieza de recursos

Vaya al espacio de nombres de Service Bus en Azure Portal y seleccione Eliminar para eliminar el espacio de nombres y la cola que hay en él.

Pasos siguientes

Consulte la documentación y los ejemplos siguientes:

Compartir vía

Envío de mensajes a las colas de Azure Service Bus (JavaScript) y recepción desde allí

Requisitos previos

Creación de un espacio de nombres en Azure Portal

Creación de colas en Azure Portal

Autenticación de la aplicación en Azure

Asignación de roles al usuario de Microsoft Entra

Roles integrados de Azure para Azure Service Bus

Incorporación de un usuario de Microsoft Entra al rol Propietario de Azure Service Bus

Obtención de la cadena de conexión

Uso del Administrador de paquetes para Node (NPM) para instalar el paquete

mensajes a una cola

mensajes de una cola

Solución de problemas

Limpieza de recursos

Pasos siguientes

Comentarios

Recursos adicionales