Créer et déployer une fonction Cloud HTTP avec PHP

Créer et déployer une fonction Cloud HTTP avec PHP

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 Pub/Sub ou les modifications apportées à un bucket Cloud Storage.

Pour en savoir plus, consultez les sections Écrire des fonctions HTTP et Écrire des fonctions pilotées par des événements.

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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run et Cloud Logging APIs.

    Enable the APIs

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  6. Make sure that billing is enabled for your Google Cloud project.

  7. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run et Cloud Logging APIs.

    Enable the APIs

  8. Installez et initialisez la gcloud CLI.
  9. Mettez à jour et installez les composants gcloud à l'aide de la commande suivante.
    gcloud components update
  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 :

    <?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!". Pour en savoir plus sur la structure et les éléments requis dans une fonction HTTP PHP, consultez la page Écrire des fonctions HTTP.

Spécifier des dépendances

  1. PHP utilise Composer pour gérer les dépendances. Si vous utilisez Cloud Shell, Composer est préinstallé. Sinon, vous pouvez l'installer à l'aide des commandes suivantes :

    1. Exécutez le script d'installation de la ligne de commande PHP sur la page de téléchargement de Composer pour télécharger Composer sur votre ordinateur de développement.

    2. Déplacez le fichier composer.phar vers votre répertoire de travail /usr/local/bin :

      sudo mv composer.phar /usr/local/bin/composer
      
  2. Spécifiez les dépendances de votre fonction :

    1. Ajoutez un fichier composer.json avec le contenu suivant au répertoire helloworld_http :

      {
          "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"
              ]
          }
      }
      

    La ligne FUNCTION_TARGET spécifie le point d'entrée de votre fonction.

    1. Exécutez la commande suivante dans le répertoire helloworld_http :
    composer require google/cloud-functions-framework
    

    Cette commande ajoute le framework des fonctions à votre fichier composer.json et crée dans helloworld_http un répertoire vendor contenant les dépendances.

Créer et tester votre fonction localement

Pour compiler et tester votre fonction localement avant de la déployer, procédez comme suit :

  1. Créez un serveur Web local exécutant votre fonction helloHttp :

    export FUNCTION_TARGET=helloHttp
    composer start
    
  2. Testez votre fonction en accédant à http://localhost:8080 dans un navigateur ou en exécutant curl localhost:8080 à partir d'une autre fenêtre.

    Pour en savoir plus, consultez la section Envoyer des requêtes aux fonctions locales.

Cet exemple de fonction renvoie un joyeux "Hello, World!".

Déployer la fonction

Pour déployer votre fonction, exécutez la commande suivante dans le répertoire helloworld_http :

  gcloud functions deploy php-http-function \
    --gen2 \
    --runtime=php82 \
    --region=REGION \
    --source=. \
    --entry-point=helloHttp \
    --trigger-http \
    --allow-unauthenticated

Remplacez REGION par le nom de la région Google Cloud dans laquelle vous souhaitez déployer votre fonction (par exemple, us-west1).

L'option facultative --allow-unauthenticated vous permet d'accéder à votre fonction sans authentification.

Tester la fonction déployée

  1. Une fois la fonction déployée, notez la propriété uri à partir du résultat de la commande gcloud functions deploy ou récupérez-la à l'aide de la commande suivante :

      gcloud functions describe php-http-function \
        --region=REGION
    

    Remplacez REGION par le nom de la région Google Cloud dans laquelle vous avez déployé votre fonction (par exemple, us-west1).

  2. Accédez à cette URL dans votre navigateur. La fonction renvoie un message "Hello World!".

    Vous pouvez également trouver cette URL dans la console Google Cloud. Accédez à la page Présentation de Cloud Functions et cliquez sur le nom de votre fonction pour ouvrir la page Informations sur la fonction. Ouvrez l'onglet DÉCLENCHEUR pour afficher l'URL de votre fonction.

Afficher les journaux de votre fonction

Afficher les journaux à l'aide de l'outil de ligne de commande

Vous pouvez consulter les journaux de votre fonction à l'aide de l'interface utilisateur Cloud Logging ou de Google Cloud CLI.

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

    gcloud functions logs read \
      --gen2 \
      --limit=10 \
      --region=REGION \
      php-http-function

Remplacez REGION par le nom de la région Google Cloud dans laquelle vous avez déployé votre fonction (par exemple, us-west1).

Le résultat se présente comme suit :

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-06-02 19:01:36.067
LOG:

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-06-02 19:01:22.814
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello_http-1" on port 8080.

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-06-02 19:01:22.777
LOG: [pid1-nginx] Starting nginx (pid 17): /usr/sbin/nginx -c /tmp/nginxconf-953701689/nginx.conf [session:R8F8ZJ5]

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-06-02 19:01:22.766
LOG: [pid1-nginx] Successfully connected to /tmp/google-config/app.sock after 556.430499ms [session:R8F8ZJ5]

Afficher les journaux à l'aide du tableau de bord de journalisation

Pour afficher les journaux de votre fonction à l'aide du tableau de bord de journalisation, ouvrez la page Page de présentation de Cloud Functions et cliquez sur le nom de votre fonction dans la liste, puis sur l'onglet Journaux.