다음을 통해 공유


자습서: WebSocket API 및 Azure Web PubSub 서비스 SDK를 사용하여 메시지 게시 및 구독

Azure Web PubSub 서비스를 사용하면 실시간 웹 메시징 애플리케이션을 쉽게 빌드할 수 있습니다. 이 자습서에서는 WebSocket API를 사용하여 서비스를 구독하고 Web PubSub 서비스 SDK를 사용하여 메시지를 게시하는 방법을 알아봅니다.

이 자습서에서는 다음을 하는 방법을 알아볼 수 있습니다.

  • Web PubSub 서비스 인스턴스 만들기
  • WebSocket 연결을 설정하기 위한 전체 URL 생성
  • 표준 WebSocket 프로토콜을 사용하여 메시지를 받을 Web PubSub 구독자 클라이언트 만들기
  • Web PubSub 서비스 SDK를 사용하여 메시지를 게시하는 Web PubSub 게시자 클라이언트 만들기

필수 조건

Bash 셸 대신 Windows cmd.exe 명령 셸을 사용하여 이 자습서의 명령을 실행할 수 있습니다.

로컬 컴퓨터에서 프로젝트를 만드는 경우 사용 중인 언어에 대한 종속성을 설치해야 합니다.

환경 준비

로컬 개발을 위한 Azure CLI 설정

다음 단계에 따라 Azure CLI 및 프로젝트 환경을 설정합니다.

  1. 명령 셸을 엽니다.

  2. 최신 버전의 Azure CLI로 업그레이드합니다.

    az upgrade
    
  3. Web PubSub용 Azure CLI 확장을 설치합니다.

    az extension add --name webpubsub
    
  4. Azure CLI에 로그인합니다. 프롬프트에 따라 Azure 자격 증명을 입력합니다.

    az login
    

리소스 그룹 만들기

리소스 그룹은 Azure 리소스가 배포 및 관리되는 논리적 컨테이너입니다. az group create 명령을 사용하여 eastus 위치에서 myResourceGroup이라는 리소스 그룹을 만듭니다.

az group create --name myResourceGroup --location EastUS

1. Azure Web PubSub 인스턴스 만들기

Web PubSub 인스턴스 만들기

Azure CLI az webpubsub create 명령을 사용하여 만든 리소스 그룹에 Web PubSub를 만듭니다. 다음 명령은 리소스 그룹 myResourceGroup 아래에 Free Web PubSub 리소스를 만듭니다.EastUS

각 Web PubSub 리소스에는 고유한 이름이 있어야 합니다. unique-resource-name>을 다음 명령에서 Web PubSub 인스턴스의 이름으로 바꿉<니다.

az webpubsub create --resource-group myResourceGroup --name <your-unique-resource-name> --location EastUS --sku Free_F1

이 명령의 출력에는 새로 만든 리소스의 속성이 표시됩니다. 아래에 나열된 두 개의 속성을 기록합니다.

  • name: 위의 매개 변수에서 --name 제공한 Web PubSub 이름입니다.
  • hostName: 이 예제에서 호스트 이름은 <your-unique-resource-name>.webpubsub.azure.com/입니다.

이때 Azure 계정은 이 새 리소스에서 모든 작업을 수행할 권한이 있는 유일한 계정입니다.

연결 문자열 가져오기

Important

연결 문자열에는 애플리케이션이 Azure Web PubSub 서비스에 액세스하는 데 필요한 권한 부여 정보가 포함됩니다. 연결 문자열 내의 액세스 키는 서비스의 루트 암호와 비슷합니다. 프로덕션 환경에서는 항상 액세스 키를 보호해야 합니다. Azure Key Vault를 사용하여 키를 안전하게 관리하고 회전합니다. 액세스 키를 다른 사용자에게 배포하거나 하드 코딩하거나 다른 사용자가 액세스할 수 있는 일반 텍스트로 저장하지 않도록 합니다. 키가 손상되었다고 생각되면 키를 교체하세요.

Azure CLI az webpubsub key 명령을 사용하여 서비스의 ConnectionString을 가져옵니다. <your-unique-resource-name> 자리 표시자를 Azure Web PubSub 인스턴스의 이름으로 바꿉니다.

az webpubsub key show --resource-group myResourceGroup --name <your-unique-resource-name> --query primaryConnectionString --output tsv

나중에 사용할 수 있게 연결 문자열을 복사합니다.

구독자 클라이언트 만들기

