Biblioteka klienta usługi Azure Web PubSub dla platformy .NET

Artykuł
10/26/2023

Azure Web PubSub Service to usługa zarządzana przez platformę Azure, która ułatwia deweloperom łatwe tworzenie aplikacji internetowych przy użyciu funkcji w czasie rzeczywistym i wzorca publikowania-subskrybowania. Każdy scenariusz, który wymaga komunikatów publikowania i subskrybowania w czasie rzeczywistym między serwerem a klientami lub między klientami, może korzystać z usługi Azure Web PubSub. Tradycyjne funkcje w czasie rzeczywistym, które często wymagają sondowania z serwera lub przesyłania żądań HTTP, mogą również używać usługi Azure Web PubSub.

Tej biblioteki można używać po stronie serwera aplikacji do zarządzania połączeniami klienta protokołu WebSocket, jak pokazano na poniższym diagramie:

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

Użyj tej biblioteki, aby:

Wysyłanie komunikatów do centrów i grup.
Wysyłanie komunikatów do konkretnych użytkowników i połączeń.
Organizowanie użytkowników i połączeń w grupy.
Zamykanie połączeń
Udzielanie, odwoływanie i sprawdzanie uprawnień dla istniejącego połączenia

Dokumentacja interfejsu API | pakietu | źródłowego | — dokumentacja | produktu — przykłady

Wprowadzenie

Instalowanie pakietu

Zainstaluj bibliotekę klienta z pakietu NuGet:

dotnet add package Azure.Messaging.WebPubSub

Wymagania wstępne

Subskrypcja platformy Azure.
Istniejące wystąpienie usługi Azure Web PubSub.

Tworzenie i uwierzytelnianie `WebPubSubServiceClient`

Aby móc korzystać z usługi, musisz utworzyć wystąpienie WebPubSubServiceClient klasy. Aby to możliwe, musisz mieć parametry połączenia lub klucz, do którego można uzyskać dostęp w witrynie Azure Portal.

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

Przykłady

Emisja wiadomości SMS do wszystkich klientów

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

serviceClient.SendToAll("Hello World!");

Emisja komunikatu JSON do wszystkich klientów

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

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

Emisja komunikatu binarnego do wszystkich klientów

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