Guide de démarrage rapide : créer et déployer une fonction Cloud HTTP à l'aide de PHP

Créer et déployer une fonction Cloud HTTP à l'aide de PHP

Remarque : Ce contenu ne s'applique qu'à Cloud Functions première génération. Consultez la page Créer et déployer une fonction Cloud HTTP à l'aide de PHP pour la version de 2e génération de ce document. Pour en savoir plus, consultez la page Comparer les versions de Cloud Functions.

Ce guide vous accompagne tout au long du processus d'écriture d'une fonction Cloud à l'aide de l'environnement d'exécution PHP. Il existe deux types de fonctions Cloud :

• Les fonctions HTTP, que vous appelez à partir des requêtes HTTP standards.
• Les fonctions déclenchées par des événements, qui vous permettent de gérer les événements depuis votre infrastructure cloud tels que les messages sur un sujet Cloud Pub/Sub ou les modifications apportées à un bucket Cloud Storage.

L'exemple montre comment créer une fonction HTTP simple.

En savoir plus : Pour obtenir plus d'informations, consultez les sections Fonctions HTTP et Fonctions CloudEvent.

Structure du guide

1. Créer un projet Google Cloud à l'aide de gcloud CLI
2. Créer une fonction
3. Spécifier des dépendances
4. Créer et tester en local
5. Déployer la fonction
6. Tester la fonction déployée

Créer un projet Google Cloud à l'aide de gcloud CLI

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. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

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

4. Activer les API Cloud Functions and Cloud Build.

   Activer les API

5. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

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

7. Activer les API Cloud Functions and Cloud Build.

   Activer les API

8. Installez et initialisez gcloud CLI.
9. Mettez à jour et installez les composants gcloud :

   gcloud components update

Remarque : Vous avez besoin d'une invite de commande ? Vous pouvez utiliser Google Cloud Shell. Google Cloud Shell est un environnement de ligne de commande qui inclut Google Cloud CLI. Vous n'avez donc pas besoin de l'installer. Google Cloud CLI est également préinstallé sur les machines virtuelles Google Compute Engine.
10. Préparez votre environnement de développement.

    Accéder à la page "Utiliser PHP sur Google Cloud"

Créer une fonction

1. Créez un répertoire sur votre système local pour le code de fonction :

   Linux ou Mac OS X

   mkdir ~/helloworld_http
   cd ~/helloworld_http
   

   Windows

   mkdir %HOMEPATH%\helloworld_http
   cd %HOMEPATH%\helloworld_http
   

2. Créez un fichier index.php dans le répertoire helloworld_http avec le contenu suivant :

   functions/helloworld_http/index.php

   Afficher sur GitHub Commentaires

   <?php
   
   use Google\CloudFunctions\FunctionsFramework;
   use Psr\Http\Message\ServerRequestInterface;
   
   // Register the function with Functions Framework.
   // This enables omitting the `FUNCTIONS_SIGNATURE_TYPE=http` environment
   // variable when deploying. The `FUNCTION_TARGET` environment variable should
   // match the first parameter.
   FunctionsFramework::http('helloHttp', 'helloHttp');
   
   function helloHttp(ServerRequestInterface $request): string
   {
       $name = 'World';
       $body = $request->getBody()->getContents();
       if (!empty($body)) {
           $json = json_decode($body, true);
           if (json_last_error() != JSON_ERROR_NONE) {
               throw new RuntimeException(sprintf(
                   'Could not parse body: %s',
                   json_last_error_msg()
               ));
           }
           $name = $json['name'] ?? $name;
       }
       $queryString = $request->getQueryParams();
       $name = $queryString['name'] ?? $name;
   
       return sprintf('Hello, %s!', htmlspecialchars($name));
   }
   

   Cet exemple de fonction utilise un nom fourni dans la requête HTTP et renvoie un message d'accueil. Lorsqu'aucun nom n'est fourni, il renvoie le message "Hello World!".

   Remarque : Cloud Functions recherche par défaut les fonctions déployables dans index.php. Utilisez l'option --source lorsque vous déployez votre fonction via gcloud pour spécifier un autre répertoire contenant un fichier index.php.

Spécifier des dépendances

Vous utilisez Composer pour gérer les dépendances en PHP. Si vous n'avez pas encore installé Composer, vous pouvez le faire en procédant comme suit :

1. Téléchargez Composer à l'emplacement de votre choix.

