Guida rapida: crea ed esegui il deployment di una funzione Cloud Functions HTTP con Java

Crea e sottoponi a deployment una funzione Cloud Functions HTTP con Java

Nota: questi contenuti si applicano solo a Cloud Functions (1ª generazione). Consulta la sezione Creare ed eseguire il deployment di una funzione Cloud Functions HTTP con Java per la versione di 2ª generazione del documento. Per ulteriori informazioni, consulta il confronto delle versioni di Cloud Functions.

Questa guida illustra il processo di scrittura di una Cloud Function utilizzando il runtime Java. Esistono due tipi di funzioni Cloud Functions:

• Una funzione HTTP, che puoi richiamare dalle richieste HTTP standard.
• Una funzione basata su eventi, che utilizzi per gestire gli eventi dall'infrastruttura Cloud, come i messaggi su un argomento Cloud Pub/Sub, o le modifiche in un bucket Cloud Storage.

Il documento mostra come creare una semplice funzione HTTP e crearla utilizzando Maven o Gradle.

Scopri di più: per maggiori dettagli, consulta le informazioni sulle funzioni HTTP e sulle funzioni basate su eventi.

Struttura della guida

1. Creazione di un progetto Google Cloud utilizzando Google Cloud SDK
2. Creazione di una funzione
3. Specificare le dipendenze
4. Creazione e test in locale
5. Deployment della funzione
6. Test della funzione di cui è stato eseguito il deployment
7. Visualizzazione dei log

Creazione di un progetto Google Cloud con Google Cloud SDK

1. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.

2. Nella console di Google Cloud Console, nella pagina del selettore dei progetti, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse che crei in questa procedura, crea un progetto invece di selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto e rimuovere tutte le risorse associate.

   Vai al selettore progetti

3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

4. Abilita le API Cloud Functions and Cloud Build.

   Abilita le API

5. Nella console di Google Cloud Console, nella pagina del selettore dei progetti, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse che crei in questa procedura, crea un progetto invece di selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto e rimuovere tutte le risorse associate.

   Vai al selettore progetti

6. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

7. Abilita le API Cloud Functions and Cloud Build.

   Abilita le API

8. Installa e inizializza Google Cloud SDK.
9. Aggiorna e installa i componenti gcloud:

   gcloud components update

Nota: hai bisogno di un prompt dei comandi? Puoi utilizzare Google Cloud Shell. Google Cloud Shell è un ambiente a riga di comando che include già Google Cloud SDK, pertanto non è necessario installarlo. Google Cloud SDK è preinstallato anche sulle macchine virtuali di Google Compute Engine.
10. Prepara l'ambiente di sviluppo.

    Vai alla guida alla configurazione di Java

Creazione di una funzione

Questa sezione descrive come creare una funzione.

Maven

1. Crea una directory sul sistema locale per il codice funzione:

   Linux o Mac OS X:

    mkdir ~/helloworld
    cd ~/helloworld
   

   Windows:

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

2. Crea la struttura del progetto in modo che contenga la directory di origine e il file di origine.

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

3. Aggiungi i seguenti contenuti al file 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!");
     }
   }

   Questa funzione di esempio restituisce il saluto "Hello World!".

Gradle

1. Crea una directory sul sistema locale per il codice funzione:

   Linux o Mac OS X:

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

   Windows:

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

2. Crea la struttura del progetto in modo che contenga la directory di origine e il file di origine.

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

3. Aggiungi i seguenti contenuti al file 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!");
     }
   }

   Questa funzione di esempio restituisce il saluto "Hello World!".

Specifica delle dipendenze

Il passaggio successivo consiste nel configurare le dipendenze:

Maven

Passa alla directory helloworld creata in precedenza e crea un file pom.xml:

 cd ~/helloworld
 touch pom.xml

Per gestire le dipendenze utilizzando Maven, specifica le dipendenze nella sezione <dependencies> all'interno del file pom.xml del progetto. Per questo esercizio, copia i seguenti contenuti nel file 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>

