Créer et déployer une fonction Cloud Run HTTP à l'aide de Java (1re génération)

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

• 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.

Ce document explique comment créer une fonction HTTP simple et la compiler à l'aide de Maven ou de Gradle.

En savoir plus : Pour obtenir plus d'informations, consultez Fonctions HTTP et Fonctions basées sur des événements.

Avant de commencer

Connectez-vous à votre Google Cloud compte. Si vous n'avez jamais utilisé Google Cloud, créez un compte pour évaluer les performances de nos produits dans des scénarios réels. Les nouveaux clients bénéficient également de 300 $ de crédits sans frais pour exécuter, tester et déployer des charges de travail.

Installez la Google Cloud CLI.

Remarque : Si vous avez déjà installé la gcloud CLI, assurez-vous que vous disposez de la dernière version en exécutant gcloud components update.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

Créez ou sélectionnez un Google Cloud projet.

Rôles requis pour sélectionner ou créer un projet

• Sélectionner un projet : la sélection d'un projet ne nécessite pas de rôle IAM spécifique Vous pouvez sélectionner n'importe quel projet pour lequel un rôle vous a été attribué.
• Créer un projet : pour créer un projet, vous avez besoin du rôle Créateur de projet (roles/resourcemanager.projectCreator), qui contient l'autorisation resourcemanager.projects.create. Découvrez comment attribuer des rôles.

Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu d'en sélectionner un 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.

• Créez un Google Cloud projet :

  gcloud projects create PROJECT_ID

  Remplacez PROJECT_ID par le nom du Google Cloud projet que vous créez.

• Sélectionnez le Google Cloud projet que vous avez créé :

  gcloud config set project PROJECT_ID

  Remplacez PROJECT_ID par le nom de votre Google Cloud projet.

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

Activez les API Cloud Functions et Cloud Build :

Rôles requis pour activer les API

Pour activer les API, vous avez besoin du rôle IAM Administrateur de Service Usage (roles/serviceusage.serviceUsageAdmin), qui contient l' serviceusage.services.enable autorisation. Découvrez comment attribuer des rôles.

gcloud services enable cloudfunctions cloudbuild.googleapis.com

Installez la Google Cloud CLI.

Remarque : Si vous avez déjà installé la gcloud CLI, assurez-vous que vous disposez de la dernière version en exécutant gcloud components update.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

Créez ou sélectionnez un Google Cloud projet.

Rôles requis pour sélectionner ou créer un projet

• Sélectionner un projet : la sélection d'un projet ne nécessite pas de rôle IAM spécifique Vous pouvez sélectionner n'importe quel projet pour lequel un rôle vous a été attribué.
• Créer un projet : pour créer un projet, vous avez besoin du rôle Créateur de projet (roles/resourcemanager.projectCreator), qui contient l'autorisation resourcemanager.projects.create. Découvrez comment attribuer des rôles.

Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu d'en sélectionner un 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.

• Créez un Google Cloud projet :

  gcloud projects create PROJECT_ID

  Remplacez PROJECT_ID par le nom du Google Cloud projet que vous créez.

• Sélectionnez le Google Cloud projet que vous avez créé :

  gcloud config set project PROJECT_ID

  Remplacez PROJECT_ID par le nom de votre Google Cloud projet.

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

Activez les API Cloud Functions et Cloud Build :

Rôles requis pour activer les API

Pour activer les API, vous avez besoin du rôle IAM Administrateur de Service Usage (roles/serviceusage.serviceUsageAdmin), qui contient l' serviceusage.services.enable autorisation. Découvrez comment attribuer des rôles.

gcloud services enable cloudfunctions cloudbuild.googleapis.com

1. Préparez votre environnement de développement.

   Accéder au guide de configuration Java

Créer une fonction

Cette section décrit comment créer une fonction.

Maven

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

   Linux ou Mac OS X :

    mkdir ~/helloworld
    cd ~/helloworld
   

   Windows :

    mkdir %HOMEPATH%\helloworld
    cd %HOMEPATH%\helloworld
   

