Rychlý start: Publikování zpráv pomocí sady SDK služby Azure Web PubSub

Azure Web PubSub pomáhá spravovat klienty WebSocket. V tomto rychlém startu se dozvíte, jak publikovat zprávy do klientů WebSocket pomocí sady SDK služby Azure Web PubSub.

Požadavky

• Pokud předplatné Azure nemáte, vytvořte si bezplatný účet.
• prostředí příkazů Bash a PowerShellu. Ukázky Pythonu, JavaScriptu a Javy vyžadují příkazové prostředí Bash.
• Editor souborů, jako je VSCode.
• Azure CLI: Instalace Azure CLI

Pokud vytváříte projekt na místním počítači, budete muset nainstalovat závislosti pro jazyk, který používáte:

C#

Nainstalujte sadu .NET Core SDK i aspnetcore modul runtime a dotnet.

.NET Core

JavaScript

Node.js

Python

Python

Java

• Sada Java Development Kit (JDK)
• Apache Maven

1. Nastavení

Pokud se chcete k Azure přihlásit z rozhraní příkazového řádku, spusťte následující příkaz a postupujte podle pokynů k dokončení procesu ověřování. Pokud používáte Cloud Shell, není nutné se přihlašovat.

az login

Ujistěte se, že používáte nejnovější verzi rozhraní příkazového řádku prostřednictvím příkazu pro upgrade.

az upgrade

Dále nainstalujte nebo aktualizujte rozšíření Azure Web PubSub pro rozhraní příkazového řádku, pokud nebylo nainstalované s az upgrade.

az extension add --name webpubsub --upgrade

1. Vytvoření skupiny prostředků

Nastavte následující proměnné prostředí. <Zástupný symbol> nahraďte jedinečným názvem 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>'

Vytvořte skupinu prostředků pro projekt Web PubSub.

Bash

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

Azure PowerShell

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

2. Nasazení instance služby Web PubSub

Pomocí příkazu az webpubsub create vytvořte a nasaďte instanci služby 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

Uložte připojovací řetězec služby. Připojovací řetězec používá sada SDK služby k publikování zpráv.

Důležité

V produkčním prostředí byste měli bezpečně ukládat připojovací řetězce pomocí 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. Připojení klienta k instanci služby

Vytvořte klienta Web PubSub. Klient udržuje připojení ke službě, dokud se neukončí.

Pomocí příkazu az webpubsub client spusťte připojení klienta WebSocket ke službě. Klienti se vždy připojují k centru, proto zadejte název centra, ke kterému se má klient připojit.

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' 

Připojení ke službě Web PubSub se naváže, když se zobrazí zpráva JSON s oznámením, že klient je nyní úspěšně připojen a je mu přiřazena jedinečná connectionIdhodnota :

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

4. Publikování zpráv pomocí sady SDK služby

Pomocí sady Azure Web PubSub SDK publikujete zprávu všem klientům připojeným k centru. Můžete si vybrat mezi C#, JavaScriptem, Pythonem a Javou. Závislosti pro každý jazyk se nainstalují v krocích pro daný jazyk. Python, JavaScript a Java vyžadují ke spuštění příkazů v tomto rychlém startu prostředí Bash.

Nastavení projektu pro publikování zpráv

1. Otevřete nové příkazové prostředí pro tento projekt.

2. Uložte připojovací řetězec z klientského prostředí. <your_connection_string> Nahraďte zástupný symbol připojovacím řetězcem, který jste zobrazili v předchozím kroku.

   Bash

   connection_string="<your_connection_string>"
   

   Azure PowerShell

   $connection_string = "<your_connection_string>"
   

3. Teď vyberte jazyk projektu.

C#

1. Přidejte nový projekt s názvem publisher a balíček Azure.Messaging.WebPubSubsady SDK .

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