Per un esempio completo basato su Maven, consulta helloworld.

Gradle

Passa alla directory helloworld-gradle creata in precedenza e crea un file build.gradle:

 cd ~/helloworld-gradle
 touch build.gradle

Per gestire le dipendenze utilizzando Gradle, specifica le dipendenze nel file build.gradle del progetto. Per questo esercizio, copia i seguenti contenuti nel file build.gradle. Tieni presente che questo file build.gradle include un'attività personalizzata per aiutarti a eseguire le funzioni localmente.

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.0'

  // 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.1.5'
  testImplementation 'org.mockito:mockito-core:5.5.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)
  }
}

Vedi helloworld-gradle per un esempio completo basato su Gradle.

Scopri di più: per ulteriori dettagli, leggi la sezione su come specificare le dipendenze.

Costruzione e test in locale

Prima di eseguire il deployment della funzione, puoi crearla e testarla localmente:

Maven

Esegui questo comando per verificare che la funzione funzioni:

mvn compile

Un'altra opzione consiste nell'utilizzare il comando mvn package per compilare il codice Java, eseguire eventuali test e pacchettizzare il codice in un file JAR all'interno della directory di destinazione. Puoi scoprire di più sul ciclo di vita della build Maven qui.

Per testare la funzione, esegui il comando seguente:

mvn function:run

Gradle

Esegui questo comando per verificare che la funzione funzioni:

gradle build

Per testare la funzione, esegui il comando seguente:

gradle runFunction -Prun.functionTarget=functions.HelloWorld

Se il test ha esito positivo, viene visualizzato l'URL che puoi visitare nel browser web per vedere la funzione in azione: http://localhost:8080/. Dovresti vedere un messaggio di Hello World!.

In alternativa, puoi inviare richieste a questa funzione utilizzando curl da un'altra finestra del terminale:

curl localhost:8080
# Output: Hello World!

Deployment della funzione

Maven

Per il deployment della funzione con un trigger HTTP, esegui questo comando nella directory helloworld:

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

dove my-first-function è il nome registrato con cui la funzione viene identificata nella console Google Cloud e --entry-point specifica il nome completo della classe (FQN) della funzione.

Gradle

Per il deployment della funzione con un trigger HTTP, esegui questo comando nella directory helloworld-gradle:

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

dove my-first-function è il nome registrato con cui la funzione viene identificata nella console Google Cloud e --entry-point specifica il nome completo della classe (FQN) della funzione.

Scopri di più: per maggiori dettagli, consulta la pagina sul deployment di Cloud Functions.

Test della funzione di cui è stato eseguito il deployment

1. Al termine del deployment della funzione, annota la proprietà httpsTrigger.url o cercala utilizzando il seguente comando:

   gcloud functions describe my-first-function
   

   Dovrebbe avere il seguente aspetto:

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

2. Accedi all'URL dal browser. Dovresti vedere un messaggio di Hello World!.

Nota: puoi trovare questo URL anche nella console Google Cloud. Vai alla pagina Panoramica di Cloud Functions e fai clic sul nome della funzione per aprire la relativa pagina Dettagli funzione. Apri la scheda ATTIVATORE per visualizzare l'URL della funzione.

Visualizzazione dei log

Utilizzo dello strumento a riga di comando

I log per Cloud Functions sono visualizzabili nell'interfaccia utente di Cloud Logging e tramite Google Cloud CLI.

Per visualizzare i log per la tua funzione con gcloud CLI, utilizza il comando logs read, seguito dal nome della funzione:

gcloud functions logs read my-first-function

L'output dovrebbe essere simile al seguente:

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

Nota: di solito si verifica un leggero ritardo tra il momento in cui vengono create le voci di log e il momento in cui vengono visualizzate in Cloud Logging.

Utilizzo della dashboard di Logging

Puoi visualizzare i log per Cloud Functions anche dalla console Google Cloud.

Scopri di più: per ulteriori dettagli su come scrivere, visualizzare e rispondere ai log.