HTTP-Cloud Functions-Funktion mit Go erstellen und bereitstellen

HTTP-Cloud Functions-Funktion mit Go erstellen und bereitstellen

Einführung

Dieser Leitfaden erläutert Ihnen den Prozess zum Schreiben einer Cloud Functions-Funktion mithilfe der Go-Laufzeit. Es gibt zwei Arten von Cloud Functions-Funktionen:

• Eine HTTP-Funktion, die Sie über Standard-HTTP-Anfragen aufrufen.
• Eine ereignisgesteuerte Funktion, die durch Ereignisse in Ihrer Cloud-Infrastruktur ausgelöst wird, z. B. Nachrichten in einem Pub/Sub-Thema oder Änderungen in einem Cloud Storage-Bucket.

Weitere Informationen finden Sie unter HTTP-Funktionen schreiben und Ereignisgesteuerte Funktionen schreiben.

Hinweise

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 und 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 und Cloud Logging APIs.

   Enable the APIs

8. Installieren und initialisieren Sie die gcloud CLI.
Hinweis: Benötigen Sie eine Eingabeaufforderung? Dazu steht die Google Cloud Shell zur Verfügung. Google Cloud Shell ist eine Befehlszeilenumgebung, in der die Google Cloud CLI bereits enthalten ist und daher nicht installiert werden muss. Die Google Cloud CLI ist außerdem auf den virtuellen Maschinen von Google Compute Engine vorinstalliert.
9. Aktualisieren und installieren Sie gcloud-Komponenten mit dem folgenden Befehl.

   gcloud components update

10. Bereiten Sie die Entwicklungsumgebung vor.

    Zum Einrichtungsleitfaden für Go

Funktion erstellen

1. Erstellen Sie in Ihrem lokalen System ein Verzeichnis für den Funktionscode:

   Linux oder MacOS X

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

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

2. Erstellen Sie eine hello_http.go-Datei im Verzeichnis helloworld mit folgendem Inhalt:

   
   // Package helloworld provides a set of Cloud Functions samples.
   package helloworld
   
   import (
   	"encoding/json"
   	"fmt"
   	"html"
   	"net/http"
   
   	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
   )
   
   func init() {
   	functions.HTTP("HelloHTTP", HelloHTTP)
   }
   
   // HelloHTTP is an HTTP Cloud Function with a request parameter.
   func HelloHTTP(w http.ResponseWriter, r *http.Request) {
   	var d struct {
   		Name string `json:"name"`
   	}
   	if err := json.NewDecoder(r.Body).Decode(&d); err != nil {
   		fmt.Fprint(w, "Hello, World!")
   		return
   	}
   	if d.Name == "" {
   		fmt.Fprint(w, "Hello, World!")
   		return
   	}
   	fmt.Fprintf(w, "Hello, %s!", html.EscapeString(d.Name))
   }
   

   Diese Beispielfunktion verwendet einen in der HTTP-Anfrage angegebenen Namen und gibt eine Begrüßung oder, wenn kein Name angegeben wird, "Hello World!" zurück.

Abhängigkeiten angeben

Erstellen Sie eine go.mod-Datei, um Ihre Abhängigkeiten zu verfolgen:

cd ~/helloworld
go mod init example.com/hello
go mod tidy

Wenn Ihre Funktion Abhängigkeiten über die Functions Framework-Bibliothek hinaus hat, bearbeiten Sie die Datei go.mod, um sie hinzuzufügen. Sie können Abhängigkeiten auch mit einem Go-Verzeichnis vendor angeben. Weitere Informationen finden Sie unter Abhängigkeiten in Go angeben.

Funktion lokal erstellen und testen

Sie können Ihre Funktion lokal erstellen und testen, ohne sie bereitzustellen. Dazu müssen Sie ein lokales main.go-Modul zum Aufrufen Ihrer Funktion erstellen.

1. Erstellen Sie ein Unterverzeichnis cmd:

   mkdir ~/helloworld/cmd
   cd ~/helloworld/cmd
   

