Hızlı Başlangıç: Azure Web PubSub hizmeti SDK'sını kullanarak iletileri yayımlama

Azure Web PubSub, WebSocket istemcilerini yönetmenize yardımcı olur. Bu hızlı başlangıçta, Azure Web PubSub hizmeti SDK'sını kullanarak WebSocket istemcilerine nasıl ileti yayımlayabileceğiniz gösterilmektedir.

Önkoşullar

• Azure aboneliğiniz yoksa ücretsiz bir hesap oluşturun.
• Bash ve PowerShell komut kabuğu. Python, JavaScript ve Java örnekleri için Bash komut kabuğu gerekir.
• VSCode gibi bir dosya düzenleyicisi.
• Azure CLI: Azure CLI'yi yükleme

Projeyi yerel bir makinede oluşturuyorsanız, kullandığınız dilin bağımlılıklarını yüklemeniz gerekir:

C#

.NET Core SDK'sını aspnetcore ve ve dotnet çalışma zamanını yükleyin.

.NET Core

JavaScript

Node.js

Python

Python

Java

• Java Geliştirme Seti (JDK)
• Apache Maven

1. Kurulum

CLI'dan Azure'da oturum açmak için aşağıdaki komutu çalıştırın ve istemleri izleyerek kimlik doğrulama işlemini tamamlayın. Cloud Shell kullanıyorsanız oturum açmanız gerekmez.

az login

Yükseltme komutuyla CLI'nın en son sürümünü çalıştırdığınızdan emin olun.

az upgrade

Ardından, ile az upgradeyüklü değilse CLI için Azure Web PubSub uzantısını yükleyin veya güncelleştirin.

az extension add --name webpubsub --upgrade

1. Kaynak grubu oluşturma

Aşağıdaki ortam değişkenlerini ayarlayın. Yer tutucuyu <> benzersiz bir Web PubSub adıyla değiştirin.

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 projesi için bir kaynak grubu oluşturun.

Bash

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

Azure PowerShell

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

2. Web PubSub hizmet örneğini dağıtma

az webpubsub create Web PubSub hizmet örneği oluşturmak ve dağıtmak için komutunu kullanın.

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

Hizmetin bağlantı dizesini kaydedin. Bağlantı dizesi, hizmet SDK'sı tarafından iletileri yayımlamak için kullanılır.

Önemli

Üretim ortamında, Azure Key Vault kullanarak bağlantı dizelerini güvenli bir şekilde depolamanız gerekir.

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. İstemciyi hizmet örneğine bağlama

Web PubSub istemcisi oluşturun. İstemci, sonlandırılana kadar hizmetle bağlantı kurar.

az webpubsub client Hizmete webSocket istemci bağlantısı başlatmak için komutunu kullanın. İstemciler her zaman bir hub'a bağlanır, bu nedenle istemcinin bağlanabilmesi için bir hub adı sağlayın.

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 hizmetine bağlantı, istemcinin artık başarıyla bağlandığını belirten bir JSON iletisi gördüğünüzde kurulur ve benzersiz connectionIdbir atanır:

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

4. Hizmet SDK'sı kullanarak iletileri yayımlama

Hub'a bağlı tüm istemcilere ileti yayımlamak için Azure Web PubSub SDK'sını kullanacaksınız. C#, JavaScript, Python ve Java arasında seçim yapabilirsiniz. Her dilin bağımlılıkları bu dilin adımlarında yüklenir. Python, JavaScript ve Java, bu hızlı başlangıçtaki komutları çalıştırmak için bir bash kabuğu gerektirir.

projeyi iletileri yayımlayacak şekilde ayarlama

1. Bu proje için yeni bir komut kabuğu açın.

2. bağlantı dizesini istemci kabuğundan kaydedin. Yer tutucuyu <your_connection_string> önceki bir adımda görüntülediğiniz bağlantı dizesiyle değiştirin.

   Bash

   connection_string="<your_connection_string>"
   

   Azure PowerShell

   $connection_string = "<your_connection_string>"
   

3. Şimdi projenizin dilini seçin.

C#

1. adlı yeni bir proje publisher ekleyin ve SDK paketi Azure.Messaging.WebPubSub.

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

