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

Nota: Questi contenuti riguardano solo le funzioni Cloud Run, in precedenza Cloud Functions (2nd gen).

Per la versione 1ª generazione. di questo documento, vedi Crea ed esegui il deployment di una funzione Cloud Run HTTP con Java (1ª generazione).

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

• Una funzione HTTP, che richiami dalle richieste HTTP standard.
• Una funzione basata su eventi, che viene attivata da eventi nell'infrastruttura Cloud, ad esempio messaggi in un argomento Pub/Sub o modifiche in un bucket Cloud Storage.

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

Per maggiori dettagli, leggi l'articolo Scrivere funzioni HTTP e la scrittura di funzioni basate su eventi.

Prima di iniziare

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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

   Enable the APIs

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

   Enable the APIs

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

   gcloud components update

10. Prepara 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 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 in modo che contenga la directory e il file di origine.

   mkdir -p ~/helloworld/src/main/java/functions
   touch ~/helloworld/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 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 in modo che contenga la directory 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 è impostare 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 in la sezione <dependencies> all'interno del file pom.xml del tuo 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>

Vedi helloworld per un campione completo basato su Maven.

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 in il file build.gradle del tuo progetto. Per questo esercizio, copia i seguenti contenuti nel file build.gradle. Tieni presente che questo file build.gradle include una 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.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)
  }
}

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

Scopri di più: per maggiori dettagli, leggi l'articolo specificando le dipendenze.

Crea e testa la tua funzione in locale

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

Maven

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

   mvn compile
   

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

2. Avvia la funzione con il seguente comando:

   mvn function:run
   

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

   Consulta Invio di richieste a funzioni locali per in modo più dettagliato.

Gradle

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

   gradle build
   

2. Avvia la funzione con il seguente comando:

   gradle runFunction -Prun.functionTarget=functions.HelloWorld
   

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

   Consulta Invio di richieste a funzioni locali per in modo più dettagliato.

esegui il deployment della funzione

Per eseguire il deployment della funzione, esegui questo comando nella directory helloworld (se utilizzi maven) o la 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 es. us-west1).

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

java-http-function è il nome registrato con cui la tua funzione è identificato nella console Google Cloud e --entry-point specifica il nome completo della classe (FQN) della funzione.

Scopri di più: per maggiori dettagli, leggi l'articolo deployment delle funzioni Cloud Run.

Testa la funzione di cui hai eseguito il deployment

1. Dopo il deployment della funzione, prendi nota della proprietà uri dall'output del gcloud functions deploy oppure recuperalo con il seguente comando:

   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 es. us-west1).

2. Accedi all'URL dal browser. La funzione restituisce un messaggio "Hello World!" per creare un nuovo messaggio email.

   Nota: puoi trovare questo URL anche nella console Google Cloud. Vai alla sezione pagina Panoramica delle funzioni Cloud Run e fai clic su il nome della funzione per aprire la pagina Dettagli funzione. Apri la scheda ATTIVAZIONE per visualizzare l'URL della funzione.

Visualizza i log della funzione

Visualizza i log con lo strumento a riga di comando

Puoi rivedere 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 es. 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.

Visualizza i log con la dashboard dei log

Per visualizzare i log per la funzione con la dashboard di logging, apri la Pagina Panoramica delle funzioni di Cloud Run e fai clic su il nome della funzione nell'elenco, poi fai clic sulla scheda Log.

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