2. Une fois le téléchargement terminé, déplacez le fichier composer.phar dans un répertoire situé dans le chemin d'accès au système, par exemple :

   mv composer.phar /usr/local/bin/composer
   

Ensuite, spécifiez les dépendances de votre fonction :

1. Ajoutez un fichier composer.json qui va contenir les dépendances au répertoire de votre code de fonction, où FUNCTION_TARGET=FUNCTION_NAME indique le nom de votre fonction. Dans cet exemple, FUNCTION_NAME correspond à helloHttp :

   functions/helloworld_http/composer.json

   Afficher sur GitHub Commentaires

   {
       "require": {
           "php": ">= 7.4",
           "google/cloud-functions-framework": "^1.1"
       },
       "scripts": {
           "start": [
              "Composer\\Config::disableProcessTimeout",
              "FUNCTION_TARGET=helloHttp php -S localhost:${PORT:-8080} vendor/google/cloud-functions-framework/router.php"
           ]
       }
   }
   

2. Dans le répertoire contenant votre code de fonction (qui doit également contenir le fichier composer.json que vous venez de créer), exécutez la commande suivante :

   composer require google/cloud-functions-framework
   

   Cela ajoute le framework des fonctions à votre fichier composer.json. Cette commande crée également un répertoire vendor/ dans le répertoire de votre code de fonction, qui contient les dépendances.

En savoir plus : Pour obtenir plus d'informations, consultez la page Spécifier des dépendances.

Créer et tester en local

Une fois que vous avez suivi les étapes de la section Spécifier des dépendances, vous pouvez créer et tester votre fonction en local.

La commande suivante crée un serveur Web local exécutant votre fonction helloHttp :

export FUNCTION_TARGET=helloHttp
php -S localhost:8080 vendor/bin/router.php

Cette fonction, si elle a été créée correctement, affiche une URL. Vous pouvez accéder à cette URL (http://localhost:8080/) avec votre navigateur Web. Le message suivant devrait s'afficher : Hello World!.

Vous pouvez également envoyer des requêtes à cette fonction à l'aide de curl à partir d'une autre fenêtre de terminal :

curl localhost:8080
# Output: Hello World!

Remarque : Consultez la documentation sur les tests de Cloud Functions pour en savoir plus sur l'écriture de tests unitaires pour les fonctions HTTP et les fonctions CloudEvent.

Déployer la fonction

Pour déployer la fonction avec un déclencheur HTTP, exécutez la commande suivante dans le répertoire helloworld_http :

gcloud functions deploy helloHttp --runtime php82 --trigger-http --allow-unauthenticated

L'option --allow-unauthenticated vous permet d'accéder à la fonction sans authentification. Pour exiger une authentification, omettez cette option.

En savoir plus : Pour obtenir plus d'informations, consultez la page Déployer des fonctions Cloud Functions.

Tester la fonction déployée

1. Une fois le déploiement de la fonction terminé, notez la propriété httpsTrigger.url ou recherchez-la à l'aide de la commande suivante :

   gcloud functions describe helloHttp
   

   Elle devrait se présenter comme ceci :

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloHttp

2. Accédez à cette URL dans votre navigateur. Un message de type "Hello World!" doit s'afficher.

   Essayez de transmettre un nom dans la requête HTTP, comme illustré dans cet exemple d'URL :

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloHttp?name=NAME

   Le message "Hello NAME!" doit s'afficher.

Afficher les journaux

Utiliser l'outil de ligne de commande

Les journaux des fonctions Cloud sont visibles dans l'UI de Cloud Logging et via Google Cloud CLI.

Pour afficher les journaux de votre fonction à l'aide de gcloud CLI, exécutez la commande gcloud logs read suivie du nom de la fonction :

gcloud functions logs read helloHttp

La sortie doit ressembler à ceci :

LEVEL  NAME       EXECUTION_ID  TIME_UTC                 LOG
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:25.983  Function execution started
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:26.001  Function execution took 19 ms, finished with status code: 200

Remarque : En règle générale, il existe un léger décalage entre la création des entrées de journal et leur affichage dans Cloud Logging.

Utiliser le tableau de bord Logging

Vous pouvez également consulter les journaux des fonctions Cloud Functions depuis la console Google Cloud.

En savoir plus : Pour obtenir plus d'informations, accédez à la page Écrire, afficher des journaux et y répondre.