Schnellstart: Veröffentlichen von Nachrichten mit dem SDK für den Azure Web PubSub-Dienst

Azure Web PubSub hilft beim Verwalten von WebSocket-Clients. In dieser Schnellstartanleitung wird gezeigt, wie Sie Nachrichten für WebSocket-Clients mit dem SDK für den Azure Web PubSub-Dienst veröffentlichen.

Voraussetzungen

• Ein Azure-Abonnement. Wenn Sie keins besitzen, erstellen Sie ein kostenloses Konto.
• Eine Bash- und eine PowerShell-Befehlsshell. Für die Beispiele für Python, JavaScript und Java ist eine Bash-Befehlsshell erforderlich.
• Ein Datei-Editor wie z. B. VS Code.
• Azure CLI: Installieren Sie die Azure CLI.

Wenn Sie das Projekt auf einem lokalen Computer erstellen, müssen Sie die Abhängigkeiten für die von Ihnen verwendete Sprache installieren:

C#

Installieren Sie sowohl das .NET Core SDK als auch die aspnetcore- und die .NET-Runtime.

.NET Core

JavaScript

Node.js

Python

Python

Java

• Java Development Kit (JDK)
• Apache Maven

1. Einrichten

Um sich ausgehend von der CLI bei Azure anzumelden, führen Sie den folgenden Befehl aus und befolgen Sie die Anweisungen, um den Authentifizierungsprozess abzuschließen. Wenn Sie Cloud Shell verwenden, müssen Sie sich nicht anmelden.

az login

Stellen Sie sicher, dass Sie die neueste Version der CLI über den Upgradebefehl ausführen.

az upgrade

Als Nächstes installieren oder aktualisieren Sie die Azure Web PubSub-Erweiterung für die CLI, wenn sie nicht mit az upgrade installiert wurde.

az extension add --name webpubsub --upgrade

1. Erstellen einer Ressourcengruppe

Legen Sie die folgenden Umgebungsvariablen fest. Ersetzen Sie den <Platzhalter> durch einen eindeutigen Web PubSub-Namen.

Bash

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

Azure PowerShell

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

Erstellen Sie eine Ressourcengruppe für das Web PubSub-Projekt.

Bash

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

Azure PowerShell

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

2. Bereitstellen einer Web PubSub-Dienstinstanz

Verwenden Sie den Befehl az webpubsub create, um eine Web PubSub-Dienstinstanz zu erstellen und bereitzustellen.

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

Speichern Sie die Verbindungszeichenfolge des Diensts. Die Verbindungszeichenfolge wird vom Dienst-SDK zum Veröffentlichen von Nachrichten verwendet.

Wichtig

In einer Produktionsumgebung sollten Sie Verbindungszeichenfolgen mithilfe von Azure Key Vault sicher speichern.

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. Verbinden eines Clients mit der Dienstinstanz

Erstellen Sie einen Web PubSub-Client. Der Client hält die Verbindung mit dem Dienst aufrecht, bis er beendet wird.

Verwenden Sie den Befehl az webpubsub client, um eine WebSocket-Clientverbindung mit dem Dienst zu starten. Die Clients stellen immer eine Verbindung mit einem Hub her. Geben Sie daher einen Hubnamen für den Client an, mit dem eine Verbindung hergestellt werden soll.

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' 

Die Verbindung mit dem Web PubSub-Dienst ist hergestellt, wenn eine JSON-Nachricht angezeigt wird, die besagt, dass die Clientverbindung erfolgreich hergestellt und dem Client eine eindeutige connectionId zugewiesen wurde:

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

4. Veröffentlichen von Nachrichten mithilfe des Dienst-SDK

Sie verwenden das Azure Web PubSub SDK, um eine Nachricht für alle Clients zu veröffentlichen, die mit dem Hub verbunden sind. Sie können zwischen C#, JavaScript, Python und Java auswählen. Die Abhängigkeiten für jede einzelne Sprache werden in den Schritten für die entsprechende Sprache installiert. Python, JavaScript und Java erfordern eine Bash-Shell zum Ausführen der Befehle in dieser Schnellstartanleitung.

Einrichten des Projekts zum Veröffentlichen von Nachrichten

1. Öffnen Sie eine neue Befehlsshell für dieses Projekt.

2. Speichern Sie die Verbindungszeichenfolge aus der Clientshell. Ersetzen Sie den Platzhalter „<your_connection_string>“ durch die Verbindungszeichenfolge, die Sie in einem früheren Schritt angezeigt haben.

   Bash

   connection_string="<your_connection_string>"
   

   Azure PowerShell

   $connection_string = "<your_connection_string>"
   

3. Wählen Sie jetzt die Sprache für Ihr Projekt aus.

C#

1. Fügen Sie ein neues Projekt namens publisher und das SDK-Paket Azure.Messaging.WebPubSub hinzu.

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

