Inicio rápido: Publicación de mensajes mediante el SDK del servicio Azure Web PubSub

Azure Web PubSub le ayuda a administrar clientes de WebSocket. En este inicio rápido, se muestra cómo publicar mensajes en los clientes de WebSocket mediante el SDK del servicio Azure Web PubSub.

Requisitos previos

• Una suscripción de Azure; si no tiene una, cree una cuenta gratuita.
• Un shell de comandos de Bash y PowerShell. Los ejemplos de Python, Javascript y Java requieren un shell de comandos Bash.
• Un editor de archivos como VSCode.
• CLI de Azure: instalación de la CLI de Azure

Si crea el proyecto en un equipo local, deberá instalar las dependencias para el lenguaje que usa:

C#

Instale tanto el SDK de .NET  Core como el entorno de ejecución de aspnetcore y dotnet.

.NET Core

JavaScript

Node.js

Python

Python

Java

• Kit de desarrollo de Java (JDK)
• Apache Maven

1. Instalación

Para iniciar sesión en Azure desde la CLI, ejecute el siguiente comando y siga las indicaciones para completar el proceso de autenticación. Si usa Cloud Shell, no es necesario iniciar sesión.

az login

Asegúrese de que ejecuta la versión más reciente de la CLI con el comando de actualización.

az upgrade

A continuación, instale o actualice la extensión Azure Web PubSub para la CLI si no se instaló con az upgrade.

az extension add --name webpubsub --upgrade

1. Creación de un grupo de recursos

Establezca las siguientes variables de entorno. Reemplace el <marcador de posición> por un nombre único de Web PubSub.

Bash

RESOURCE_GROUP="webpubsub-resource-group"
LOCATION="EastUS"
WEB_PUBSUB_NAME="<your-unique-name>"

Azure PowerShell

$ResourceGroupName = 'webpubsub-resource-group'
$Location = 'EastUS'
$WebPubSubName = '<YourUniqueName>'

Cree un grupo de recursos para el proyecto Web PubSub.

Bash

az group create \
  --name $RESOURCE_GROUP \
  --location $LOCATION

Azure PowerShell

az group create --location $Location --name $ResourceGroupName

2. Creación de una instancia del servicio Web PubSub

Use el comando az webpubsub create para crear e implementar una instancia del servicio Web PubSub.

Bash

az webpubsub create \
  --name $WEB_PUBSUB_NAME \
  --resource-group $RESOURCE_GROUP \
  --location $LOCATION \
  --sku Free_F1

Azure PowerShell

az webpubsub create `
  --name $WebPubSubName `
  --location $Location `
  --resource-group $ResourceGroupName `
  --sku Free_F1

Guarde la cadena de conexión del servicio. El SDK del servicio usa la cadena de conexión para publicar mensajes.

Importante

En un entorno de producción, debe almacenar de forma segura cadenas de conexión mediante Azure Key Vault.

Bash

az webpubsub key show --name $WEB_PUBSUB_NAME --resource-group $RESOURCE_GROUP --query primaryConnectionString

Azure PowerShell

az webpubsub key show --name $WebPubSubName --resource-group $ResourceGroupName --query primaryConnectionString

3. Conexión de un cliente a la instancia del servicio

Cree un cliente Web PubSub. El cliente mantiene una conexión al servicio hasta que finaliza.

Use el comando az webpubsub client para iniciar una conexión del cliente de WebSocket al servicio. Los clientes siempre se conectan a un centro, por lo que debe proporcionar el nombre del centro al que se va a conectar el cliente.

Bash

az webpubsub client start \
  --name $WEB_PUBSUB_NAME \
  --resource-group $RESOURCE_GROUP \
  --hub-name "myHub1" \
  --user-id "user1"

Azure PowerShell

az webpubsub client start `
  --name $WebPubSubName `
  --resource-group $ResourceGroupName `
  --hub-name 'myHub1' `
  --user-id 'user1' 

La conexión con el servicio Web PubSub se establece cuando aparece un mensaje JSON que indica que el cliente se ha conectado correctamente, y se le asigna un connectionId único:

{"type":"system","event":"connected","userId":"user1","connectionId":"<your_unique_connection_id>"}

4. Publicación de mensajes mediante el SDK del servicio