2. Créez la structure de projet qui doit contenir le répertoire source et le fichier source.

   mkdir -p src/main/java/functions
   touch src/main/java/functions/HelloWorld.java
   

3. Ajoutez le contenu suivant au fichier HelloWorld.java :

   
   package functions;
   
   import com.google.cloud.functions.HttpFunction;
   import com.google.cloud.functions.HttpRequest;
   import com.google.cloud.functions.HttpResponse;
   import java.io.BufferedWriter;
   import java.io.IOException;
   
   public class HelloWorld implements HttpFunction {
     // Simple function to return "Hello World"
     @Override
     public void service(HttpRequest request, HttpResponse response)
         throws IOException {
       BufferedWriter writer = response.getWriter();
       writer.write("Hello World!");
     }
   }

   Cet exemple de fonction renvoie le message d'accueil "Hello World!".

Gradle

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

   Linux ou Mac OS X :

    mkdir ~/helloworld-gradle
    cd ~/helloworld-gradle
   

   Windows :

    mkdir %HOMEPATH%\helloworld-gradle
    cd %HOMEPATH%\helloworld-gradle
   

2. Créez la structure de projet qui doit contenir le répertoire source et le fichier source.

    mkdir -p src/main/java/functions
    touch src/main/java/functions/HelloWorld.java
   

3. Ajoutez le contenu suivant au fichier HelloWorld.java :

   
   package functions;
   
   import com.google.cloud.functions.HttpFunction;
   import com.google.cloud.functions.HttpRequest;
   import com.google.cloud.functions.HttpResponse;
   import java.io.BufferedWriter;
   import java.io.IOException;
   
   public class HelloWorld implements HttpFunction {
     // Simple function to return "Hello World"
     @Override
     public void service(HttpRequest request, HttpResponse response)
         throws IOException {
       BufferedWriter writer = response.getWriter();
       writer.write("Hello World!");
     }
   }

   Cet exemple de fonction renvoie le message d'accueil "Hello World!".

Spécifier des dépendances

L'étape suivante consiste à configurer les dépendances :

Maven

Accédez au répertoire helloworld que vous avez créé ci-dessus, puis créez un fichier pom.xml :

 cd ~/helloworld
 touch pom.xml

Pour gérer les dépendances à l'aide de Maven, spécifiez-les dans la section <dependencies> du fichier pom.xml de votre projet. Pour cet exercice, copiez le contenu suivant dans votre fichier pom.xml.

<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example.functions</groupId>
  <artifactId>functions-hello-world</artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <properties>
    <maven.compiler.target>11</maven.compiler.target>
    <maven.compiler.source>11</maven.compiler.source>
  </properties>

  <dependencies>
    <!-- Required for Function primitives -->
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.1.0</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <!--
          Google Cloud Functions Framework Maven plugin

          This plugin allows you to run Cloud Functions Java code
          locally. Use the following terminal command to run a
          given function locally:

          mvn function:run -Drun.functionTarget=your.package.yourFunction
        -->
        <groupId>com.google.cloud.functions</groupId>
        <artifactId>function-maven-plugin</artifactId>
        <version>0.11.0</version>
        <configuration>
          <functionTarget>functions.HelloWorld</functionTarget>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

Consultez la page Helloworld pour obtenir un exemple complet basé sur Maven.

Gradle

Accédez au répertoire helloworld-gradle que vous avez créé ci-dessus, puis créez un fichier build.gradle :

 cd ~/helloworld-gradle
 touch build.gradle

Pour gérer les dépendances à l'aide de Gradle, spécifiez-les dans le fichier build.gradle de votre projet. Pour cet exercice, copiez le contenu suivant dans votre fichier build.gradle. Notez que ce fichier build.gradle inclut une tâche personnalisée pour vous aider à exécuter des fonctions localement.

apply plugin: 'java'

