Se stai creando una nuova funzione, consulta la guida rapida della console su Cloud Run. I contenuti di questa pagina si applicano solo alle funzioni legacy esistenti create con l'API Cloud Functions v1.

Esegui funzioni con il framework di Functions

Cloud Run Functions utilizza le librerie open source del framework di Functions per aggregare le funzioni di cui è stato eseguito il deployment in un'applicazione HTTP persistente.

Il framework di Functions può essere eseguito anche su qualsiasi altra piattaforma che supporti il linguaggio stesso, inclusi il computer locale, i server on-premise, Compute Engine e Cloud Run.

Installa le dipendenze

Nella directory della funzione, installa la libreria del framework di Functions per il tuo linguaggio:

Per saperne di più, consulta Libreria del framework di Functions per Java.

Node.js

npm install --save-dev @google-cloud/functions-framework

Python

pip install functions-framework

Go

go install github.com/GoogleCloudPlatform/functions-framework-go/funcframework

Java

Maven

Se utilizzi Maven, aggiungi quanto segue al file pom.xml:

<dependency>
  <groupId>com.google.cloud.functions</groupId>
  <artifactId>functions-framework-api</artifactId>
  <version>1.1.0</version>
  <scope>provided</scope>
</dependency>

Gradle

Se utilizzi Gradle, aggiungi quanto segue al tuo file build.gradle:

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

C#

I comandi riportati di seguito utilizzano i template .NET per creare un nuovo codebase della funzione Cloud Run .NET con la libreria del framework di Functions per .NET come dipendenza:

# HTTP functions
dotnet new gcf-http

# CloudEvent functions
dotnet new gcf-event

Ruby

In Ruby, il framework di Functions deve essere aggiunto alle dipendenze della funzione per poter eseguire il deployment in Cloud Run Functions:

bundle add functions_framework

PHP

composer require google/cloud-functions-framework

Configura il framework di Functions

Prima di eseguire una funzione utilizzando il framework di Functions, devi specificare sia il tipo che il nome della funzione che vuoi eseguire. Puoi specificare questi attributi come flag dell'interfaccia a riga di comando (CLI) o come variabili di ambiente.

Tipi di funzioni supportati

Il framework di Functions supporta tutti e tre i tipi di funzioni supportati da Cloud Run Functions di 1ª gen. Tutti i runtime dei linguaggi supportano http e uno tra event e cloudevent.

Tipo di funzione	Tipo di firma	Descrizione	Runtime supportati
Funzioni attivate da HTTP	`http`	Funzioni che ricevono e rispondono a richieste HTTP.	Tutti i runtime
Funzioni in background	`event`	Formato evento specifico per funzioni Cloud Run	Node.js, Python, Go, Java
Funzioni CloudEvent	`cloudevent`	Formato evento standard del settore	.NET, Ruby, PHP

Specifica la funzione da eseguire

Prima di eseguire una funzione con il framework di Functions, devi specificare quale funzione all'interno del codice deve essere eseguita. Per la maggior parte dei linguaggi, puoi farlo specificando il nome del metodo della funzione di destinazione come mostrato nelle tabelle riportate di seguito. (Di seguito sono riportate anche le eccezioni a questa regola, ad esempio Java e .NET.)

Istruzioni per linguaggio

Consulta la tabella seguente per un elenco delle opzioni di configurazione supportate da ciascun linguaggio.

Node.js

Argomento dell'interfaccia a riga di comando	Variabile di ambiente	Descrizione
`--port`	`PORT`	La porta su cui rimanere in ascolto delle richieste. (Valore predefinito: `8080`)
`--target`	`FUNCTION_TARGET`	Il nome della funzione con `export` da richiamare. (Valore predefinito: `function`)
`--signature-type`	`FUNCTION_SIGNATURE_TYPE`	Il tipo di firma utilizzato dalla funzione. Può essere uno dei seguenti: `http` (valore predefinito), `event` o `cloudevent`.

Python

Argomento dell'interfaccia a riga di comando	Variabile di ambiente	Descrizione
`--port`	`PORT`	La porta su cui rimanere in ascolto delle richieste. (Valore predefinito: `8080`)
`--target`	`FUNCTION_TARGET`	Il nome della funzione con `export` da richiamare. (Valore predefinito: `function`)
`--signature-type`	`FUNCTION_SIGNATURE_TYPE`	Il tipo di firma utilizzato dalla funzione. Può essere uno dei seguenti: `http` (valore predefinito), `event` o `cloudevent`.

Go

Variabile di ambiente	Descrizione
`PORT`	La porta su cui rimanere in ascolto delle richieste. (Valore predefinito: `8080`)

Java

Nome argomento	Variabile di ambiente	Descrizione
`run.port`	`PORT`	La porta su cui rimanere in ascolto delle richieste. (Valore predefinito: `8080`)
`run.functionTarget`	`FUNCTION_TARGET`	Il nome della funzione con `export` da richiamare. (Valore predefinito: `function`)

