De nombreuses applications doivent exécuter un traitement en arrière-plan dans d'autres contextes que celui d'une requête Web. Ce tutoriel indique comment créer une application Web qui permet aux utilisateurs de saisir du texte à traduire, puis qui affiche la liste des traductions précédentes. La traduction est effectuée dans un traitement en arrière-plan pour éviter de bloquer la requête de l'utilisateur.
Le schéma suivant illustre le processus de requête de traduction.
Voici, dans l'ordre, les étapes du fonctionnement de l'application du tutoriel :
- L'application accède à la page Web pour consulter la liste des traductions précédentes stockées dans Firestore.
- Elle demande la traduction d'un texte en saisissant un formulaire HTML.
- La requête de traduction est publiée dans Pub/Sub.
- Une fonction Cloud Run abonnée à ce sujet Pub/Sub est déclenchée.
- La fonction Cloud Run utilise Cloud Translation pour traduire le texte.
- La fonction Cloud Run stocke le résultat dans Firestore.
Ce tutoriel est destiné à toute personne intéressée par le traitement en arrière-plan avec Google Cloud. Aucune expérience antérieure n’est requise avec Pub/Sub, Firestore, App Engine Fonctions Cloud Run. Cependant, pour comprendre l'intégralité du code, il peut être utile de se familiariser avec Go, JavaScript et HTML.
Objectifs
- Comprendre et déployer une fonction Cloud Run
- Comprendre et déployer une application App Engine
- Tester l'application
Coûts
Dans ce document, vous utilisez les composants facturables suivants de Google Cloud :
Obtenez une estimation des coûts en fonction de votre utilisation prévue à l'aide du simulateur de coût.
Une fois que vous avez terminé les tâches décrites dans ce document, vous pouvez éviter de continuer à payer des frais en supprimant les ressources que vous avez créées. Pour en savoir plus, consultez la section Effectuer un nettoyage.
Avant de commencer
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Firestore, Cloud Run functions, Pub/Sub, and Cloud Translation APIs.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Firestore, Cloud Run functions, Pub/Sub, and Cloud Translation APIs.
-
Dans la console Google Cloud, ouvrez l'application dans Cloud Shell.
Cloud Shell vous permet d'accéder en ligne de commande à vos ressources cloud, directement depuis votre navigateur. Ouvrez Cloud Shell dans votre navigateur et cliquez sur Proceed (Continuer) pour télécharger l'exemple de code et le modifier dans le répertoire de l'application.
- Dans Cloud Shell, configurez l'outil
gcloud
pour qu'il utilise votre projet Google Cloud :# Configure gcloud for your project gcloud config set project YOUR_PROJECT_ID
Comprendre la fonction Cloud Run
- La fonction commence par importer plusieurs dépendances telles que Firestore et Translation. Elle comporte également des variables et des types globaux.
- Les clients Firestore et Translation internationaux sont initialisés afin qu'ils puissent être réutilisés pour les appels de fonction. De cette manière, vous n'avez pas besoin d'initialiser de nouveaux clients à chaque appel de fonction, ce qui ralentirait l'exécution.
- L'API Translation traduit la chaîne la langue sélectionnée.
-
La fonction Cloud Run commence par initialiser les clients Firestore et Pub/Sub. Elle analyse ensuite le message Pub/Sub pour obtenir le texte à traduire et la langue cible souhaitée.
Puis, l'application attribue un nom unique à la requête de traduction pour s'assurer qu'elle ne stocke pas de traductions en double. Elle procède ensuite à la traduction dans une transaction Firestore afin de s'assurer que les exécutions simultanées n'effectuent pas accidentellement la même traduction deux fois.
Déployer la fonction Cloud Run
Dans Cloud Shell, dans le même répertoire que le fichier
translate.go
, déployez la fonction Cloud Run avec un déclencheur Pub/Sub:gcloud functions deploy Translate --runtime go111 \ --trigger-topic=translate --set-env-vars GOOGLE_CLOUD_PROJECT=YOUR_GOOGLE_CLOUD_PROJECT
où
YOUR_GOOGLE_CLOUD_PROJECT
correspond à votre ID de projet Google Cloud.
Comprendre l'application
L'application Web comporte deux composants principaux :
-
Un serveur HTTP Go pour gérer les requêtes Web. Il comporte les deux points de terminaison suivants :
/
: répertorie toutes les traductions existantes et affiche un formulaire que les utilisateurs peuvent envoyer pour demander de nouvelles traductions./request-translation
: point de terminaison auquel sont envoyés les formulaires. Il publie la requête sur Pub/Sub pour qu'elle soit traduite de manière asynchrone.
- Un modèle HTML alimenté par les traductions existantes via le serveur Go.
Le serveur HTTP
Dans le répertoire
index
,main.go
commence par configurer l'application et enregistrer les gestionnaires HTTP :Le gestionnaire d'index (
/
) récupère toutes les traductions existantes dans Firestore et renseigne un modèle HTML à l'aide de la liste suivante :Pour demander de nouvelles traductions, envoyez un formulaire HTML. Le gestionnaire des requêtes de traduction, enregistré sur
/request-translation
, analyse le formulaire envoyé, valide la requête, puis publie un message dans Pub/Sub :
Le modèle HTML
Le modèle HTML représente la base de la page HTML affichée à l'utilisateur afin qu'il puisse consulter les traductions précédentes et en demander de nouvelles. Ce modèle est rempli par le serveur HTTP à l'aide de la liste des traductions existantes.
-
L'élément
<head>
du modèle HTML inclut des métadonnées, des feuilles de style et le code JavaScript de la page :Cette page intègre des éléments Material Design Lite (MDL) CSS et JavaScript. MDL vous permet d'apporter un aspect Material Design à vos sites Web.
JQuery permet d'attendre la fin de chargement du document et de définir un gestionnaire d'envoi de formulaires. Chaque fois que le formulaire de requête de traduction est envoyé, la page effectue une validation minimale du formulaire pour vérifier que la valeur n'est pas vide, puis envoie une requête asynchrone au point de terminaison
/request-translation
.Enfin, un snackbar MDL apparaît pour indiquer si la requête a abouti ou si une erreur s'est produite.
- Le corps HTML de la page utilise une mise en page MDL et plusieurs composants MDL pour afficher la liste des traductions ainsi qu'un formulaire de requête de traductions supplémentaires :
Créer l'application
-
Avant de déployer l'application Web, créez-la pour vous assurer que la compilation s'effectue et que toutes vos dépendances fonctionnent.
go build -o start ./index
La compilation s'est bien déroulée si aucun message ne s'affiche et si un fichier
start
est créé.
Déployer l'application Web
Vous pouvez utiliser l'environnement standard App Engine pour créer et déployer une application qui s'exécute de manière fiable, même lorsqu'elle est soumise à une charge importante et doit gérer de grandes quantités de données.
Dans ce tutoriel, l'interface HTTP est déployée dans l'environnement standard App Engine.
Le fichier app.yaml
configure l'application App Engine :
- Déployez l'application dans l'environnement standard App Engine à partir du répertoire où se trouve le fichier
app.yaml
:gcloud app deploy
Tester l'application
Après avoir déployé la fonction Cloud Run et l'application App Engine, essayez d'envoyer une requête de traduction.
-
Pour afficher l'application dans votre navigateur, saisissez l'URL suivante :
https://PROJECT_ID.REGION_ID.r.appspot.com
Remplacez les éléments suivants :
PROJECT_ID
: ID de votre projet Google Cloud.REGION_ID
: code attribué par App Engine à votre application
Il s'agit d'une page affichant une liste de traductions vide ainsi qu'un formulaire de requête de nouvelles traductions.
- Dans le champ Texte à traduire, saisissez un texte à traduire. Exemple :
Hello, World
. - Dans la liste déroulante, sélectionnez la langue dans laquelle vous souhaitez traduire le texte.
- Cliquez sur Envoyer.
- Pour actualiser la page, cliquez sur Actualiser refresh. Une nouvelle ligne s'affiche dans la liste de traduction. Si vous ne voyez pas de traduction, attendez encore quelques secondes, puis réessayez. Si vous ne voyez toujours pas de traduction, consultez la section suivante sur le débogage de l'application.
Déboguer l'application
Si vous ne parvenez pas à vous connecter à votre application App Engine ou que vous ne voyez pas de nouvelle traduction, vérifiez les éléments suivants :
-
Vérifiez que les commandes de déploiement
gcloud
ont bien abouti et n'ont généré aucune erreur. Si des erreurs se sont produites, corrigez-les et essayez Déployer la fonction Cloud Run l'application App Engine. -
Dans la console Google Cloud, accédez à la page Visionneuse de journaux.
Accéder à la page "Visionneuse de journaux"- Dans la liste déroulante Ressources sélectionnées récemment, cliquez sur Application GAE , puis sur Tous les ID de module. La liste des requêtes correspondant à votre accès à l'application s'affiche. Si cette liste n'apparaît pas, vérifiez que vous avez bien sélectionné Tous les ID de module dans la liste déroulante. Si des messages d'erreur s'affichent dans la console Google Cloud, vérifiez que le code de votre application correspond Code présenté dans la section expliquant comment comprendre l'application.
-
Dans la liste déroulante Ressources sélectionnées récemment, cliquez sur Fonction Cloud, puis sur Tous les noms de fonction. Une fonction est répertoriée pour chaque traduction demandée. Si ce n'est pas le cas, vérifiez que la fonction Cloud Run et l'application App Engine utilisent le même sujet Pub/Sub :
- Dans le fichier
background/index/main.go
, vérifiez que la valeur de la constantetopicName
est"translate"
. - Lorsque vous déployez la fonction Cloud Run, veillez à inclure l'option
--trigger-topic=translate
.
- Dans le fichier
Effectuer un nettoyage
Pour éviter que les ressources utilisées lors de ce tutoriel soient facturées sur votre compte Google Cloud, supprimez le projet contenant les ressources, ou conservez le projet et supprimez les ressources individuelles.
Supprimer le projet Google Cloud
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Supprimer l'instance App Engine
- In the Google Cloud console, go to the Versions page for App Engine.
- Select the checkbox for the non-default app version that you want to delete.
- Pour supprimer la version de l'application, cliquez sur Supprimer.
Supprimer la fonction Cloud Run
-
Supprimez la fonction Cloud Run que vous avez créée dans ce tutoriel:
gcloud functions delete Translate
Étape suivante
- Essayer d'autres Tutoriels sur les fonctions Cloud Run
- Obtenez plus d'informations sur App Engine.
- Essayez Cloud Run, qui vous permet d'exécuter des conteneurs sans état dans un environnement entièrement géré ou dans votre propre cluster Google Kubernetes Engine.