클라이언트는 JWT(JSON 웹 토큰) 인증을 사용하여 표준 WebSocket 프로토콜을 통해 Azure Web PubSub 서비스에 연결합니다. 서비스 SDK는 토큰을 생성하는 도우미 메서드를 제공합니다. 이 자습서에서 구독자는 커넥트ionString에서 토큰을 직접 생성합니다. 실제 애플리케이션에서 서버 쪽 애플리케이션은 일반적으로 인증/권한 부여 워크플로를 처리합니다. 워크플로를 더 잘 이해하려면 채팅 앱 빌드 자습서 를 참조하세요.

  1. 먼저 이 프로젝트에 대해 명명된 subscriber 프로젝트 디렉터리를 만들고 필요한 종속성을 설치합니다.

    • Websocket.Client 패키지는 WebSocket 연결을 지원하는 타사 패키지입니다. WebSocket을 지원하는 모든 API/라이브러리를 사용할 수 있습니다.
    • SDK 패키지 Azure.Messaging.WebPubSub 는 JWT 토큰을 생성하는 데 도움이 됩니다.
    mkdir subscriber
    cd subscriber
    dotnet new console
    dotnet add package Websocket.Client --version 4.3.30
    dotnet add package Azure.Messaging.WebPubSub --version 1.0.0
    
  2. 서비스의 코드를 Program.cs 서비스에 연결할 다음 코드로 바꿉다.

    using System;
    using System.Threading.Tasks;
    
    using Azure.Messaging.WebPubSub;
    
    using Websocket.Client;
    
    namespace subscriber
    {
        class Program
        {
            static async Task Main(string[] args)
            {
                if (args.Length != 2)
                {
                    Console.WriteLine("Usage: subscriber <connectionString> <hub>");
                    return;
                }
                var connectionString = args[0];
                var hub = args[1];
    
                // Either generate the URL or fetch it from server or fetch a temp one from the portal
                var serviceClient = new WebPubSubServiceClient(connectionString, hub);
                var url = serviceClient.GetClientAccessUri();
    
                using (var client = new WebsocketClient(url))
                {
                    // Disable the auto disconnect and reconnect because the sample would like the client to stay online even no data comes in
                    client.ReconnectTimeout = null;
                    client.MessageReceived.Subscribe(msg => Console.WriteLine($"Message received: {msg}"));
                    await client.Start();
                    Console.WriteLine("Connected.");
                    Console.Read();
                }
            }
        }
    }
    
    

    이 코드는 Web PubSub의 허브에 연결된 WebSocket 연결을 만듭니다. 허브는 클라이언트 그룹에 메시지를 게시할 수 있는 Web PubSub의 논리 단위입니다. 주요 개념 에는 Web PubSub에서 사용되는 용어에 대한 자세한 설명이 포함되어 있습니다.

    Web PubSub 서비스는 JWT(JSON 웹 토큰) 인증을 사용합니다. 샘플 코드는 Web PubSub SDK를 사용하여 WebPubSubServiceClient.GetClientAccessUri() 유효한 액세스 토큰이 있는 전체 URL을 포함하는 서비스에 대한 URL을 생성합니다.

    연결이 설정되면 클라이언트는 WebSocket 연결을 통해 메시지를 받습니다. 클라이언트는 들어오는 메시지를 수신 대기하는 데 사용합니다 client.MessageReceived.Subscribe(msg => ...)); .

  3. 구독자를 시작하려면 앞에서 복사한 연결 문자열 대체하여 다음 명령을 <Web-PubSub-connection-string> 실행합니다.

    dotnet run <Web-PubSub-connection-string> "myHub1"
    

2. 서비스 SDK를 사용하여 메시지 게시

Azure Web PubSub SDK를 사용하여 연결된 클라이언트에 메시지를 게시하는 게시자를 만듭니다. 이 프로젝트의 경우 다른 명령 셸을 열어야 합니다.

  1. 먼저 이름이 지정된 publisher 프로젝트 디렉터리를 만들고 필요한 종속성을 설치합니다.

    mkdir publisher
    cd publisher
    dotnet new console
    dotnet add package Azure.Messaging.WebPubSub
    
  2. 클래스를 Program.cs 사용하도록 WebPubSubServiceClient 파일을 업데이트하고 클라이언트에 메시지를 보냅니다.

    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];
    
                // Either generate the token or fetch it from server or fetch a temp one from the portal
                var serviceClient = new WebPubSubServiceClient(connectionString, hub);
                await serviceClient.SendToAllAsync(message);
            }
        }
    }
    
    

    SendToAllAsync()를 호출하면 허브에 있는 모든 연결된 클라이언트에 메시지가 전송됩니다.

  3. 다음 명령을 실행하여 메시지를 보냅니다. 앞에서 복사한 연결 문자열 바꿉 <Web-PubSub-connection-string> 다.

    dotnet run <Web-PubSub-connection-string> "myHub1" "Hello World"
    
  4. 구독자의 명령 셸에서 메시지를 받았는지 확인합니다.

    Message received: Hello World
    

정리

이 빠른 시작에서 만든 리소스를 포함하는 리소스 그룹을 삭제하여 삭제할 수 있습니다.

az group delete --name myResourceGroup --yes

Azure Cloud Shell을 계속 사용할 계획이 없는 경우 연결된 스토리지 계정이 포함된 리소스 그룹을 삭제하여 비용이 누적되는 것을 방지할 수 있습니다. 리소스 그룹의 이름이 지정 cloud-shell-storage-<your-region>됩니다. 다음 명령을 실행하여 Cloud Shell 그룹 이름으로 바꿉 <CloudShellResourceGroup> 니다.

az group delete --name <CloudShellResourceGroup> --yes

주의

리소스 그룹을 삭제하면 이 자습서의 범위를 벗어나 만든 리소스를 포함하여 모든 리소스가 삭제됩니다.

다음 단계

이 자습서에서는 Web PubSub 서비스에 연결하고 연결된 클라이언트에 메시지를 게시하는 방법에 대한 기본 아이디어를 제공합니다.

다른 자습서를 확인하여 서비스를 사용하는 방법을 자세히 알아보세요.