Краткое руководство. Публикация сообщений с помощью пакета SDK службы Azure Web PubSub

Azure Web PubSub помогает управлять клиентами WebSocket. В этом кратком руководстве показано, как публиковать сообщения в клиентах WebSocket с помощью пакета SDK службы Azure Web PubSub.

Предварительные требования

• Если у вас нет подписки Azure, создайте бесплатную учетную запись.
• командная оболочка Bash и PowerShell. Для примеров Python, JavaScript и Java требуется командная оболочка Bash.
• Редактор файлов, например VSCode.
• Azure CLI: установка Azure CLI

При создании проекта на локальном компьютере необходимо установить зависимости для используемого языка:

C#

Установите пакет SDK для .NET Core и aspnetcore среду выполнения и dotnet.

.NET Core

JavaScript

Node.js

Python

Python

Java

• Пакет средств разработки Java (JDK)
• Apache Maven

1. Настройка

Чтобы войти в Azure из CLI, выполните следующую команду и следуйте инструкциям, чтобы завершить процесс проверки подлинности. Если вы используете Cloud Shell, выполнять вход необязательно.

az login

Обеспечьте использование последней версии интерфейса командной строки, выполнив команду обновления.

az upgrade

Затем установите или обновите расширение Azure Web PubSub для интерфейса командной строки, если оно не было установлено с az upgrade.

az extension add --name webpubsub --upgrade

1. Создание группы ресурсов

Задайте следующие переменные среды. Замените <заполнитель> уникальным именем 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>'

Создайте группу ресурсов для проекта Web PubSub.

Bash

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

Azure PowerShell

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

2. Развертывание экземпляра службы Web PubSub

Используйте команду для az webpubsub create создания и развертывания экземпляра службы 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

Сохраните строку подключения службы. Строка подключения используется пакетом SDK службы для публикации сообщений.

Важно!

В рабочей среде следует безопасно хранить строки подключения с помощью 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. Подключение клиента к экземпляру службы

Создайте клиент Web PubSub. Клиент поддерживает подключение к службе, пока оно не будет завершено.

Используйте команду , az webpubsub client чтобы запустить подключение клиента WebSocket к службе. Клиенты всегда подключаются к концентратору, поэтому укажите имя концентратора для клиента, к которому нужно подключиться.

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' 

Подключение к службе Web PubSub устанавливается, когда отображается сообщение JSON о том, что клиент успешно подключен, и ему назначен уникальный connectionId:

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

4. Публикация сообщений с помощью пакета SDK службы

Вы будете использовать пакет SDK Azure Web PubSub для публикации сообщения для всех клиентов, подключенных к концентратору. Вы можете выбрать C#, JavaScript, Python и Java. Зависимости для каждого языка устанавливаются на этапах для этого языка. Для выполнения команд, приведенных в этом кратком руководстве, для python, JavaScript и Java требуется оболочка Bash.

Настройка проекта для публикации сообщений

1. Откройте новую командную оболочку для этого проекта.

2. Сохраните строку подключения из клиентской оболочки. Замените <your_connection_string> заполнитель строкой подключения, отображаемой на предыдущем шаге.

   Bash

   connection_string="<your_connection_string>"
   

   Azure PowerShell

   $connection_string = "<your_connection_string>"
   

3. Теперь выберите язык для проекта.

C#

1. Добавьте новый проект с именем publisher и пакет Azure.Messaging.WebPubSubSDK .

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

2. Обновите файл, Program.cs чтобы использовать WebPubSubServiceClient класс для отправки сообщений клиентам. Замените код в Program.cs файле следующим кодом.

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

   Вызов service.SendToAllAsync() просто отправляет сообщение всем подключенным клиентам в концентраторе.

3. Выполните следующую команду, чтобы опубликовать сообщение в службе.

   dotnet run $connection_string "myHub1" "Hello World"
   

4. В предыдущей командной оболочке, содержащей клиент Web PubSub, отображается полученное сообщение.

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

JavaScript

1. Создайте папку с именем publisher для этого проекта и установите необходимые зависимости:

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

2. Используйте пакет SDK Azure Web PubSub для публикации сообщения в службе. Создайте publish.js файл, содержащий код:

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

   Вызов sendToAll() просто отправляет сообщение всем подключенным клиентам в концентраторе.

3. Выполните следующую команду, чтобы опубликовать сообщение в службе:

   export WebPubSubConnectionString=$connection_string
   node publish "Hello World"
   

4. В предыдущей командной оболочке, содержащей клиент Web PubSub, отображается полученное сообщение.

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

Python

1. Создайте папку с именем publisher для этого проекта и установите необходимые зависимости:

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

2. Используйте пакет SDK Azure Web PubSub для публикации сообщения в службе. Создайте файл publish.py с помощью приведенного ниже кода:

   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)
   

   Метод service.send_to_all() отправляет сообщение всем подключенным клиентам в концентраторе.

3. Выполните следующую команду, чтобы опубликовать сообщение в службе:

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

4. В предыдущей командной оболочке, содержащей клиент Web PubSub, отображается полученное сообщение.

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

Java

1. С помощью Maven создайте консольное приложение с именем webpubsub-quickstart-publisher и перейдите в каталог 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. Добавьте пакет SDK Azure Web PubSub в dependencies узел pom.xml:

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

3. Перейдите в каталог src/main/java/com/webpubsub/quickstart.

4. Замените содержимое файла App.java следующим кодом:

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

   Этот код использует пакет SDK Azure Web PubSub для публикации сообщения в службе. Вызов service.sendToAll() отправляет сообщение всем подключенным клиентам в концентраторе.

5. Верните t каталог webpubsub-quickstart-publisher , содержащий файл pom.xml , и скомпилируйте проект с помощью следующей mvn команды.

   mvn compile
   

6. Выполните сборку пакета.

   mvn package
   

7. Выполните следующую mvn команду, чтобы выполнить приложение для публикации сообщения в службе:

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

8. В предыдущей командной оболочке, содержащей клиент Web PubSub, отображается полученное сообщение.

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

Очистка

Вы можете удалить ресурсы, созданные в этом кратком руководстве, удалив группу ресурсов, содержащую их.

Bash

az group delete --name $RESOURCE_GROUP --yes

Azure PowerShell

d

az group delete --name $ResourceGroup --yes

Дальнейшие действия

В этом кратком руководстве представлено общее описание того, как подключиться к службе Web PubSub и публиковать сообщения на подключенных клиентах.

В реальных приложениях вы можете использовать пакеты SDK на различных языках для создания собственного приложения. Мы также предоставляем расширения функций, позволяющие легко создавать бессерверные приложения.

Используйте следующие ресурсы, чтобы приступить к созданию собственного приложения:

Руководство. Публикация и подписка на сообщения в Azure Web PubSub

Руководство по созданию чат-комнаты с помощью Azure Web PubSub

Руководство. Использование поддерживаемого службой подпротокола для потоковой передачи клиента

Руководство по созданию бессерверного чата с помощью Функций Azure и Web PubSub

Руководство по настройке прослушивателя событий

Играть с демонстрациями в режиме реального времени

Другие примеры Azure Web PubSub