Uruchamianie połączenia protokołu WebSocket z usługą Azure Web PubSub

Klienci łączą się z usługą Azure Web PubSub przy użyciu standardowego protokołu WebSocket . Aby napisać klienta usługi dla usługi, można użyć języków, które obsługują klienta protokołu WebSocket. W tym artykule przedstawiono kilka przykładów klientów protokołu WebSocket w różnych językach.

Autoryzacja

Usługa Web PubSub używa tokenu internetowego JSON (JWT) do sprawdzania poprawności i autoryzacji klientów. Klienci mogą umieścić token w parametrze access_token zapytania lub umieścić go w Authorization nagłówku podczas nawiązywania połączenia z usługą.

Zazwyczaj klient komunikuje się najpierw z serwerem aplikacji, aby uzyskać adres URL usługi i token. Następnie klient otwiera połączenie protokołu WebSocket z usługą przy użyciu adresu URL i odbieranego tokenu.

Portal udostępnia również narzędzie do dynamicznego generowania adresu URL klienta przy użyciu tokenu. To narzędzie może być przydatne do szybkiego testowania.

Uwaga

Pamiętaj, aby uwzględnić tylko niezbędne role podczas generowania tokenu.

W poniższych sekcjach, aby uprościć przykładowy przepływ pracy, używamy tego tymczasowo wygenerowanego adresu URL z portalu, aby klient nawiązał połączenie. Służymy <Client_URL_From_Portal> do reprezentowania wartości. Token wygenerowany domyślnie wygasa za 60 minut, więc nie zapomnij ponownie wygenerować tokenu po wygaśnięciu tokenu.

Usługa obsługuje dwa typy klientów protokołu WebSocket: jeden jest prostym klientem protokołu WebSocket, a drugi jest klientem PubSub WebSocket. W tym miejscu pokazano, jak te dwa rodzaje klientów łączą się z usługą. Aby uzyskać więcej informacji o tych klientach, zobacz WebSocket client protocols for Azure Web PubSub (Protokoły klienta protokołu WebSocket dla usługi Azure Web PubSub).

Dependency

W przeglądarce

W większości nowoczesnych przeglądarek WebSocket interfejs API jest natywnie obsługiwany.

Node.js

• Node.js 12.x lub nowszy
• npm install ws

Python

• Python
• pip install websockets

C#

• .NET Core 2.1 lub nowszy
• dotnet add package Websocket.Client
  • Websocket.Client to klient protokołu WebSocket innej firmy z wbudowanym ponownym połączeniem i obsługą błędów.

Java

• Zestaw Java Development Kit (JDK) w wersji 8 lub nowszej.
• Apache Maven.

Prosty klient protokołu WebSocket

W przeglądarce

script Wewnątrz bloku strony HTML:

<script>
    // Don't forget to replace this <Client_URL_From_Portal> with the value fetched from the portal
    let ws = new WebSocket("<Client_URL_From_Portal>");
    ws.onopen = () => {
        // Do things when the WebSocket connection is established
    };

    ws.onmessage = event => {
        // Do things when messages are received.
    };
</script>

Node.js

const WebSocket = require('ws');
// Don't forget to replace this <Client_URL_From_Portal> with the value fetched from the portal
const client = new WebSocket("<Client_URL_From_Portal>");
client.on('open', () => {
     // Do things when the WebSocket connection is established
});
client.on('message', msg => {
     // Do things when messages are received.
});

Python

import asyncio
import websockets

async def hello():
    # Don't forget to replace this <Client_URL_From_Portal> with the value fetched from the portal
    uri = '<Client_URL_From_Portal>'
    async with websockets.connect(uri) as ws:
        while True:
            await ws.send('hello')
            greeting = await ws.recv()
            print(greeting)

asyncio.get_event_loop().run_until_complete(hello())

C#

using System;
using System.IO;
using System.Text;
using System.Threading.Tasks;
using Websocket.Client;

namespace subscriber
{
    class Program
    {
        static async Task Main(string[] args)
        {
            // Don't forget to replace this <Client_URL_From_Portal> with the value fetched from the portal
            using (var client = new WebsocketClient(new Uri("<Client_URL_From_Portal>")))
            {
                // Disable the auto disconnect and reconnect because the sample would like the client to stay online even if no data comes in
                client.ReconnectTimeout = null;
                client.MessageReceived.Subscribe(msg => Console.WriteLine($"Message received: {msg}"));
                await client.Start();
                Console.WriteLine("Connected.");
                Console.Read();
            }
        }
    }
}

Java

package client;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.WebSocket;
import java.util.concurrent.CompletionStage;

/**
 * A simple WebSocket Client.
 *
 */
public final class SimpleClient {
    private SimpleClient() {
    }

    /**
     * Starts a simple WebSocket connection.
     * @param args The arguments of the program.
     */
    public static void main(String[] args) throws Exception {
        // Don't forget to replace this <Client_URL_From_Portal> with the value fetched from the portal
        WebSocket ws = HttpClient.newHttpClient().newWebSocketBuilder()
                .buildAsync(URI.create("<Client_URL_From_Portal>"), new WebSocketClient()).join();
        System.in.read();
    }

