Créer un système Pub/Sub un à plusieurs

Ce tutoriel vous explique comment configurer un ensemble d'applications qui communiquent en envoyant des messages via Pub/Sub plutôt que via des RPC synchrones. En découplant les applications, la messagerie:

• rend les applications plus robustes ;
• peut simplifier le développement.

Par exemple, l'appelant (éditeur) n'a pas besoin du destinataire (abonné) pour être fonctionnel et disponible. Le diffuseur envoie un message à Pub/Sub. L'éditeur n'a pas besoin de savoir quelles applications d'abonnés ni combien d'entre elles doivent recevoir le message. Par conséquent, on peut compter sur le service pour distribuer le message à une ou plusieurs applications d'abonné dès qu'elles sont disponibles.

Présentation du système

Dans ce tutoriel, vous démarrez une application d'éditeur qui envoie le message "Hello, World!" à deux abonnés à l'aide d'une communication de type un à plusieurs, comme illustré dans le schéma suivant:

Les deux applications d'abonné utilisent le même code, mais vous les démarrez à des moments différents. Cela montre comment Pub/Sub permet la communication asynchrone. Pour créer ce système, procédez comme suit:

1. Créez un compte de service IAM que les applications utilisent pour l'authentification.
2. Configurez les autorisations Cloud IAM.
3. Créer un sujet et un abonnement Pub/Sub
4. Démarrez trois applications indépendantes : un éditeur et deux abonnés.

Avant de commencer

1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.
2. Installez Google Cloud CLI.

3. Pour initialiser gcloudCLI, exécutez la commande suivante :

   gcloud init

4. Create or select a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   • Create a Google Cloud project:

     gcloud projects create PROJECT_ID

     Replace PROJECT_ID with a name for the Google Cloud project you are creating.

   • Select the Google Cloud project that you created:

     gcloud config set project PROJECT_ID

     Replace PROJECT_ID with your Google Cloud project name.

5. Vérifiez que la facturation est activée pour votre projet Google Cloud.

6. Activer l'API Pub/Sub :

   gcloud services enable pubsub.googleapis.com

7. Créez des identifiants d'authentification locaux pour votre compte Google :

   gcloud auth application-default login

8. Attribuez des rôles à votre compte Google. Exécutez la commande suivante une fois pour chacun des rôles IAM suivants : roles/pubsub.publisher, roles/pubsub.subscriber

   gcloud projects add-iam-policy-binding PROJECT_ID --member="user:EMAIL_ADDRESS" --role=ROLE

   • en remplaçant PROJECT_ID par l'ID de votre projet :
   • Remplacez EMAIL_ADDRESS par votre adresse e-mail.
   • Remplacez ROLE par chaque rôle individuel.
9. Installez Google Cloud CLI.

10. Pour initialiser gcloudCLI, exécutez la commande suivante :

    gcloud init

11. Create or select a Google Cloud project.

    Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

    • Create a Google Cloud project:

      gcloud projects create PROJECT_ID

      Replace PROJECT_ID with a name for the Google Cloud project you are creating.

    • Select the Google Cloud project that you created:

      gcloud config set project PROJECT_ID

      Replace PROJECT_ID with your Google Cloud project name.

12. Vérifiez que la facturation est activée pour votre projet Google Cloud.

13. Activer l'API Pub/Sub :

    gcloud services enable pubsub.googleapis.com

14. Créez des identifiants d'authentification locaux pour votre compte Google :

    gcloud auth application-default login

15. Attribuez des rôles à votre compte Google. Exécutez la commande suivante une fois pour chacun des rôles IAM suivants : roles/pubsub.publisher, roles/pubsub.subscriber

    gcloud projects add-iam-policy-binding PROJECT_ID --member="user:EMAIL_ADDRESS" --role=ROLE

    • en remplaçant PROJECT_ID par l'ID de votre projet :
    • Remplacez EMAIL_ADDRESS par votre adresse e-mail.
    • Remplacez ROLE par chaque rôle individuel.

Installer Python

Ce tutoriel utilise les bibliothèques clientes Pub/Sub, qui nécessitent Python 3.7 ou une version ultérieure. Suivez les instructions pour installer Python.

Configurer votre projet Pub/Sub

Pour gérer le flux de messages entre la publication et l'abonnement des applications, vous devez créer un sujet et deux abonnements différents.

Créer un sujet Pub/Sub

Créez un sujet avec l'ID hello_topic :

gcloud pubsub topics create hello_topic

Créer un abonnement Pub/Sub

Créez deux abonnements et associez-les à votre sujet.

Il s'agit d'un abonnement StreamingPull, qui est un type d'abonnement pull.

Abonnement 1

Créez un abonnement avec l'ID sub_one et associez-le à hello_topic.

gcloud pubsub subscriptions create sub_one --topic=hello_topic

Abonnement 2

Créez un abonnement avec l'ID sub_two et associez-le à hello_topic.

gcloud pubsub subscriptions create sub_two --topic=hello_topic

Construire le système de type un à plusieurs

Télécharger le code de l'éditeur et de l'abonné

1. Téléchargez les fichiers Pub/Sub Python nécessaires pour ce tutoriel.

    git clone https://github.com/googleapis/python-pubsub.git
   

2. Fermez tous les terminaux ouverts avant de continuer.

Configurer trois terminaux

1. Démarrez un terminal pour chaque application de tutoriel (un éditeur et deux abonnés). Pour plus de commodité, ce tutoriel appelle les terminaux suivants:

   • terminal publisher (éditeur)
   • terminal sub_one (abonné_1)
   • terminal sub_two (abonné_2)
   Remarque :Assurez-vous que les trois terminaux se trouvent dans le même répertoire que celui où vous avez téléchargé les fichiers Python Pub/Sub à l'étape précédente.

