Início Rápido: Publicar mensagens com o SDK do serviço PubSub web do Azure

O Azure Web PubSub ajuda-o a gerir clientes WebSocket. Este início rápido mostra-lhe como publicar mensagens em clientes WebSocket com o SDK do serviço Azure Web PubSub.

Pré-requisitos

• Uma subscrição do Azure, se não tiver uma, crie uma conta gratuita.
• uma shell de comandos do Bash e do PowerShell. Os exemplos de Python, JavaScript e Java requerem uma shell de comandos do Bash.
• Um editor de ficheiros, como o VSCode.
• CLI do Azure: instalar a CLI do Azure

Se criar o projeto num computador local, terá de instalar as dependências do idioma que está a utilizar:

C#

Instale o SDK .NET Core e o runtime e dotnet aspnetcore .

.NET Core

JavaScript

Node.js

Python

Python

Java

• Java Development Kit (JDK)
• Apache Maven

1. Configuração

Para iniciar sessão no Azure a partir da CLI, execute o seguinte comando e siga as instruções para concluir o processo de autenticação. Se estiver a utilizar Cloud Shell, não é necessário iniciar sessão.

az login

Certifique-se de que está a executar a versão mais recente da CLI através do comando de atualização.

az upgrade

Em seguida, instale ou atualize a extensão Azure Web PubSub para a CLI se não tiver sido instalada com az upgrade.

az extension add --name webpubsub --upgrade

1. Criar um grupo de recursos

Defina as seguintes variáveis de ambiente. Substitua o <marcador> de posição por um nome pubSub Web exclusivo.

Bash

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

Azure PowerShell

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

Crie um grupo de recursos para o projeto Web PubSub.

Bash

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

Azure PowerShell

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

2. Implementar uma instância de serviço Web PubSub

Utilize o az webpubsub create comando para criar e implementar uma instância de serviço 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 a cadeia de ligação do serviço. A cadeia de ligação é utilizada pelo SDK do serviço para publicar mensagens.

Importante

Num ambiente de produção, deve armazenar cadeias de ligação de forma segura com o 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. Ligar um cliente à instância de serviço

Criar um cliente Web PubSub. O cliente mantém uma ligação ao serviço até que seja terminado.

Utilize o az webpubsub client comando para iniciar uma ligação de cliente WebSocket ao serviço. Os clientes ligam-se sempre a um hub, pelo que fornecem um nome de hub ao qual o cliente se vai ligar.

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' 

A ligação ao serviço Web PubSub é estabelecida quando vê uma mensagem JSON a indicar que o cliente está agora ligado com êxito e é-lhe atribuído um exclusivo connectionId:

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

4. Publicar mensagens com o SDK de serviço

Irá utilizar o SDK do Azure Web PubSub para publicar uma mensagem a todos os clientes ligados ao hub. Pode escolher entre C#, JavaScript, Python e Java. As dependências de cada idioma são instaladas nos passos para esse idioma. Python, JavaScript e Java necessitam de uma shell de bash para executar os comandos neste início rápido.

Configurar o projeto para publicar mensagens

1. Abra uma nova shell de comandos para este projeto.

2. Guarde a cadeia de ligação da shell do cliente. Substitua o <your_connection_string> marcador de posição pela cadeia de ligação que apresentou num passo anterior.

   Bash

   connection_string="<your_connection_string>"
   

   Azure PowerShell

   $connection_string = "<your_connection_string>"
   

3. Agora, selecione o idioma do projeto.

C#

1. Adicione um novo projeto com o nome publisher e o pacote Azure.Messaging.WebPubSubSDK .

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

2. Atualize o Program.cs ficheiro para utilizar a WebPubSubServiceClient classe para enviar mensagens aos clientes. Substitua o código no Program.cs ficheiro pelo seguinte código.

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

   A service.SendToAllAsync() chamada envia simplesmente uma mensagem para todos os clientes ligados no hub.

3. Execute o seguinte comando para publicar uma mensagem no serviço.

   dotnet run $connection_string "myHub1" "Hello World"
   

4. A shell de comandos anterior que contém o cliente Web PubSub mostra a mensagem recebida.

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

JavaScript

1. Crie uma nova pasta com o nome publisher para este projeto e instale as dependências necessárias:

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

2. Utilize o SDK do Azure Web PubSub para publicar uma mensagem no serviço. Crie um publish.js ficheiro que contenha o 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" });
   

   A sendToAll() chamada envia simplesmente uma mensagem para todos os clientes ligados num hub.

3. Execute o seguinte comando para publicar uma mensagem no serviço:

   export WebPubSubConnectionString=$connection_string
   node publish "Hello World"
   

4. A shell de comandos anterior que contém o cliente Web PubSub mostra a mensagem recebida.

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

Python

1. Crie uma nova pasta com o nome publisher para este projeto e instale as dependências necessárias:

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

2. Utilize o SDK do Azure Web PubSub para publicar uma mensagem no serviço. Crie um publish.py ficheiro com o código abaixo:

   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)
   

   O service.send_to_all() método envia a mensagem a todos os clientes ligados num hub.

3. Execute o seguinte comando para publicar uma mensagem no serviço:

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

4. A shell de comandos anterior que contém o cliente Web PubSub mostra a mensagem recebida.

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

Java

1. Utilize o Maven para criar uma nova aplicação de consola com o nome webpubsub-quickstart-publisher e aceda ao diretório 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. Adicione o SDK do Azure Web PubSub ao dependencies nó de pom.xml:

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

3. Aceda ao diretório src/main/java/com/webpubsub/quickstart .

4. Substitua o conteúdo no ficheiro App.java pelo seguinte código:

   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 utiliza o SDK do Azure Web PubSub para publicar uma mensagem no serviço. A service.sendToAll() chamada envia uma mensagem a todos os clientes ligados num hub.

5. Regresse ao diretório webpubsub-quickstart-publisher que contém o ficheiro pom.xml e compile o projeto com o seguinte mvn comando.

   mvn compile
   

6. Crie o pacote.

   mvn package
   

7. Execute o seguinte mvn comando para executar a aplicação para publicar uma mensagem no serviço:

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

8. A shell de comandos anterior que contém o cliente Web PubSub mostra a mensagem recebida.

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

Limpeza

Pode eliminar os recursos que criou neste início rápido ao eliminar o grupo de recursos que os contém.

Bash

az group delete --name $RESOURCE_GROUP --yes

Azure PowerShell

d

az group delete --name $ResourceGroup --yes

Passos seguintes

Este início rápido fornece-lhe uma ideia básica de como ligar ao serviço Web PubSub e como publicar mensagens nos clientes ligados.

Em aplicações do mundo real, pode utilizar SDKs em vários idiomas para criar a sua própria aplicação. Também fornecemos extensões de função para criar facilmente aplicações sem servidor.

Utilize estes recursos para começar a criar a sua própria aplicação:

Tutorial: Publicar e subscrever mensagens no Azure Web PubSub

Tutorial: Criar uma sala de chat simples com o Azure Web PubSub

Tutorial: Utilizar uma subprotocol suportada pelo serviço para a transmissão em fluxo de cliente

Tutorial: Criar chat sem servidor com o Funções do Azure e o Web PubSub

Tutorial: Configurar um serviço de escuta de eventos

Brincar com demonstrações ao vivo

Explorar mais exemplos do Azure Web PubSub