2. Program.cs İstemcilere ileti göndermek için sınıfını WebPubSubServiceClient kullanmak için dosyasını güncelleştirin. Dosyasındaki Program.cs kodu aşağıdaki kodla değiştirin.

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

   Çağrı, hub'daki service.SendToAllAsync() tüm bağlı istemcilere bir ileti gönderir.

3. Hizmete bir ileti yayımlamak için aşağıdaki komutu çalıştırın.

   dotnet run $connection_string "myHub1" "Hello World"
   

4. Web PubSub istemcisini içeren önceki komut kabuğu alınan iletiyi gösterir.

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

JavaScript

1. Bu proje için adlı publisher yeni bir klasör oluşturun ve gerekli bağımlılıkları yükleyin:

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

2. Hizmete bir ileti yayımlamak için Azure Web PubSub SDK'sını kullanın. Kodu içeren bir publish.js dosya oluşturun:

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

   Çağrı yalnızca sendToAll() bir hub'daki tüm bağlı istemcilere bir ileti gönderir.

3. Hizmete bir ileti yayımlamak için aşağıdaki komutu çalıştırın:

   export WebPubSubConnectionString=$connection_string
   node publish "Hello World"
   

4. Web PubSub istemcisini içeren önceki komut kabuğu alınan iletiyi gösterir.

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

Python

1. Bu proje için adlı publisher yeni bir klasör oluşturun ve gerekli bağımlılıkları yükleyin:

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

2. Hizmete bir ileti yayımlamak için Azure Web PubSub SDK'sını kullanın. Aşağıdaki kodla bir publish.py dosya oluşturun:

   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)
   

   yöntemi, service.send_to_all() iletiyi bir hub'daki tüm bağlı istemcilere gönderir.

3. Hizmete bir ileti yayımlamak için aşağıdaki komutu çalıştırın:

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

4. Web PubSub istemcisini içeren önceki komut kabuğu alınan iletiyi gösterir.

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

Java

1. Maven kullanarak adlı webpubsub-quickstart-publisher yeni bir konsol uygulaması oluşturun ve webpubsub-quickstart-publisher dizinine gidin:

   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. Azure Web PubSub SDK'sını düğümüne dependenciespom.xmlekleyin:

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

3. src/main/java/com/webpubsub/quickstart dizinine gidin.

4. App.java dosyasındaki içeriği aşağıdaki kodla değiştirin:

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

   Bu kod, hizmete bir ileti yayımlamak için Azure Web PubSub SDK'sını kullanır. Çağrı, service.sendToAll() bir hub'daki tüm bağlı istemcilere bir ileti gönderir.

5. pom.xml dosyasını içeren webpubsub-quickstart-publisher dizinini döndürüp aşağıdaki mvn komutu kullanarak projeyi derleyin.

   mvn compile
   

6. Paketi oluşturun.

   mvn package
   

7. mvn Aşağıdaki komutu çalıştırarak uygulamayı yürüterek hizmete bir ileti yayımlayın:

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

8. Web PubSub istemcisini içeren önceki komut kabuğu alınan iletiyi gösterir.

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

Temizleme

Bu hızlı başlangıçta oluşturduğunuz kaynakları, bunları içeren kaynak grubunu silerek silebilirsiniz.

Bash

az group delete --name $RESOURCE_GROUP --yes

Azure PowerShell

d

az group delete --name $ResourceGroup --yes

Sonraki adımlar

Bu hızlı başlangıçta, Web PubSub hizmetine bağlanma ve bağlı istemcilere ileti yayımlama hakkında temel bir fikir sağlanır.

Gerçek dünyadaki uygulamalarda, çeşitli dillerde SDK'ları kullanarak kendi uygulamanızı oluşturabilirsiniz. Ayrıca sunucusuz uygulamaları kolayca oluşturmanız için İşlev uzantıları da sağlıyoruz.

Kendi uygulamanızı oluşturmaya başlamak için şu kaynakları kullanın:

Öğretici: Azure Web PubSub'da iletileri yayımlama ve iletilere abone olma

Öğretici: Azure Web PubSub ile basit bir sohbet odası oluşturma

Öğretici: İstemci akışı için hizmet tarafından desteklenen bir altprotocol kullanma

Öğretici: Azure İşlevleri ve Web PubSub ile sunucusuz sohbet oluşturma

Öğretici: Olay dinleyicisi yapılandırma

Canlı tanıtımlarla oynama

Diğer Azure Web PubSub örneklerini keşfedin