Votre première fonction : Java

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

  • Les fonctions HTTP, que vous appelez à partir des requêtes HTTP standards.
  • Les fonctions d'arrière-plan, qui permettent de gérer des événements de votre infrastructure cloud, tels que des messages sur un sujet Cloud Pub/Sub ou des 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.

Structure du guide

  1. Créer un projet GCP avec le SDK Cloud
  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
  7. Afficher les journaux

Créer un projet GCP avec le SDK Cloud

  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.

    Accéder au sélecteur de projet

  3. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  4. Activer les API Cloud Functions and Cloud Build.

    Activer les API

  5. Installez et initialisez le SDK Cloud.
  6. Mettez à jour et installez les composants gcloud :
    gcloud components update
  7. 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.cloud.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.0.4</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.9.7</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.0.1'

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

  // These dependencies are only used by the tests.
  testImplementation 'com.google.cloud.functions:functions-framework-api:1.0.1'
  testImplementation 'junit:junit:4.12'
  testImplementation 'com.google.truth:truth:1.0.1'
  testImplementation 'org.mockito:mockito-core:3.4.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.

Créer 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 --entry-point functions.HelloWorld --runtime java11 --trigger-http --memory 512MB --allow-unauthenticated

my-first-function est le nom enregistré par lequel votre fonction sera identifiée dans Cloud Console, 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 --entry-point functions.HelloWorld --runtime java11 --trigger-http --memory 512MB --allow-unauthenticated

my-first-function est le nom enregistré par lequel votre fonction sera identifiée dans Cloud Console, 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
    

    Elle devrait se présenter comme 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!.

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 l'outil de ligne de commande gcloud.

Pour afficher les journaux de votre fonction à l'aide de l'outil gcloud, 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
...

Utiliser le tableau de bord Logging

Vous pouvez également consulter les journaux des fonctions Cloud Functions depuis Cloud Console.