Bibliothèque de client Azure Web PubSub pour Python

Remarque

Des détails sur les termes utilisés ici sont décrits dans l’article sur les concepts clés.

Le Kit de développement logiciel (SDK) côté client vise à accélérer le flux de travail du développeur ; plus précisément,

  • simplifie la gestion des connexions clientes
  • simplifie l’envoi de messages entre les clients
  • réessayer automatiquement après des suppressions involontaires de la connexion cliente
  • remet de manière fiable les messages en nombre et dans l’ordre après la récupération à partir des suppressions de connexion

Comme illustré dans le diagramme, vos clients établissent des connexions WebSocket avec votre ressource Web PubSub.

Screenshot showing clients establishing WebSocket connection with a Web PubSub resource

Bien démarrer

Prérequis

1. Installez le package azure-messaging-webpubsubclient

pip install azure-messaging-webpubsubclient

2. Connecter avec votre ressource Web PubSub

Un client utilise une connexion et une Client Access URL authentification auprès du service, qui suit un modèle de wss://<service_name>.webpubsub.azure.com/client/hubs/<hub_name>?access_token=<token>. Un client peut avoir quelques façons d’obtenir le Client Access URL. Pour ce démarrage rapide, vous pouvez copier et coller un à partir de Portail Azure affiché.

Screenshot showing how to get Client Access Url on Azure portal

Comme indiqué dans le diagramme, le client dispose des autorisations nécessaires pour envoyer et joindre un groupe spécifique nommé group1.

from azure.messaging.webpubsubclient import WebPubSubClient

client = WebPubSubClient("<<client-access-url>>")
with client:
    # The client can join/leave groups, send/receive messages to and from those groups all in real-time
    ...

3. Joindre des groupes

Un client peut uniquement recevoir des messages de groupes qu’il a joints et vous devez ajouter un rappel pour spécifier la logique lors de la réception de messages.

# ...continues the code snippet from above

# Registers a listener for the event 'group-message' early before joining a group to not miss messages
group_name = "group1";
client.on("group-message", lambda e: print(f"Received message: {e.data}"));

# A client needs to join the group it wishes to receive messages from
client.join_group(groupName);

4. Envoyer des messages à un groupe

# ...continues the code snippet from above

# Send a message to a joined group
client.send_to_group(group_name, "hello world", "text");

# In the Console tab of your developer tools found in your browser, you should see the message printed there.

Exemples

Ajouter des rappels pour connectedles événements disconnected et stopped les événements

  1. Lorsqu’un client est correctement connecté à votre ressource Web PubSub, l’événement connected est déclenché.

    client.on("connected", lambda e: print(f"Connection {e.connection_id} is connected"))
    
  2. Lorsqu’un client est déconnecté et ne parvient pas à récupérer la connexion, l’événement disconnected est déclenché.

    client.on("disconnected", lambda e: print(f"Connection disconnected: {e.message}"))
    
  3. L’événement stopped est déclenché lorsque le client est déconnecté et que le client cesse de tenter de se reconnecter. Cela se produit généralement après l’appel client.stop() , ou auto_reconnect est désactivé ou une limite spécifiée pour essayer de se reconnecter a atteint. Si vous souhaitez redémarrer le client, vous pouvez appeler client.start() l’événement arrêté.

    client.on("stopped", lambda : print("Client has stopped"))
    

Un client consomme des messages à partir du serveur d’applications ou des groupes joints

Un client peut ajouter des rappels pour consommer des messages à partir de votre serveur d’applications ou groupes. Notez que, pour group-message l’événement, le client ne peut recevoir que des messages de groupe qu’il a joints.

# Registers a listener for the "server-message". The callback is invoked when your application server sends message to the connectionID, to or broadcast to all connections.
client.on("server-message", lambda e: print(f"Received message {e.data}"))

# Registers a listener for the "group-message". The callback is invoked when the client receives a message from the groups it has joined.
client.on("group-message", lambda e: print(f"Received message from {e.group}: {e.data}"))

Gérer l’échec de jointeur

Lorsqu’un client est déconnecté et ne parvient pas à récupérer, tous les contextes de groupe sont propre dans votre ressource Web PubSub. Cela signifie que lorsque le client se reconnecte, il doit rejoindre des groupes. Par défaut, le client a l’option auto_rejoin_groups activée.

Toutefois, vous devez connaître auto_rejoin_groupsles limitations de l’application.

  • Le client peut uniquement rejoindre des groupes qu’il est joint à l’origine par le code client et non par le code côté serveur.
  • Les opérations « rejoindre un groupe » peuvent échouer en raison de diverses raisons, par exemple, le client n’a pas l’autorisation de rejoindre les groupes. Dans ce cas, vous devez ajouter un rappel pour gérer cette défaillance.
# By default auto_rejoin_groups=True. You can disable it by setting to False.
client = WebPubSubClient("<client-access-url>", auto_rejoin_groups=True);

# Registers a listener to handle "rejoin-group-failed" event
client.on("rejoin-group-failed", lambda e: print(f"Rejoin group {e.group} failed: {e.error}"))

Opération et nouvelle tentative

Par défaut, l’opération telle que client.join_group(), client.leave_group(), client.send_to_group()a client.send_event() trois nouvelles tentatives. Vous pouvez configurer par le biais des arguments de mot clé. Si toutes les nouvelles tentatives ont échoué, une erreur est levée. Vous pouvez continuer à réessayer en transmettant les mêmes ack_id tentatives que les nouvelles tentatives précédentes afin que le service Web PubSub puisse dédupliquer l’opération.

try:
  client.join_group(group_name)
except SendMessageError as e:
  client.join_group(group_name, ack_id=e.ack_id)

Dépannage

Activer les journaux d’activité

Vous pouvez définir la variable d’environnement suivante pour afficher les journaux de débogage quand vous utilisez cette bibliothèque.

export AZURE_LOG_LEVEL=verbose

Pour obtenir des instructions plus détaillées sur l’activation des journaux, consultez les documents relatifs au package @azure/logger.

Trace dynamique

Utilisez l’outil Live Trace à partir de Portail Azure pour inspecter le trafic des messages en direct via votre ressource Web PubSub.