2. Dans le terminal éditeur, créez et activez un environnement virtuel Python nommé pyenv-qs.

   Bash

   python -m venv pyenv-qs
   source pyenv-qs/bin/activate
   

   PowerShell

   py -m venv pyenv-qs
   .\pyenv-qs\Scripts\activate
   

   Dans les terminaux sub_one et sub_two, exécutez la commande suivante:

   Bash

   source pyenv-qs/bin/activate
   

   PowerShell

   .\pyenv-qs\Scripts\activate
   

   Une fois que vous avez exécuté la commande d'activation, votre invite de commande inclut la valeur (pyenv-qs) $ suivante.

3. Dans le terminal publisher, installez la bibliothèque cliente Python pour Pub/Sub à l'aide de pip:

   python -m pip install --upgrade google-cloud-pubsub

4. Dans les trois terminaux, configurez une variable d'environnement avec votre ID de projet actuel. Cette commande gcloud détermine l'ID de projet sélectionné et le définit en tant que variable:

   Bash

   export PROJECT=`gcloud config get-value project`
   

   PowerShell

   $env:PROJECT=$(gcloud config get-value project)
   

5. Dans les trois terminaux, accédez au chemin d'accès au projet qui contient l'exemple de code.

   cd python-pubsub/samples/snippets/quickstart/
   

Démarrer les applications et observer le flux de messages

Démarrer l'application Abonné 1

Dans le terminal sub_one, démarrez Abonné 1 :

Bash

python sub.py $PROJECT sub_one

PowerShell

py sub.py $env:PROJECT sub_one

Une fois lancée, cette application ouvre une connexion de streaming bidirectionnelle avec le serveur. Pub/Sub distribue les messages via le flux.

Démarrer l'application Éditeur

Dans le terminal publisher, démarrez l'application Éditeur :

Bash

python pub.py $PROJECT hello_topic

PowerShell

py pub.py $env:PROJECT hello_topic

Une fois l'application d'éditeur démarrée, le système Pub/Sub effectue les opérations suivantes :

• L'application Éditeur envoie le message "Hello, World!" à Pub/Sub sans connaître les abonnements existants. Le serveur attribue également un ID de message.

• L'application Abonné 1 reçoit le message "Hello World", l'imprime et envoie un accusé de réception à Pub/Sub.

• L'application Éditeur imprime l'accusé de réception. Celui-ci indique à Pub/Sub que le message a bien été traité et qu'il n'a pas besoin d'être réexpédié à cet abonné sub_one ou à un autre.

Pub/Sub supprime le message de sub_one.

Démarrer l'application Abonné 2

Dans le terminal sub_two, démarrez Abonné 2 :

Bash

python sub.py $PROJECT sub_two

PowerShell

py sub.py $env:PROJECT sub_two

Cet abonné reçoit les messages remis à l'abonnement sub_two. Abonné 2 réutilise le script sub.py. La différence est qu'Abonné 2 n'est pas démarré avant que l'application Éditeur ait envoyé le message au sujet et aux abonnements. Lorsque l'application Éditeur appelait directement Abonné 2, l'application de publication devait attendre qu'Abonné 2 soit créé, sans quoi elle expirait. Pub/Sub gère cela en enregistrant le message pour Abonné 2.

Vous êtes maintenant prêt à développer avec Pub/Sub !

Comment ça s'est passé ?

Ça a marché !

Parfait ! Qu'avez-vous apprécié dans ce guide de démarrage rapide ? Que pourrions-nous améliorer ? N'hésitez pas à nous donner votre avis !

J'ai rencontré un problème.

Nous le regrettons. Expliquez-nous ce qu'il s'est passé. Notre objectif est de le corriger.

Des ressources et des liens supplémentaires sont disponibles sur la page d'assistance Pub/Sub.

Effectuer un nettoyage

1. Arrêtez toutes les applications en cours d'exécution.
2. Supprimez le répertoire de l'exemple de code de votre environnement local.

3. Supprimez le sujet.

   gcloud pubsub topics delete hello_topic
   

4. Supprimez les abonnements.

   gcloud pubsub subscriptions delete sub_one
   

   gcloud pubsub subscriptions delete sub_two
   

5. Arrêtez le projet du tutoriel dans la section IAM et administration de la console Google Cloud.

6. Facultatif : Révoquez les identifiants d'authentification que vous avez créés et supprimez le fichier d'identifiants local.

   gcloud auth application-default revoke

7. Facultatif : Révoquez les identifiants de la CLI gcloud.

   gcloud auth revoke

Étapes suivantes

Voici certaines choses que vous pouvez essayer :

• Examinez le code pub.py et sub.py du tutoriel, et parcourez les autres exemples Pub/Sub sur GitHub. À titre d'exercice, créez une version de pub.py qui publie l'heure locale toutes les secondes.

• Apprenez à traiter des messages par lot.

• À l'aide d'abonnements push, recevez des messages déclenchant des points de terminaison App Engine ou Cloud Functions.

• Récupérez les messages précédemment confirmés à l'aide de la fonctionnalité de réouverture. Par défaut, Pub/Sub supprime les messages confirmés des abonnements. Dans ce tutoriel, par exemple, vous ne pourrez pas réexécuter sub.py pour recevoir à nouveau le message "Hello, World!". La fonctionnalité de relecture vous permet de configurer des abonnements afin de recevoir des messages après confirmation.

• Faites vos premiers pas avec les bibliothèques clientes dans d'autres langages.