2. Program.cs Aktualizujte soubor tak, aby používal WebPubSubServiceClient třídu k odesílání zpráv klientům. Nahraďte kód v Program.cs souboru následujícím kódem.

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

   Volání service.SendToAllAsync() jednoduše odešle zprávu všem připojeným klientům v centru.

3. Spuštěním následujícího příkazu publikujte zprávu do služby.

   dotnet run $connection_string "myHub1" "Hello World"
   

4. Předchozí příkazové prostředí obsahující klienta Web PubSub zobrazí přijatou zprávu.

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

JavaScript

1. Vytvořte novou složku s názvem publisher pro tento projekt a nainstalujte požadované závislosti:

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

2. K publikování zprávy do služby použijte sadu Azure Web PubSub SDK. Vytvořte publish.js soubor obsahující kód:

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

   Volání sendToAll() jednoduše odešle zprávu všem připojeným klientům v centru.

3. Spuštěním následujícího příkazu publikujte zprávu do služby:

   export WebPubSubConnectionString=$connection_string
   node publish "Hello World"
   

4. Předchozí příkazové prostředí obsahující klienta Web PubSub zobrazí přijatou zprávu.

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

Python

1. Vytvořte novou složku s názvem publisher pro tento projekt a nainstalujte požadované závislosti:

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

2. K publikování zprávy do služby použijte sadu Azure Web PubSub SDK. Vytvořte publish.py soubor s následujícím kódem:

   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() odešle zprávu všem připojeným klientům v centru.

3. Spuštěním následujícího příkazu publikujte zprávu do služby:

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

4. Předchozí příkazové prostředí obsahující klienta Web PubSub zobrazí přijatou zprávu.

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

Java

1. Pomocí Mavenu vytvořte novou konzolovou aplikaci s názvem webpubsub-quickstart-publisher a přejděte do adresáře 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. Přidejte sadu Azure Web PubSub SDK do dependencies uzlu služby pom.xml:

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

3. Přejděte do adresáře src/main/java/com/webpubsub/quickstart .

4. Obsah v souboru App.java nahraďte následujícím kódem:

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

   Tento kód používá sadu Azure Web PubSub SDK k publikování zprávy do služby. Volání service.sendToAll() odešle zprávu všem připojeným klientům v centru.

5. Vraťte t adresář webpubsub-quickstart-publisher obsahující souborpom.xml a zkompilujte projekt pomocí následujícího mvn příkazu.

   mvn compile
   

6. Sestavte balíček.

   mvn package
   

7. Spuštěním následujícího mvn příkazu spusťte aplikaci, která publikuje zprávu do služby:

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

8. Předchozí příkazové prostředí obsahující klienta Web PubSub zobrazí přijatou zprávu.

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

Vyčištění

Prostředky, které jste vytvořili v tomto rychlém startu, můžete odstranit odstraněním skupiny prostředků, která je obsahuje.

Bash

az group delete --name $RESOURCE_GROUP --yes

Azure PowerShell

d

az group delete --name $ResourceGroup --yes

Další kroky

Tento rychlý start poskytuje základní představu o tom, jak se připojit ke službě Web PubSub a jak publikovat zprávy pro připojené klienty.

V reálných aplikacích můžete použít sady SDK v různých jazycích a vytvořit vlastní aplikaci. Poskytujeme vám také rozšíření funkcí, která vám umožní snadno vytvářet bezserverové aplikace.

Pomocí těchto prostředků můžete začít vytvářet vlastní aplikaci:

Kurz: Publikování a přihlášení k odběru zpráv ve službě Azure Web PubSub

Kurz: Vytvoření jednoduché chatovací místnosti pomocí Azure Web PubSub

Kurz: Použití dílčího protokolu podporovaného službou pro streamování klientů

Kurz: Vytvoření bezserverového chatu s Azure Functions a Web PubSub

Kurz: Konfigurace naslouchacího procesu událostí

Hraní s živými ukázkami

Projděte si další ukázky Azure Web PubSub.