Szybki start: publikowanie komunikatów przy użyciu zestawu SDK usługi Azure Web PubSub

Usługa Azure Web PubSub ułatwia zarządzanie klientami protokołu WebSocket. W tym przewodniku Szybki start pokazano, jak publikować komunikaty na klientach protokołu WebSocket przy użyciu zestawu SDK usługi Azure Web PubSub.

Wymagania wstępne

• Jeśli nie masz subskrypcji platformy Azure, utwórz bezpłatne konto.
• powłoki poleceń Bash i programu PowerShell. Przykłady języków Python, JavaScript i Java wymagają powłoki poleceń powłoki Bash.
• Edytor plików, taki jak VSCode.
• Interfejs wiersza polecenia platformy Azure: instalowanie interfejsu wiersza polecenia platformy Azure

Jeśli tworzysz projekt na komputerze lokalnym, musisz zainstalować zależności dla używanego języka:

C#

Zainstaluj zarówno zestaw .NET Core SDK, jak aspnetcore i środowisko uruchomieniowe dotnet.

.NET Core

JavaScript

Node.js

Python

Python

Java

• Java Development Kit (JDK)
• Apache Maven

1. Konfiguracja

Aby zalogować się do platformy Azure z poziomu interfejsu wiersza polecenia, uruchom następujące polecenie i postępuj zgodnie z monitami, aby ukończyć proces uwierzytelniania. Jeśli używasz Cloud Shell, nie jest konieczne zalogowanie się.

az login

Upewnij się, że używasz najnowszej wersji interfejsu wiersza polecenia za pomocą polecenia uaktualniania.

az upgrade

Następnie zainstaluj lub zaktualizuj rozszerzenie Azure Web PubSub dla interfejsu wiersza polecenia, jeśli nie zostało zainstalowane za pomocą polecenia az upgrade.

az extension add --name webpubsub --upgrade

1. Tworzenie grupy zasobów

Ustaw następujące zmienne środowiskowe. Zastąp <symbol zastępczy> unikatową nazwą Web PubSub.

Bash

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

Azure PowerShell

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

Utwórz grupę zasobów dla projektu Web PubSub.

Bash

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

Azure PowerShell

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

2. Wdrażanie wystąpienia usługi Web PubSub

az webpubsub create Użyj polecenia , aby utworzyć i wdrożyć wystąpienie usługi Web PubSub.

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

Zapisz parametry połączenia usługi. Parametry połączenia są używane przez zestaw SDK usługi do publikowania komunikatów.

Ważne

W środowisku produkcyjnym należy bezpiecznie przechowywać parametry połączenia przy użyciu usługi 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. Łączenie klienta z wystąpieniem usługi

Utwórz klienta Web PubSub. Klient utrzymuje połączenie z usługą, dopóki nie zostanie zakończone.

az webpubsub client Użyj polecenia , aby uruchomić połączenie klienta protokołu WebSocket z usługą. Klienci zawsze łączą się z koncentratorem, dlatego podaj nazwę centrum, z którymi klient ma nawiązać połączenie.

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' 

Połączenie z usługą Web PubSub jest nawiązywane po wyświetleniu komunikatu JSON wskazującego, że klient jest teraz pomyślnie połączony i ma przypisaną unikatową wartość connectionId:

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

4. Publikowanie komunikatów przy użyciu zestawu SDK usługi

Użyjesz zestawu AZURE Web PubSub SDK, aby opublikować komunikat dla wszystkich klientów połączonych z centrum. Możesz wybrać między językami C#, JavaScript, Python i Java. Zależności dla każdego języka są instalowane w krokach dla tego języka. Język Python, JavaScript i Java wymagają powłoki bash, aby uruchamiać polecenia w tym przewodniku Szybki start.

Konfigurowanie projektu w celu publikowania komunikatów

1. Otwórz nową powłokę poleceń dla tego projektu.

2. Zapisz parametry połączenia z powłoki klienta. Zastąp <your_connection_string> symbol zastępczy parametrami połączenia wyświetlanymi we wcześniejszym kroku.

   Bash

   connection_string="<your_connection_string>"
   

   Azure PowerShell

   $connection_string = "<your_connection_string>"
   

3. Teraz wybierz język projektu.

C#

1. Dodaj nowy projekt o nazwie publisher i pakiet Azure.Messaging.WebPubSubzestawu SDK .

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

