Clientbibliothek des Azure Web PubSub-Diensts für .NET

Artikel
10/26/2023

Azure Web PubSub Service ist ein von Azure verwalteter Dienst, der Entwicklern hilft, Webanwendungen mit Echtzeitfunktionen und Publish-Subscribe-Muster zu erstellen. Jedes Szenario, das Echtzeit-Publish-Subscribe-Messaging zwischen Server und Clients oder zwischen Clients erfordert, kann den Azure Web PubSub-Dienst nutzen. Herkömmliche Echtzeitfeatures, die häufig das Abrufen vom Server oder das Übermitteln von HTTP-Anforderungen erfordern, können ebenfalls den Azure Web PubSub-Dienst verwenden.

Sie können diese Bibliothek auf der App-Serverseite verwenden, um die WebSocket-Clientverbindungen zu verwalten, wie in der folgenden Abbildung dargestellt:

The overflow diagram shows the overflow of using the service client library.

Sie können diese Bibliothek für Folgendes verwenden:

Das Versenden von Nachrichten an Hubs und Gruppen.
Das Versenden von Nachrichten an bestimmte Benutzer und Verbindungen.
Das Organisieren von Benutzern und Verbindungen in Gruppen.
Das Schließen von Verbindungen
Das Erteilen, Widerrufen und Prüfen von Berechtigungen für eine vorhandene Verbindung

Quellcode | Paket | API-Referenzdokumentation | Produktdokumentation | Beispiele

Erste Schritte

Installieren des Pakets

Installieren Sie die Clientbibliothek über NuGet:

dotnet add package Azure.Messaging.WebPubSub

Voraussetzungen

Ein Azure-Abonnement.
Eine vorhandene Azure Web PubSub-Dienstinstanz.

Erstellen und Authentifizieren eines `WebPubSubServiceClient`

Für die Interaktion mit dem Dienst müssen Sie eine Instanz der WebPubSubServiceClient-Klasse erstellen. Hierzu benötigen Sie die Verbindungszeichenfolge oder einen Schlüssel. Beides steht im Azure-Portal zur Verfügung.

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

Beispiele

Übertragen einer Textnachricht an alle Clients

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

serviceClient.SendToAll("Hello World!");

Übertragen einer JSON-Nachricht an alle Clients

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

serviceClient.SendToAll(RequestContent.Create(
        new
        {
            Foo = "Hello World!",
            Bar = 42
        }),
        ContentType.ApplicationJson);

Übertragen einer binären Nachricht an alle Clients

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

Stream stream = BinaryData.FromString("Hello World!").ToStream();
serviceClient.SendToAll(RequestContent.Create(stream), ContentType.ApplicationOctetStream);

Problembehandlung

Einrichten der Konsolenprotokollierung

Sie können außerdem die Konsolenprotokollierung aktivieren, wenn Sie ausführliche Informationen zu den von Ihnen an den Dienst gesendeten Anforderungen erhalten möchten.