C#

Argomento dell'interfaccia a riga di comando	Variabile di ambiente	Descrizione
`--port`	`PORT`	La porta su cui rimanere in ascolto delle richieste. (Valore predefinito: `8080`)
`--target` (o unico argomento)	`FUNCTION_TARGET`	Il classname della funzione da richiamare. (Valore predefinito: `function`)

Ruby

Argomento dell'interfaccia a riga di comando	Variabile di ambiente	Descrizione
`--port`	`PORT`	La porta su cui rimanere in ascolto delle richieste. (Valore predefinito: `8080`)
`--target`	`FUNCTION_TARGET`	Il nome della funzione con `export` da richiamare. (Valore predefinito: `function`)

PHP

Variabile di ambiente	Descrizione
`FUNCTION_TARGET`	Il nome della funzione da richiamare. (Valore predefinito: `function`)
`FUNCTION_SIGNATURE_TYPE`	Il tipo di firma utilizzato dalla funzione. Può essere uno dei seguenti: `http` (valore predefinito), `event` o `cloudevent`.

Segui le istruzioni riportate di seguito per configurare ed eseguire il framework di Functions:

Node.js

Il framework di Functions per Node.js ti consente di specificare il nome e il tipo di firma della funzione come argomenti della riga di comando o variabili di ambiente.

Puoi anche specificare questi valori nel file di build package.json aggiungendo uno script start con gli argomenti dell'interfaccia a riga di comando richiesti, come mostrato nell'esempio seguente.

"scripts": {
  "start": "npx functions-framework --target=YOUR_FUNCTION_NAME [--signature-type=YOUR_SIGNATURE_TYPE]"
}

Lo stesso risultato si può ottenere con le variabili di ambiente:

"scripts": {
  "start": "FUNCTION_TARGET=YOUR_FUNCTION_NAME FUNCTION_SIGNATURE_TYPE=YOUR_SIGNATURE_TYPE npx functions-framework"
}

Sostituisci YOUR_FUNCTION_NAME con il nome del metodo della funzione e YOUR_SIGNATURE_TYPE (se applicabile) con il tipo di firma della funzione, come mostrato nella tabella precedente.

Python

Il framework di Functions per Python ti consente di specificare il nome e il tipo di firma della funzione come argomenti della riga di comando o variabili di ambiente. Gli argomenti della riga di comando devono essere specificati quando esegui il framework.

Go

Il framework di Functions per Go utilizza funcframework.RegisterHTTPFunctionContext per specificare tipo di firma e destinazione della funzione.

Java

Il framework di Functions per Java accetta i dati di configurazione da tre diverse origini, nel seguente ordine di priorità (dalla più specifica alla meno specifica):

Argomenti della riga di comando
File di build
Variabili di ambiente

Argomenti della riga di comando

Maven

Puoi specificare la funzione che vuoi eseguire aggiungendo il seguente flag dell'interfaccia a riga di comando (CLI) ai comandi mvn:

-Drun.functionTarget=YOUR_FUNCTION_NAME

Puoi anche specificare la porta di destinazione aggiungendo il seguente flag dell'interfaccia a riga di comando in modo simile:

-Drun.port=12345

Gradle

I flag dell'interfaccia a riga di comando di Gradle sono quasi identici a quelli di Maven. L'unica modifica apportata da Gradle è la sostituzione di -D iniziale in ogni flag con -P, come mostrato nell'esempio di seguito:

# Maven version
-Drun.functionTarget=...

# Gradle version
-Prun.functionTarget=...

File di build

Puoi anche specificare la funzione che vuoi eseguire nel file di build del progetto. Sebbene Maven e Gradle abbiano flag dell'interfaccia a riga di comando simili, le clausole dei file di build differiscono in modo significativo.

Maven

I file di build di Maven sono denominati pom.xml. Aggiungi la seguente clausola a questo file per specificare una funzione di destinazione:

<plugin>
  <groupId>com.google.cloud.functions</groupId>
  <artifactId>function-maven-plugin</artifactId>
  <version>0.11.0</version>
  <configuration>
    <functionTarget>functions.HelloWorld</functionTarget>
  </configuration>
</plugin>

Sostituisci <functionTarget> con il nome classe della tua funzione. Ad esempio, una funzione nel pacchetto functions con nome classe HelloCloudFunctions avrà un nome classe functions.HelloCloudFunctions. Questo è relativo al file di build principale, pom.xml o build.gradle.

Gradle

I file di build di Gradle sono denominati build.gradle. Aggiungi la seguente clausola a questo file per specificare una funzione di destinazione:

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

C#

Se crei il progetto utilizzando dotnet new e uno dei template specificati sopra, il framework di Functions per .NET rileverà automaticamente la funzione.