2. Aktualisieren Sie die Datei Program.cs, sodass die Klasse WebPubSubServiceClient verwendet wird, um Nachrichten an die Clients zu senden. Ersetzen Sie den Code in der Datei Program.cs durch den folgenden Code.

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

   Der Aufruf service.SendToAllAsync() sendet einfach eine Nachricht an alle verbundenen Clients im Hub.

3. Führen Sie den folgenden Befehl aus, um eine Nachricht für den Dienst zu veröffentlichen.

   dotnet run $connection_string "myHub1" "Hello World"
   

4. Die vorherige Befehlsshell, die den Web PubSub-Client enthält, zeigt die empfangene Nachricht an.

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

JavaScript

1. Erstellen Sie einen neuen Ordner namens publisher für dieses Projekt, und installieren Sie die erforderlichen Abhängigkeiten:

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

2. Verwenden Sie das Azure Web PubSub SDK, um eine Nachricht für den Dienst zu veröffentlichen. Erstellen Sie eine publish.js-Datei, die folgenden Code enthält:

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

   Der Aufruf sendToAll() sendet einfach eine Nachricht an alle verbundenen Clients in einem Hub.

3. Führen Sie den folgenden Befehl aus, um eine Nachricht für den Dienst zu veröffentlichen:

   export WebPubSubConnectionString=$connection_string
   node publish "Hello World"
   

4. Die vorherige Befehlsshell, die den Web PubSub-Client enthält, zeigt die empfangene Nachricht an.

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

Python

1. Erstellen Sie einen neuen Ordner namens publisher für dieses Projekt, und installieren Sie die erforderlichen Abhängigkeiten:

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

2. Verwenden Sie das Azure Web PubSub SDK, um eine Nachricht für den Dienst zu veröffentlichen. Erstellen Sie eine Datei vom Typ publish.py mit dem folgenden Code:

   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)
   

   Mit der Methode service.send_to_all() wird die Nachricht an alle verbundenen Clients in einem Hub gesendet.

3. Führen Sie den folgenden Befehl aus, um eine Nachricht für den Dienst zu veröffentlichen:

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

4. Die vorherige Befehlsshell, die den Web PubSub-Client enthält, zeigt die empfangene Nachricht an.

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

Java

1. Verwenden Sie Maven, um eine neue Konsolen-App namens webpubsub-quickstart-publisher zu erstellen, und wechseln Sie zum Verzeichnis 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. Fügen Sie das Azure Web PubSub SDK zum dependencies-Knoten von pom.xml hinzu:

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

3. Wechseln Sie zum Verzeichnis src/main/java/com/webpubsub/quickstart.

4. Ersetzen Sie den Inhalt in der Datei App.java durch den folgenden Code:

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

   Dieser Code verwendet das Azure Web PubSub SDK, um eine Nachricht für den Dienst zu veröffentlichen. Der Aufruf service.sendToAll() sendet eine Nachricht an alle verbundenen Clients in einem Hub.

5. Kehren Sie zum Verzeichnis webpubsub-quickstart-publisher zurück, dass die Datei pom.xml enthält, und kompilieren Sie das Projekt mit dem folgenden mvn-Befehl.

   mvn compile
   

6. Erstellen Sie das Paket.

   mvn package
   

7. Führen Sie den folgenden mvn-Befehl aus, um die App auszuführen und eine Nachricht für den Dienst zu veröffentlichen:

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

8. Die vorherige Befehlsshell, die den Web PubSub-Client enthält, zeigt die empfangene Nachricht an.

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

Bereinigen

Sie können die Ressourcen löschen, die Sie in dieser Schnellstartanleitung erstellt haben, indem Sie die Ressourcengruppe löschen, die sie enthält.

Bash

az group delete --name $RESOURCE_GROUP --yes

Azure PowerShell

T

az group delete --name $ResourceGroup --yes

Nächste Schritte

In dieser Schnellstartanleitung erhalten Sie grundlegende Informationen dazu, wie Sie eine Verbindung mit dem Web PubSub-Dienst herstellen und Nachrichten auf den verbundenen Clients veröffentlichen.

In realen Anwendungen können Sie SDKs in verschiedenen Sprachen verwenden, um Ihre eigene Anwendung zu erstellen. Außerdem werden Funktionserweiterungen zur Verfügung gestellt, mit deren Hilfe Sie problemlos serverlose Anwendungen erstellen können.

Erstellen Sie mithilfe dieser Ressourcen Ihre eigene Anwendung:

Tutorial: Veröffentlichen und Abonnieren von Nachrichten in Azure Web PubSub

Tutorial: Erstellen eines einfachen Chatrooms mit Azure Web PubSub

Tutorial: Verwenden eines vom Dienst unterstützten Unterprotokolls für Clientstreaming

Tutorial: Erstellen eines serverlosen Chats mit Azure Functions und Web PubSub

Tutorial: Konfigurieren eines Ereignislisteners

Spielen mit Livedemos

Weitere Beispiele für Azure Web PubSub