Crea ed esegui il deployment di una funzione Cloud Functions HTTP con Java

Crea ed esegui il deployment di una funzione Cloud Functions HTTP con Java

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 viene attivata da eventi nella tua infrastruttura Cloud, come i messaggi su un argomento Pub/Sub o le modifiche in un bucket Cloud Storage.

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

Per ulteriori dettagli, consulta l'articolo sulla scrittura di funzioni HTTP e sulla scrittura di funzioni basate su eventi.

Prima di iniziare

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 pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo 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, Cloud Build, Artifact Registry, Cloud Run e Cloud Logging.

   Abilita le API

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

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo 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, Cloud Build, Artifact Registry, Cloud Run e Cloud Logging.

   Abilita le API

8. Installa e inizializza Google Cloud SDK.
   Nota: hai bisogno di un prompt dei comandi? Puoi utilizzare Cloud Shell. Cloud Shell è un ambiente a riga di comando che include già Google Cloud CLI, quindi non è necessario installarlo. Google Cloud CLI è anche preinstallato sulle macchine virtuali di Google Compute Engine.
9. Aggiorna e installa i componenti di gcloud con il comando seguente.

   gcloud components update

10. Preparare l'ambiente di sviluppo.

    Vai alla guida alla configurazione di Java

Crea la funzione

Questa sezione descrive come creare una funzione.

Maven

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

   Linux o Mac OS X:

    mkdir ~/helloworld
    cd ~/helloworld
   

   Windows:

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

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

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

3. Aggiungi il seguente contenuto 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 tuo sistema locale per il codice della 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 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 il seguente contenuto 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 nell'impostare le dipendenze:

Maven

Passa alla directory helloworld creata sopra 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 il contenuto seguente 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>

Consulta helloworld per un esempio completo basato su Maven.

Gradle

Passa alla directory helloworld-gradle creata sopra 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 il contenuto seguente nel file build.gradle. Tieni presente che questo file build.gradle include un'attività personalizzata per aiutarti a eseguire funzioni in locale.

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

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

Scopri di più: per maggiori dettagli, leggi come specificare le dipendenze.

Creare e testare la funzione in locale

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

Maven

1. Esegui questo comando per confermare che la funzione venga creata:

   mvn compile
   

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

2. Avvia la funzione con il seguente comando:

   mvn function:run
   

3. Testa la tua funzione visitando http://localhost:8080 in un browser o eseguendo curl localhost:8080 da un'altra finestra.

   Per ulteriori dettagli, consulta Inviare richieste a funzioni locali.

Gradle

1. Esegui questo comando per confermare che la funzione venga creata:

   gradle build
   

2. Avvia la funzione con il seguente comando:

   gradle runFunction -Prun.functionTarget=functions.HelloWorld
   

3. Testa la tua funzione visitando http://localhost:8080 in un browser o eseguendo curl localhost:8080 da un'altra finestra.

   Per ulteriori dettagli, consulta Inviare richieste a funzioni locali.

esegui il deployment della funzione

Per eseguire il deployment della funzione, esegui questo comando nella directory helloworld (se utilizzi maven) o nella directory helloworld-gradle (per Gradle):

  gcloud functions deploy java-http-function \
    --gen2 \
    --entry-point=functions.HelloWorld \
    --runtime=java17 \
    --region=REGION \
    --source=. \
    --trigger-http \
    --allow-unauthenticated

Sostituisci REGION con il nome della regione Google Cloud in cui vuoi eseguire il deployment della funzione (ad esempio, us-west1).

Il flag facoltativo --allow-unauthenticated consente di raggiungere la funzione senza autenticazione.

java-http-function è il nome registrato con cui la funzione viene identificata nella console Google Cloud, mentre --entry-point specifica il nome completo della classe (FQN) della funzione.

Scopri di più: per maggiori dettagli, consulta l'articolo sul deployment di Cloud Functions.

Testa la funzione di cui hai eseguito il deployment

1. Dopo il deployment della funzione, prendi nota della proprietà uri nell'output del comando gcloud functions deploy o recuperala con il comando seguente:

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

   Sostituisci REGION con il nome della regione Google Cloud in cui hai eseguito il deployment della funzione (ad esempio us-west1).

2. Accedi all'URL dal browser. La funzione restituisce un messaggio "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 TRIGGER per visualizzare l'URL della funzione.

Visualizza i log della funzione

Visualizza i log con lo strumento a riga di comando

Puoi esaminare i log della funzione con l'interfaccia utente di Cloud Logging o tramite Google Cloud CLI.

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

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

Sostituisci REGION con il nome della regione Google Cloud in cui hai eseguito il deployment della funzione (ad esempio us-west1).

L'output è simile al seguente:

LEVEL: I
NAME: my-first-function
TIME_UTC: 2023-05-29 23:09:57.708
LOG:

LEVEL: I
NAME: my-first-function
TIME_UTC: 2023-05-29 23:05:53.257
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "my--first--function-1" on port 8080.

LEVEL:
NAME: my-first-function
TIME_UTC: 2023-05-29 23:05:53.248
LOG: 2023-05-29 23:05:53.248:INFO:oejs.Server:main: Started @892ms

Nota: potrebbe verificarsi un leggero ritardo prima che le voci di log vengano visualizzate in Cloud Logging.

Visualizzare i log con la dashboard di logging

Per visualizzare i log per la funzione con la dashboard di logging, apri la pagina Panoramica di Cloud Functions e fai clic sul nome della funzione nell'elenco, quindi fai clic sulla scheda Log.

Scopri di più: per maggiori dettagli, leggi l'articolo sulla scrittura, la visualizzazione e la risposta ai log.