Usará el SDK de Azure Web PubSub para publicar un mensaje en todos los clientes conectados al centro. Puede elegir entre C#, JavaScript, Python y Java. Las dependencias de cada lenguaje se instalan en los pasos para ese idioma. Python, JavaScript y Java requieren un shell de Bash para ejecutar los comandos en este inicio rápido.

Configuración del proyecto para publicar mensajes

1. Abra un nuevo shell de comandos para este proyecto.

2. Guarde la cadena de conexión desde el shell de cliente. Reemplace el marcador de posición <your_connection_string> por la cadena de conexión que ha mostrado en un paso anterior.

   Bash

   connection_string="<your_connection_string>"
   

   Azure PowerShell

   $connection_string = "<your_connection_string>"
   

3. Ahora, seleccione el lenguaje del proyecto.

C#

1. Agregue un nuevo proyecto llamado publisher y el paquete del SDK Azure.Messaging.WebPubSub.

   mkdir publisher
   cd publisher
   dotnet new console
   dotnet add package Azure.Messaging.WebPubSub
   

2. Actualice el archivo Program.cs para que use la clase WebPubSubServiceClient para enviar mensajes a los clientes. Reemplace el código del archivo Program.cs por el código siguiente.

   using System;
   using System.Threading.Tasks;
   using Azure.Messaging.WebPubSub;
   
   namespace publisher
   {
       class Program
       {
           static async Task Main(string[] args)
           {
               if (args.Length != 3) {
                   Console.WriteLine("Usage: publisher <connectionString> <hub> <message>");
                   return;
               }
               var connectionString = args[0];
               var hub = args[1];
               var message = args[2];
   
               var service = new WebPubSubServiceClient(connectionString, hub);
   
               // Send messages to all the connected clients
               // You can also try SendToConnectionAsync to send messages to the specific connection
               await service.SendToAllAsync(message);
           }
       }
   }
   

   La llamada service.SendToAllAsync() simplemente envía un mensaje a todos los clientes conectados en el centro.

3. Ejecute el siguiente comando para publicar un mensaje en el servicio.

   dotnet run $connection_string "myHub1" "Hello World"
   

4. El shell de comandos anterior que contiene el cliente de Web PubSub muestra el mensaje recibido.

   {"type":"message","from":"server","dataType":"text","data":"Hello World"}
   

JavaScript

1. Cree una nueva carpeta llamada publisher para este proyecto e instale las dependencias necesarias:

   mkdir publisher
   cd publisher
   npm init -y
   npm install --save @azure/web-pubsub
   

2. Use el SDK de Azure Web PubSub para publicar un mensaje en el servicio. Cree un archivo publish.js que contenga el código:

   const { WebPubSubServiceClient } = require('@azure/web-pubsub');
   
   if (process.argv.length !== 3) {
     console.log('Usage: node publish <message>');
     return 1;
   }
   const hub = "myHub1";
   let service = new WebPubSubServiceClient(process.env.WebPubSubConnectionString, hub);
   // by default it uses `application/json`, specify contentType as `text/plain` if you want plain-text
   service.sendToAll(process.argv[2], { contentType: "text/plain" });
   

   La llamada sendToAll() simplemente envía un mensaje a todos los clientes conectados en un centro.

3. Ejecute el siguiente comando para publicar un mensaje en el servicio:

   export WebPubSubConnectionString=$connection_string
   node publish "Hello World"
   

4. El shell de comandos anterior que contiene el cliente de Web PubSub muestra el mensaje recibido.

   {"type":"message","from":"server","dataType":"text","data":"Hello World"}
   

Python

1. Cree una nueva carpeta llamada publisher para este proyecto e instale las dependencias necesarias:

   mkdir publisher
   cd publisher
   # Create venv
   python -m venv env
   # Active venv
   source ./env/bin/activate
   pip install azure-messaging-webpubsubservice
   

2. Use el SDK de Azure Web PubSub para publicar un mensaje en el servicio. Cree un archivo publish.py con el código siguiente:

   import sys
   from azure.messaging.webpubsubservice import WebPubSubServiceClient
   
   if __name__ == '__main__':
   
       if len(sys.argv) != 4:
           print('Usage: python publish.py <connection-string> <hub-name> <message>')
           exit(1)
   
       connection_string = sys.argv[1]
       hub_name = sys.argv[2]
       message = sys.argv[3]
   
       service = WebPubSubServiceClient.from_connection_string(connection_string, hub=hub_name)
       res = service.send_to_all(message, content_type='text/plain')
       print(res)
   

   El método service.send_to_all() envía un mensaje a todos los clientes conectados en un centro de conectividad.

