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.

Avant de commencer

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

  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 and Cloud Build 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 and Cloud Build APIs.

    Enable the APIs

    8.
  8. Téléchargez, installez et initialisez le SDK Google Cloud.
  9. Mettez à jour et installez les composants gcloud : 
    gcloud components update
  10. Préparez votre environnement de développement.

    Accéder au guide de configuration Java

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

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

    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
       Voici à quoi cela devrait ressembler :

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

    Afficher les journaux

    Les journaux Cloud Run Functions sont visibles à l'aide de 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 gcloud CLI, exécutez la commande logs read suivie du nom de la fonction :

    gcloud functions logs read my-first-function

    Le résultat 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
...

    Utiliser le tableau de bord Logging

    Vous pouvez également consulter les journaux Cloud Run Functions depuis la consoleGoogle Cloud .