repositories {
  jcenter()
  mavenCentral()
}
configurations {
    invoker
}

dependencies {
  // Every function needs this dependency to get the Functions Framework API.
  compileOnly 'com.google.cloud.functions:functions-framework-api:1.1.0'

  // To run function locally using Functions Framework's local invoker
  invoker 'com.google.cloud.functions.invoker:java-function-invoker:1.3.1'

  // These dependencies are only used by the tests.
  testImplementation 'com.google.cloud.functions:functions-framework-api:1.1.0'
  testImplementation 'junit:junit:4.13.2'
  testImplementation 'com.google.truth:truth:1.4.0'
  testImplementation 'org.mockito:mockito-core:5.10.0'

}

// Register a "runFunction" task to run the function locally
tasks.register("runFunction", JavaExec) {
  main = 'com.google.cloud.functions.invoker.runner.Invoker'
  classpath(configurations.invoker)
  inputs.files(configurations.runtimeClasspath, sourceSets.main.output)
  args(
    '--target', project.findProperty('run.functionTarget') ?: '',
    '--port', project.findProperty('run.port') ?: 8080
  )
  doFirst {
    args('--classpath', files(configurations.runtimeClasspath, sourceSets.main.output).asPath)
  }
}

Vous trouverez un exemple complet basé sur Gradle dans le fichier helloworld-gradle.

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

Compiler et tester en local

Avant de déployer la fonction, vous pouvez la créer et la tester localement :

Maven

Exécutez la commande suivante pour vérifier que votre fonction est créée :

mvn compile

Une autre option consiste à utiliser la commande mvn package pour compiler votre code Java, exécuter des tests et empaqueter le code dans un fichier JAR dans le répertoire cible. Pour en savoir plus sur le cycle de vie des builds Maven, cliquez ici.

Pour tester la fonction, exécutez la commande suivante :

mvn function:run

Gradle

Exécutez la commande suivante pour vérifier que votre fonction est créée :

gradle build

Pour tester la fonction, exécutez la commande suivante :

gradle runFunction -Prun.functionTarget=functions.HelloWorld

Si l'opération de test réussit, elle affiche l'URL à laquelle vous pouvez accéder dans votre navigateur Web pour voir la fonction en action : http://localhost:8080/. 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!

Déployer la fonction

Maven

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

gcloud functions deploy my-first-function --no-gen2 --entry-point functions.HelloWorld --runtime java17 --trigger-http --memory 512MB --allow-unauthenticated

où my-first-function est le nom enregistré par lequel votre fonction sera identifiée dans la console Google Cloud , et --entry-point spécifie le nom de classe complet de votre fonction (FQN).

Gradle

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

gcloud functions deploy my-first-function --no-gen2 --entry-point functions.HelloWorld --runtime java17 --trigger-http --memory 512MB --allow-unauthenticated

où my-first-function est le nom enregistré par lequel votre fonction sera identifiée dans la console Google Cloud , et --entry-point spécifie le nom de classe complet de votre fonction (FQN).

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

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 my-first-function

   Votre écran devrait ressembler à ceci :

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/my-first-function

2. Accédez à cette URL dans votre navigateur. Le message suivant devrait s'afficher : Hello World!.

Remarque : Vous pouvez également trouver cette URL dans la console Google Cloud . Accédez à la page Présentation de Cloud Run 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

Les journaux Cloud Run Functions sont visibles à l'aide de la Google Cloud CLI et de l'interface utilisateur de Cloud Logging.

Utiliser l'outil de ligne de commande

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

gcloud functions logs read my-first-function

La sortie doit ressembler à ceci :

LEVEL  NAME               EXECUTION_ID  TIME_UTC                 LOG
D      my-first-function  k2bqgroszo4u  2020-07-24 18:18:01.791  Function execution started
D      my-first-function  k2bqgroszo4u  2020-07-24 18:18:01.958  Function execution took 168 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 Cloud Run Functions depuis la consoleGoogle Cloud .

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