3. Ejecute el siguiente comando para publicar un mensaje en el servicio:

   python publish.py $connection_string "myHub1" "Hello World"
   

4. El shell de comandos anterior que contiene el cliente de Web PubSub muestra el mensaje recibido.

   {"type":"message","from":"server","dataType":"text","data":"Hello World"}
   

Java

1. Use Maven para crear una nueva aplicación de consola denominada webpubsub-quickstart-publisher y vaya al directorio webpubsub-quickstart-publisher:

   mvn archetype:generate --define interactiveMode=n --define groupId=com.webpubsub.quickstart --define artifactId=webpubsub-quickstart-publisher --define archetypeArtifactId=maven-archetype-quickstart --define archetypeVersion=1.4
   cd webpubsub-quickstart-publisher
   

2. Agregue el SDK Azure Web PubSub al nodo dependencies de pom.xml:

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-messaging-webpubsub</artifactId>
       <version>1.0.0</version>
   </dependency>
   

3. Vaya al directorio src/main/java/com/webpubsub/quickstart.

4. Reemplace el contenido del archivo App.java por el código siguiente:

   package com.webpubsub.quickstart;
   
   import com.azure.messaging.webpubsub.*;
   import com.azure.messaging.webpubsub.models.*;
   
   /**
   * Publish messages using Azure Web PubSub service SDK
   *
   */
   public class App 
   {
       public static void main( String[] args )
       {
           if (args.length != 3) {
               System.out.println("Expecting 3 arguments: <connection-string> <hub-name> <message>");
               return;
           }
   
           WebPubSubServiceClient service = new WebPubSubServiceClientBuilder()
               .connectionString(args[0])
               .hub(args[1])
               .buildClient();
           service.sendToAll(args[2], WebPubSubContentType.TEXT_PLAIN);
       }
   }
   
   

   Este código usa el SDK de Azure Web PubSub para publicar un mensaje en el servicio. La llamada service.sendToAll() envía un mensaje a todos los clientes conectados en un centro.

5. Navegue hasta el directorio webpubsub-quickstart-publisher que contiene el archivo pom.xml y compile el proyecto mediante el siguiente comando mvn.

   mvn compile
   

6. Compilar el paquete.

   mvn package
   

7. Ejecute el siguiente comando mvn para ejecutar la aplicación para publicar un mensaje en el servicio:

   mvn exec:java -Dexec.mainClass="com.webpubsub.quickstart.App" -Dexec.cleanupDaemonThreads=false -Dexec.args=" '$connection_string' 'myHub1' 'Hello World'"
   

8. El shell de comandos anterior que contiene el cliente de Web PubSub muestra el mensaje recibido.

   {"type":"message","from":"server","dataType":"text","data":"Hello World"}
   

Limpieza

Puede eliminar los recursos que creó en este inicio rápido eliminando el grupo de recursos que los contiene.

Bash

az group delete --name $RESOURCE_GROUP --yes

Azure PowerShell

d

az group delete --name $ResourceGroup --yes

Pasos siguientes

En este inicio rápido, se proporciona una idea básica de cómo conectarse al servicio Web PubSub y cómo publicar mensajes en los clientes conectados.

En las aplicaciones del mundo real, puede usar SDK en varios lenguajes para crear su propia aplicación. También proporcionamos extensiones de función para que pueda crear aplicaciones sin servidor fácilmente.

Use estos recursos para empezar a compilar su propia aplicación:

Tutorial: Publicación y suscripción de mensajes en Azure Web PubSub

Tutorial: Creación de una sala de chat simple con Azure Web PubSub

Tutorial: Uso de un subprotocolo compatible con el servicio para streaming de clientes

Tutorial: Creación de chat sin servidor con Azure Functions y Web PubSub

Tutorial: Configuración de un cliente de escucha de eventos

Reproducción con demostraciones dinámicas

Explore más ejemplos de Azure Web PubSub.