Schnellstart: Veröffentlichen von Nachrichten mit dem Azure Web PubSub Service SDK

Azure Web PubSub unterstützt Sie bei der Verwaltung von WebSocket-Clients. In dieser Schnellstartanleitung erfahren Sie, wie Sie Nachrichten mithilfe des Azure Web PubSub Service SDK in WebSocket-Clients veröffentlichen.

Voraussetzungen

Wenn Sie noch nicht über ein Azure-Abonnement verfügen, erstellen Sie ein kostenloses Konto.
eine Bash- und PowerShell-Befehlsshell. Für die Python-, JavaScript- und Java-Beispiele ist eine Bash-Befehlsshell erforderlich.
Ein Datei-Editor, z. B. VS Code.
Azure CLI: Installieren der 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:

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

.NET Kern

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, ist es nicht erforderlich, sich anzumelden.

az login

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

az upgrade

Installieren oder aktualisieren Sie als Nächstes die Azure Web PubSub-Erweiterung für die CLI, wenn sie nicht mit az upgradeinstalliert 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.

Schlagen
Azure PowerShell

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

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

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

Schlagen
Azure PowerShell

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

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

2. Bereitstellen einer Web-PubSub-Dienstinstanz

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

Schlagen
Azure PowerShell

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

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.

Von Bedeutung

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

Schlagen
Azure PowerShell

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

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 behält eine Verbindung mit dem Dienst bei, bis er beendet wird.

Verwenden Sie den az webpubsub client Befehl, um eine WebSocket-Clientverbindung mit dem Dienst zu starten. Die Clients stellen immer eine Verbindung mit einem Hub her, geben Sie also einen Hubnamen an, mit dem der Client eine Verbindung herstellen soll.

Schlagen
Azure PowerShell

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

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

Die Verbindung mit dem Web-PubSub-Dienst wird hergestellt, wenn eine JSON-Meldung angezeigt wird, die angibt, dass der Client jetzt erfolgreich verbunden ist und eine eindeutige connectionIdOption zugewiesen wird:

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

4. Veröffentlichen von Nachrichten mit dem Dienst-SDK

Sie verwenden das Azure Web PubSub SDK, um eine Nachricht an alle Clients zu veröffentlichen, die mit dem Hub verbunden sind. Sie können zwischen C#, JavaScript, Python und Java wählen. Die Abhängigkeiten für jede Sprache werden in den Schritten für diese Sprache installiert. Für Python, JavaScript und Java ist eine Bash-Shell erforderlich, um die Befehle in dieser Schnellstartanleitung auszuführen.

Einrichten des Projekts zum Veröffentlichen von Nachrichten

Öffnen Sie eine neue Befehlsshell für dieses Projekt.
Speichern Sie die Verbindungszeichenfolge in der Clientshell. Ersetzen Sie den <your_connection_string> Platzhalter durch die Verbindungszeichenfolge, die Sie in einem früheren Schritt angezeigt haben.
- Schlagen
- Azure PowerShell
```
connection_string="<your_connection_string>"
```
```
$connection_string = "<your_connection_string>"
```
Wählen Sie nun die Sprache für Ihr Projekt aus.

Fügen Sie ein neues Projekt mit dem Namen publisher und das SDK-Paket Azure.Messaging.WebPubSubhinzu.
```
mkdir publisher
cd publisher
dotnet new console
dotnet add package Azure.Messaging.WebPubSub
```

Aktualisieren Sie die Program.cs Datei so, dass die WebPubSubServiceClient Klasse zum Senden von Nachrichten an die Clients verwendet wird. Ersetzen Sie den Code in der Program.cs Datei 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.

Führen Sie den folgenden Befehl aus, um eine Nachricht im Dienst zu veröffentlichen.
```
dotnet run $connection_string "myHub1" "Hello World"
```
In der vorherigen Befehlsshell, die den Web PubSub-Client enthält, wird die empfangene Nachricht angezeigt.
```
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
```

Erstellen Sie einen neuen Ordner mit dem Namen publisher dieses Projekts, und installieren Sie die erforderlichen Abhängigkeiten:
```
mkdir publisher
cd publisher
npm init -y
npm install --save @azure/web-pubsub
```

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

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.

Führen Sie den folgenden Befehl aus, um eine Nachricht im Dienst zu veröffentlichen:
```
export WebPubSubConnectionString=$connection_string
node publish "Hello World"
```
In der vorherigen Befehlsshell, die den Web PubSub-Client enthält, wird die empfangene Nachricht angezeigt.
```
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
```

Erstellen Sie einen neuen Ordner mit dem Namen publisher dieses Projekts, 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

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)

Die service.send_to_all() Methode sendet die Nachricht an alle verbundenen Clients in einem Hub.

Führen Sie den folgenden Befehl aus, um eine Nachricht im Dienst zu veröffentlichen:
```
python publish.py $connection_string "myHub1" "Hello World"
```
In der vorherigen Befehlsshell, die den Web PubSub-Client enthält, wird die empfangene Nachricht angezeigt.
```
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
```

Verwenden Sie Maven, um eine neue Konsolen-App mit dem Namen 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

Fügen Sie das Azure Web PubSub SDK dem dependencies Knoten von pom.xmlhinzu:

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

Wechseln Sie in das Verzeichnis src/main/java/com/webpubsub/quickstart .

Ersetzen Sie den Inhalt in der App.java Datei 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);
    }
}

In diesem Code wird das Azure Web PubSub SDK verwendet, um eine Nachricht im Dienst zu veröffentlichen. Der Aufruf service.sendToAll() sendet eine Nachricht an alle verbundenen Clients in einem Hub.

Geben Sie das Verzeichnis webpubsub-quickstart-publisher zurück, das diepom.xmlDatei enthält , und kompilieren Sie das Projekt mit dem folgenden mvn Befehl.
```
mvn compile
```
Erstellen Sie das Paket.
```
mvn package
```

Führen Sie den folgenden mvn Befehl aus, um die App auszuführen und eine Nachricht im Dienst zu veröffentlichen:

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

In der vorherigen Befehlsshell, die den Web PubSub-Client enthält, wird die empfangene Nachricht angezeigt.
```
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
```

Säuberungsaktion

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

Schlagen
Azure PowerShell

az group delete --name $RESOURCE_GROUP --yes

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

Feedback

War diese Seite hilfreich?

Last updated on 2025-06-22