Se il progetto contiene più funzioni, consulta la sezione Esecuzione del framework per informazioni su come eseguire una funzione specifica.

Ruby

Il framework di Functions per Ruby ti consente di specificare il nome e il tipo di firma della funzione come argomenti della riga di comando o variabili di ambiente. Gli argomenti della riga di comando devono essere specificati quando esegui il framework.

PHP

Il framework di Functions per PHP ti consente di specificare variabili di ambiente come argomenti della riga di comando.

Puoi anche specificare questi valori nel file di build composer.json aggiungendo uno script start come mostrato nell'esempio seguente.

"scripts": {
   "start": [
       "Composer\\Config::disableProcessTimeout",
       "FUNCTION_TARGET=YOUR_FUNCTION_NAME php -S localhost:${PORT:-8080} vendor/bin/router.php"
    ]
}

Sostituisci YOUR_FUNCTION_NAME con il nome della funzione e YOUR_SIGNATURE_TYPE (se applicabile) con il tipo di firma della funzione, come mostrato nella tabella precedente.

Esegui il framework di Functions

Utilizza questo comando per eseguire la funzione con il framework di Functions. Per impostazione predefinita, la funzione sarà accessibile su localhost:8080, a meno che tu non specifichi esplicitamente un valore PORT.

Node.js

npm start

Python

Tramite argomenti della riga di comando:

functions-framework --target=YOUR_FUNCTION_NAME

Tramite variabili di ambiente:

FUNCTION_TARGET=YOUR_FUNCTION_NAME functions-framework

Sostituisci YOUR_FUNCTION_NAME con il nome del metodo della funzione.

Go

cd cmd
go build
./cmd

Tramite variabili di ambiente:

cd cmd
go build
PORT=8080 ./cmd

Java

Maven

Utilizza questo comando per eseguire una funzione specificata in pom.xml:

mvn function:run

Utilizza questo comando per eseguire una funzione specificata in un argomento della riga di comando:

mvn function:run -Drun.functionTarget=YOUR_FUNCTION_NAME

Utilizza questo comando per eseguire una funzione specificata come variabile di ambiente:

FUNCTION_TARGET=YOUR_FUNCTION_NAME mvn function:run

Sostituisci YOUR_FUNCTION_NAME con il nome della classe della funzione.

Gradle

Utilizza questo comando per eseguire una funzione specificata in build.gradle:

./gradlew runFunction

Utilizza questo comando per eseguire una funzione specificata in un argomento della riga di comando:

./gradlew runFunction -Prun.functionTarget=YOUR_FUNCTION_NAME

Utilizza questo comando per eseguire una funzione specificata come variabile di ambiente:

FUNCTION_TARGET=YOUR_FUNCTION_NAME ./gradlew runFunction

Sostituisci YOUR_FUNCTION_NAME con il nome della classe della funzione.

C#

Utilizza questo comando per eseguire la funzione quando è presente esattamente una funzione nel progetto .NET attuale. (Questa è la struttura predefinita per i progetti creati dai template.)

dotnet run

Se il progetto .NET contiene più funzioni, utilizza questo comando per eseguire una funzione specifica. Sostituisci YOUR_FUNCTION_CLASSNAME con il nome classe della tua funzione, incluso lo spazio dei nomi.

dotnet run YOUR_FUNCTION_CLASSNAME

Se vuoi eseguire più funzioni contemporaneamente, devi eseguire più istanze del framework di Functions. Per evitare conflitti tra le istanze del framework in esecuzione, ogni istanza deve utilizzare un valore PORT diverso. Il comando seguente mostra come eseguire una funzione con un valore PORT di 8080.

Tramite argomenti della riga di comando:

dotnet run --target YOUR_FUNCTION_CLASSNAME --port 8080

Tramite variabili di ambiente:

FUNCTION_TARGET=YOUR_FUNCTION_CLASSNAME PORT=8080 dotnet run

Ruby

Tramite argomenti della riga di comando:

bundle exec functions-framework-ruby --target YOUR_FUNCTION_NAME

Tramite variabili di ambiente:

FUNCTION_TARGET=YOUR_FUNCTION_NAME bundle exec functions-framework-ruby

Sostituisci YOUR_FUNCTION_NAME con il nome del metodo della funzione.

PHP

export FUNCTION_TARGET=YOUR_FUNCTION_NAME
php -S localhost:8080 vendor/bin/router.php

Sostituisci YOUR_FUNCTION_NAME con il nome della funzione.

Chiama la funzione

Consulta la pagina Chiamata a funzioni locali per istruzioni su come interagire con la funzione eseguita localmente.

Esegui la pulizia

Al termine dell'esecuzione della funzione, arresta l'istanza del framework in esecuzione premendo Ctrl+C.