    private static final class WebSocketClient implements WebSocket.Listener {
        private WebSocketClient() {
        }

        @Override
        public void onOpen(WebSocket webSocket) {
            System.out.println("onOpen using subprotocol " + webSocket.getSubprotocol());
            WebSocket.Listener.super.onOpen(webSocket);
        }

        @Override
        public CompletionStage<?> onText(WebSocket webSocket, CharSequence data, boolean last) {
            System.out.println("onText received " + data);
            return WebSocket.Listener.super.onText(webSocket, data, last);
        }

        @Override
        public void onError(WebSocket webSocket, Throwable error) {
            System.out.println("Bad day! " + webSocket.toString());
            WebSocket.Listener.super.onError(webSocket, error);
        }
    }
}

Klient protokołu WebSocket usługi PubSub

W przeglądarce

script Wewnątrz bloku strony HTML:

<script>
    // Don't forget to replace this <Client_URL_From_Portal> with the value fetched from the portal
    let ws = new WebSocket("<Client_URL_From_Portal>", 'json.webpubsub.azure.v1');
    ws.onopen = () => {
        // Do things when the WebSocket connection is established
    };

    ws.onmessage = event => {
        // Do things when messages are received.
    };
</script>

Node.js

const WebSocket = require('ws');
// Don't forget to replace this <Client_URL_From_Portal> with the value fetched from the portal
const client = new WebSocket("<Client_URL_From_Portal>", "json.webpubsub.azure.v1");
client.on('open', () => {
     // Do things when the WebSocket connection is established
});
client.on('message', msg => {
     // Do things when messages are received.
});

Python

import asyncio
import websockets

async def join_group():
    # Don't forget to replace this <Client_URL_From_Portal> with the value fetched from the portal
    uri = '<Client_URL_From_Portal>'
    async with websockets.connect(uri, subprotocols=['json.webpubsub.azure.v1']) as ws:
        await ws.send('{"type":"joinGroup","ackId":1,"group":"group1"}')
        return await ws.recv()

print(asyncio.get_event_loop().run_until_complete(join_group()))

C#

using System;
using System.IO;
using System.Net.WebSockets;
using System.Text;
using System.Threading.Tasks;
namespace subscriber
{
    class Program
    {
        static async Task Main(string[] args)
        {
            // Don't forget to replace this <Client_URL_From_Portal> with the value fetched from the portal
            using (var client = new WebsocketClient(new Uri("<Client_URL_From_Portal>"), () =>
            {
                var inner = new ClientWebSocket();
                inner.Options.AddSubProtocol("json.webpubsub.azure.v1");
                return inner;
            }))
            {
                // Disable the auto disconnect and reconnect because the sample would like the client to stay online even if no data comes in
                client.ReconnectTimeout = null;
                client.MessageReceived.Subscribe(msg => Console.WriteLine($"Message received: {msg}"));
                await client.Start();
                Console.WriteLine("Connected.");
                Console.Read();
            }
        }
    }
}

Java

package client;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.WebSocket;
import java.util.concurrent.CompletionStage;

/**
 * A PubSub WebSocket Client.
 *
 */
public final class SubprotocolClient {
    private SubprotocolClient() {
    }

    /**
     * Starts a PubSub WebSocket connection.
     * @param args The arguments of the program.
     */
    public static void main(String[] args) throws Exception {
        // Don't forget to replace this <Client_URL_From_Portal> with the value fetched from the portal
        WebSocket ws = HttpClient.newHttpClient().newWebSocketBuilder().subprotocols("json.webpubsub.azure.v1")
                .buildAsync(URI.create("<Client_URL_From_Portal>"), new WebSocketClient()).join();

        ws.sendText("{\"type\":\"joinGroup\",\"ackId\":1,\"group\":\"group1\"}", true);
        System.in.read();
    }

    private static final class WebSocketClient implements WebSocket.Listener {
        private WebSocketClient() {
        }

        @Override
        public void onOpen(WebSocket webSocket) {
            System.out.println("onOpen using subprotocol " + webSocket.getSubprotocol());
            WebSocket.Listener.super.onOpen(webSocket);
        }

        @Override
        public CompletionStage<?> onText(WebSocket webSocket, CharSequence data, boolean last) {
            System.out.println("onText received " + data);
            return WebSocket.Listener.super.onText(webSocket, data, last);
        }

        @Override
        public void onError(WebSocket webSocket, Throwable error) {
            System.out.println("Bad day! " + webSocket.toString());
            WebSocket.Listener.super.onError(webSocket, error);
        }
    }
}

Następne kroki

W tym artykule przedstawiono sposób nawiązywania połączenia z usługą przy użyciu adresu URL wygenerowanego w portalu. Aby zobaczyć, jak klienci komunikują się z serwerem aplikacji, aby uzyskać adres URL w rzeczywistych aplikacjach, przeczytaj te samouczki i zapoznaj się z przykładami.

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

Samouczek: przesyłanie strumieniowe klienta przy użyciu podprotocol obsługiwanej przez usługę

Zapoznaj się z więcej przykładów usługi Azure Web PubSub