Snabbstart: Publicera meddelanden med Azure Web PubSub Service SDK

Azure Web PubSub hjälper dig att hantera WebSocket-klienter. Den här snabbstarten visar hur du publicerar meddelanden till WebSocket-klienter med hjälp av Azure Web PubSub Service SDK.

Krav

• Om du inte har en Azure-prenumeration skapar du ett kostnadsfritt konto.
• ett Bash- och PowerShell-kommandogränssnitt. Python-, JavaScript- och Java-exemplen kräver ett Bash-kommandogränssnitt.
• En filredigerare som VSCode.
• Azure CLI: installera Azure CLI

Om du skapar projektet på en lokal dator måste du installera beroendena för det språk du använder:

C#

Installera både .NET Core SDK och aspnetcore dotnet-körningen.

.NET Core

JavaScript

Node.js

Python

Python

Java

• Java Development Kit (JDK)
• Apache Maven

1. Installation

Om du vill logga in på Azure från CLI kör du följande kommando och följer anvisningarna för att slutföra autentiseringsprocessen. Om du använder Cloud Shell behöver du inte logga in.

az login

Kontrollera att du kör den senaste versionen av CLI via uppgraderingskommandot.

az upgrade

Installera eller uppdatera sedan Azure Web PubSub-tillägget för CLI om det inte har installerats med az upgrade.

az extension add --name webpubsub --upgrade

1. Skapa en resursgrupp

Ange följande miljövariabler. <Ersätt platshållaren> med ett unikt Web PubSub-namn.

Bash

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

Azure PowerShell

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

Skapa en resursgrupp för Web PubSub-projektet.

Bash

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

Azure PowerShell

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

2. Distribuera en Web PubSub-tjänstinstans

az webpubsub create Använd kommandot för att skapa och distribuera en Web PubSub-tjänstinstans.

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

Spara tjänstens anslutningssträng. Anslutningssträngen används av tjänst-SDK för att publicera meddelanden.

Viktigt

I en produktionsmiljö bör du lagra anslutningssträngar på ett säkert sätt med hjälp av 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. Anslut en klient till tjänstinstansen

Skapa en Web PubSub-klient. Klienten upprätthåller en anslutning till tjänsten tills den avslutas.

az webpubsub client Använd kommandot för att starta en WebSocket-klientanslutning till tjänsten. Klienterna ansluter alltid till en hubb, så ange ett hubbnamn som klienten ska ansluta till.

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' 

Anslutningen till Web PubSub-tjänsten upprättas när du ser ett JSON-meddelande som anger att klienten nu har anslutits och har tilldelats en unik connectionId:

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

4. Publicera meddelanden med service SDK

Du använder Azure Web PubSub SDK för att publicera ett meddelande till alla klienter som är anslutna till hubben. Du kan välja mellan C#, JavaScript, Python och Java. Beroendena för varje språk installeras i stegen för det språket. Python, JavaScript och Java kräver ett bash-gränssnitt för att köra kommandona i den här snabbstarten.

Konfigurera projektet för att publicera meddelanden

1. Öppna ett nytt kommandogränssnitt för det här projektet.

2. Spara anslutningssträngen från klientgränssnittet. <your_connection_string> Ersätt platshållaren med anslutningssträngen som du visade i ett tidigare steg.

   Bash

   connection_string="<your_connection_string>"
   

   Azure PowerShell

   $connection_string = "<your_connection_string>"
   

3. Välj nu språk för projektet.

C#

1. Lägg till ett nytt projekt med namnet publisher och SDK-paketet Azure.Messaging.WebPubSub.

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

2. Program.cs Uppdatera filen så att den WebPubSubServiceClient använder klassen för att skicka meddelanden till klienterna. Ersätt koden i Program.cs filen med följande kod.

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

   Anropet service.SendToAllAsync() skickar helt enkelt ett meddelande till alla anslutna klienter i hubben.

3. Kör följande kommando för att publicera ett meddelande till tjänsten.

   dotnet run $connection_string "myHub1" "Hello World"
   

4. Det tidigare kommandogränssnittet som innehåller Web PubSub-klienten visar det mottagna meddelandet.

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

JavaScript

1. Skapa en ny mapp med namnet publisher för det här projektet och installera nödvändiga beroenden:

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

2. Använd Azure Web PubSub SDK för att publicera ett meddelande till tjänsten. Skapa en publish.js fil som innehåller koden:

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

   Anropet sendToAll() skickar helt enkelt ett meddelande till alla anslutna klienter i en hubb.

3. Kör följande kommando för att publicera ett meddelande till tjänsten:

   export WebPubSubConnectionString=$connection_string
   node publish "Hello World"
   

4. Det tidigare kommandogränssnittet som innehåller Web PubSub-klienten visar det mottagna meddelandet.

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

Python

1. Skapa en ny mapp med namnet publisher för det här projektet och installera nödvändiga beroenden:

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

2. Använd Azure Web PubSub SDK för att publicera ett meddelande till tjänsten. Skapa en publish.py fil med koden nedan:

   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)
   

   Metoden service.send_to_all() skickar meddelandet till alla anslutna klienter i en hubb.

3. Kör följande kommando för att publicera ett meddelande till tjänsten:

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

4. Det tidigare kommandogränssnittet som innehåller Web PubSub-klienten visar det mottagna meddelandet.

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

Java

1. Använd Maven för att skapa en ny konsolapp med namnet webpubsub-quickstart-publisher och gå till katalogen 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. Lägg till Azure Web PubSub SDK till dependencies noden pom.xmlför :

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

3. Gå till katalogen src/main/java/com/webpubsub/quickstart .

4. Ersätt innehållet i Filen App.java med följande kod:

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

   Den här koden använder Azure Web PubSub SDK för att publicera ett meddelande till tjänsten. Anropet service.sendToAll() skickar ett meddelande till alla anslutna klienter i en hubb.

5. Returnera katalogen webpubsub-quickstart-publisher som innehåller pom.xml-filen och kompilera projektet med hjälp av följande mvn kommando.

   mvn compile
   

6. Skapa paketet.

   mvn package
   

7. Kör följande mvn kommando för att köra appen för att publicera ett meddelande till tjänsten:

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

8. Det tidigare kommandogränssnittet som innehåller Web PubSub-klienten visar det mottagna meddelandet.

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

Rensa

Du kan ta bort de resurser som du skapade i den här snabbstarten genom att ta bort den resursgrupp som innehåller dem.

Bash

az group delete --name $RESOURCE_GROUP --yes

Azure PowerShell

d

az group delete --name $ResourceGroup --yes

Nästa steg

Den här snabbstarten ger dig en grundläggande uppfattning om hur du ansluter till Web PubSub-tjänsten och hur du publicerar meddelanden till anslutna klienter.

I verkliga program kan du använda SDK:er på olika språk för att skapa ett eget program. Vi tillhandahåller även funktionstillägg som du enkelt kan skapa serverlösa program med.

Använd dessa resurser för att börja skapa ett eget program:

Självstudie: Publicera och prenumerera på meddelanden i Azure Web PubSub

Självstudie: Skapa ett enkelt chattrum med Azure Web PubSub

Självstudie: Använda en underprotokol som stöds av tjänsten för klientströmning

Självstudie: Skapa serverlös chatt med Azure Functions och Web PubSub

Självstudie: Konfigurera en händelselyssnare

Spela med livedemo

Utforska fler Azure Web PubSub-exempel