2. Erstellen Sie ein Haupt-Go-Modul, um Ihre Funktion aufzurufen. Kopieren Sie dazu das folgende Code-Snippet in eine Datei mit dem Namen main.go in das Verzeichnis ~/helloworld/cmd:

   package main
   
   import (
     "log"
     "os"
   
     // Blank-import the function package so the init() runs
     _ "example.com/hello"
     "github.com/GoogleCloudPlatform/functions-framework-go/funcframework"
   )
   
   func main() {
     // Use PORT environment variable, or default to 8080.
     port := "8080"
     if envPort := os.Getenv("PORT"); envPort != "" {
       port = envPort
     }
     if err := funcframework.Start(port); err != nil {
       log.Fatalf("funcframework.Start: %v\n", err)
     }
   }
   

3. Lösen Sie die verbleibenden Abhängigkeiten mit dem Befehl go mod tidy auf:

   go mod tidy
   

4. Führen Sie die Funktion lokal mit dem folgenden Befehl aus:

   export FUNCTION_TARGET=HelloHTTP
   go run ~/helloworld/cmd/main.go
   

5. Testen Sie Ihre Funktion. Rufen Sie dazu http://localhost:8080 in einem Browser auf oder führen Sie curl localhost:8080 in einem anderen Fenster aus.

   Weitere Informationen finden Sie unter Anfragen an lokale Funktionen senden.

Funktion bereitstellen

Führen Sie den Befehl im Verzeichnis helloworld aus, um die Funktion bereitzustellen:

  gcloud functions deploy go-http-function \
    --gen2 \
    --runtime=go121 \
    --region=REGION \
    --source=. \
    --entry-point=HelloHTTP \
    --trigger-http \
    --allow-unauthenticated

Ersetzen Sie REGION durch den Namen der Google Cloud-Region, in der Sie die Funktion bereitstellen möchten (z. B. us-west1).

Mit dem optionalen Flag --allow-unauthenticated können Sie die Funktion ohne Authentifizierung aufrufen.

Weitere Informationen: Weitere Details finden Sie unter Cloud Functions-Funktionen bereitstellen.

Bereitgestellte Funktion testen

1. Beachten Sie nach dem Bereitstellen der Funktion das Attribut uri in der Ausgabe des Befehls gcloud functions deploy oder rufen Sie es mit dem folgenden Befehl ab:

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

   Ersetzen Sie REGION durch den Namen der Google Cloud-Region, in der Sie die Funktion bereitgestellt haben (z. B. us-west1).

2. Rufen Sie diese URL in Ihrem Browser auf: Die Funktion gibt die Nachricht „Hello World!“ zurück.

   Sie finden diese URL auch in der Google Cloud Console. Rufen Sie die Übersichtsseite „Cloud Functions“ auf und klicken Sie auf den Namen der Funktion, um die Seite Funktionsdetails zu öffnen. Öffnen Sie den Tab TRIGGER, um die URL Ihrer Funktion zu sehen.

Logs der Funktion ansehen

Logs mit dem Befehlszeilentool ansehen

Sie können die Logs Ihrer Funktion über die Cloud Logging-UI oder die Google Cloud CLI prüfen.

Wenn Sie mit der gcloud CLI Logs für Ihre Funktion aufrufen möchten, verwenden Sie den Befehl logs read:

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

Ersetzen Sie REGION durch den Namen der Google Cloud-Region, in der Sie die Funktion bereitgestellt haben (z. B. us-west1).

Die Ausgabe sollte so aussehen:

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.473
LOG:

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.370
LOG:

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.280
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "h-hello_h_t_t_p-1" on port 8080.

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.108
LOG:

Hinweis: Zwischen den Logeinträgen in Cloud Logging kann es zu einer leichten Verzögerung kommen.

Logs mit dem Logging-Dashboard ansehen

Um die Logs für Ihre Funktion mit dem Logging-Dashboard aufzurufen, öffnen Sie die Cloud Functions-Übersichtsseite. Klicken Sie in der Liste auf den Namen Ihrer Funktion und dann auf den Tab Logs.

Weitere Informationen: Weitere Einzelheiten finden Sie unter Logs schreiben, ansehen und beantworten