2. Zaktualizuj plik, Program.cs aby używał WebPubSubServiceClient klasy do wysyłania komunikatów do klientów. Zastąp kod w Program.cs pliku następującym kodem.

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

   Wywołanie service.SendToAllAsync() po prostu wysyła komunikat do wszystkich połączonych klientów w centrum.

3. Uruchom następujące polecenie, aby opublikować komunikat w usłudze.

   dotnet run $connection_string "myHub1" "Hello World"
   

4. Poprzednia powłoka poleceń zawierająca klienta Web PubSub wyświetla odebrany komunikat.

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

JavaScript

1. Utwórz nowy folder o nazwie publisher dla tego projektu i zainstaluj wymagane zależności:

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

2. Użyj zestawu AZURE Web PubSub SDK, aby opublikować komunikat w usłudze. publish.js Utwórz plik zawierający kod:

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

   Wywołanie sendToAll() po prostu wysyła komunikat do wszystkich połączonych klientów w centrum.

3. Uruchom następujące polecenie, aby opublikować komunikat w usłudze:

   export WebPubSubConnectionString=$connection_string
   node publish "Hello World"
   

4. Poprzednia powłoka poleceń zawierająca klienta Web PubSub wyświetla odebrany komunikat.

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

Python

1. Utwórz nowy folder o nazwie publisher dla tego projektu i zainstaluj wymagane zależności:

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

2. Użyj zestawu AZURE Web PubSub SDK, aby opublikować komunikat w usłudze. publish.py Utwórz plik z poniższym kodem:

   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)
   

   Metoda service.send_to_all() wysyła komunikat do wszystkich połączonych klientów w centrum.

3. Uruchom następujące polecenie, aby opublikować komunikat w usłudze:

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

4. Poprzednia powłoka poleceń zawierająca klienta Web PubSub wyświetla odebrany komunikat.

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

Java

1. Użyj narzędzia Maven, aby utworzyć nową aplikację konsolową o nazwie webpubsub-quickstart-publisher i przejść do katalogu 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. Dodaj zestaw AZURE Web PubSub SDK do dependencies węzła :pom.xml

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

3. Przejdź do katalogu src/main/java/com/webpubsub/quickstart .

4. Zastąp zawartość pliku App.java następującym kodem:

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

   Ten kod używa zestawu AZURE Web PubSub SDK do opublikowania komunikatu w usłudze. Wywołanie service.sendToAll() wysyła komunikat do wszystkich połączonych klientów w centrum.

5. Zwróć t katalogu webpubsub-quickstart-publisher zawierającego plik pom.xml i skompiluj projekt przy użyciu następującego mvn polecenia.

   mvn compile
   

6. Skompiluj pakiet.

   mvn package
   

7. Uruchom następujące mvn polecenie, aby wykonać aplikację w celu opublikowania komunikatu w usłudze:

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

8. Poprzednia powłoka poleceń zawierająca klienta Web PubSub wyświetla odebrany komunikat.

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

Czyszczenie

Zasoby utworzone w tym przewodniku Szybki start można usunąć, usuwając grupę zasobów, która je zawiera.

Bash

az group delete --name $RESOURCE_GROUP --yes

Azure PowerShell

d

az group delete --name $ResourceGroup --yes

Następne kroki

Ten przewodnik Szybki start zawiera podstawowe informacje na temat nawiązywania połączenia z usługą Web PubSub i publikowania komunikatów na połączonych klientach.

W rzeczywistych aplikacjach można używać zestawów SDK w różnych językach, które tworzą własną aplikację. Udostępniamy również rozszerzenia funkcji, które ułatwiają tworzenie aplikacji bezserwerowych.

Użyj tych zasobów, aby rozpocząć tworzenie własnej aplikacji:

Samouczek: publikowanie i subskrybowanie komunikatów w usłudze Azure Web PubSub

Samouczek: tworzenie prostego czatroomu za pomocą usługi Azure Web PubSub

Samouczek: używanie podprotocol obsługiwanej przez usługę na potrzeby przesyłania strumieniowego klienta

Samouczek: tworzenie bezserwerowego czatu za pomocą Azure Functions i web pubSub

Samouczek: konfigurowanie odbiornika zdarzeń

Graj z pokazami na żywo

Zapoznaj się z przykładami usługi Azure Web PubSub