Sitzungen mit Cloud Firestore verarbeiten

In dieser Anleitung wird gezeigt, wie Sitzungen in Cloud Run verarbeitet werden.

Viele Anwendungen benötigen eine Sitzungsverarbeitung zur Authentifizierung und für Nutzereinstellungen. Das Paket Gorilla Web Toolkit sessions enthält eine dateisystembasierte Implementierung, um diese Funktion auszuführen. Diese Implementierung eignet sich jedoch nicht für eine Anwendung, die über mehrere Instanzen bereitgestellt werden kann, da sich die Sitzung, die in einer bestimmten Instanz aufgezeichnet wird, von Sitzungen in anderen Instanzen unterscheiden kann. Das Paket gorilla/sessions enthält außerdem eine cookiebasierte Implementierung. Diese Implementierung erfordert jedoch das Verschlüsseln von Cookies und das Speichern der gesamten Sitzung auf dem Client anstelle einer Sitzungs-ID, was für einige Anwendungen möglicherweise zu viel ist.

Ziele

• Anwendung schreiben
• Anwendung lokal ausführen
• Stellen Sie die Anwendung in Cloud Run bereit.

Kosten

In diesem Dokument verwenden Sie die folgenden kostenpflichtigen Komponenten von Google Cloud:

• Cloud Run
• Firestore

Mit dem Preisrechner können Sie eine Kostenschätzung für Ihre voraussichtliche Nutzung vornehmen.

Neuen Nutzern von Google Cloud steht möglicherweise eine kostenlose Testversion zur Verfügung.

Nach Abschluss der in diesem Dokument beschriebenen Aufgaben können Sie weitere Kosten vermeiden, indem Sie die erstellten Ressourcen löschen. Weitere Informationen finden Sie unter Bereinigen.

Hinweise

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.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Firestore API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Firestore API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

1. Öffnen Sie die Anwendung in der Google Cloud Console über Cloud Shell.

   Zu Cloud Shell

   Cloud Shell bietet Ihnen direkt über den Browser Befehlszeilenzugriff auf Ihre Cloud-Ressourcen. Öffnen Sie Cloud Shell im Browser und klicken Sie auf Fortfahren, um den Beispielcode herunterzuladen und ins Anwendungsverzeichnis zu wechseln.

2. Konfigurieren Sie in Cloud Shell die gcloud CLI, um Ihr neues Google Cloud Projekt zu verwenden:

   # Configure gcloud for your project
   gcloud config set project YOUR_PROJECT_ID
   

Projekt einrichten

1. Klonen Sie das Beispiel-App-Repository in Ihrem Terminalfenster auf Ihren lokalen Computer:

   git clone https://github.com/GoogleCloudPlatform/golang-samples.git

2. Wechseln Sie in das Verzeichnis, das den Beispielcode enthält:

   cd golang-samples/getting-started/sessions

Informationen zur Web-App

In dieser Anwendung werden Begrüßungen in verschiedenen Sprachen für jeden Nutzer angezeigt. Wiederkehrende Nutzer werden immer in derselben Sprache begrüßt.

Bevor sich in der Anwendung die Einstellungen für einen Nutzer speichern lassen, benötigen Sie eine Möglichkeit zum Speichern der Informationen über den aktuellen Nutzer in einer Sitzung. Diese Beispielanwendung verwendet Firestore zum Speichern von Sitzungsdaten.

1. Die Anwendung beginnt mit dem Import von Abhängigkeiten sowie dem Festlegen eines app-Typs für eine sessions.Store- und eine HTML-Vorlage und der Liste der Begrüßungen.

   import (
   	"context"
   	"html/template"
   	"log"
   	"math/rand"
   	"net/http"
   	"os"
   
   	"cloud.google.com/go/firestore"
   )
   
   // app stores a sessions.Store. Create a new app with newApp.
   type app struct {
   	tmpl         *template.Template
   	collectionID string
   	projectID    string
   }
   
   // session stores the client's session information.
   // This type is also used for executing the template.
   type session struct {
   	Greetings string `json:"greeting"`
   	Views     int    `json:"views"`
   }
   
   // greetings are the random greetings that will be assigned to sessions.
   var greetings = []string{
   	"Hello World",
   	"Hallo Welt",
   	"Ciao Mondo",
   	"Salut le Monde",
   	"Hola Mundo",
   }
   

2. Als Nächstes definiert die Anwendung eine main-Funktion, die eine neue app-Instanz erstellt, den Index-Handler registriert und den HTTP-Server startet. Die Funktion newApp erstellt die app-Instanz, indem sie die Werte projectID und collectionID festlegt und die HTML-Vorlage parst.

   func main() {
   	port := os.Getenv("PORT")
   	if port == "" {
   		port = "8080"
   	}
   
   	projectID := os.Getenv("GOOGLE_CLOUD_PROJECT")
   	if projectID == "" {
   		log.Fatal("GOOGLE_CLOUD_PROJECT must be set")
   	}
   
   	// collectionID is a non-empty identifier for this app, it is used as the Firestore
   	// collection name that stores the sessions.
   	//
   	// Set it to something more descriptive for your app.
   	collectionID := "hello-views"
   
   	a, err := newApp(projectID, collectionID)
   	if err != nil {
   		log.Fatalf("newApp: %v", err)
   	}
   
   	http.HandleFunc("/", a.index)
   
   	log.Printf("Listening on port %s", port)
   	if err := http.ListenAndServe(":"+port, nil); err != nil {
   		log.Fatal(err)
   	}
   }
   
   // newApp creates a new app.
   func newApp(projectID, collectionID string) (app, error) {
   	tmpl, err := template.New("Index").Parse(`<body>{{.Views}} {{if eq .Views 1}}view{{else}}views{{end}} for "{{.Greetings}}"</body>`)
   	if err != nil {
   		log.Fatalf("template.New: %v", err)
   	}
   
   	return app{
   		tmpl:         tmpl,
   		collectionID: collectionID,
   		projectID:    projectID,
   	}, nil
   }
   

3. Der Index-Handler ruft die Sitzung des Nutzers ab. Bei Bedarf erstellt er eine Sitzung. Neuen Sitzungen werden eine zufällige Sprache und 0 Aufrufe zugewiesen. Anschließend wird die Anzahl der Aufrufe um eins erhöht, die Sitzung gespeichert und die HTML-Vorlage schreibt die Antwort.

   
   // index uses sessions to assign users a random greeting and keep track of
   // views.
   func (a *app) index(w http.ResponseWriter, r *http.Request) {
   	// Allows requests only for the root path ("/") to prevent duplicate calls.
   	if r.RequestURI != "/" {
   		http.NotFound(w, r)
   		return
   	}
   
   	var session session
   	var doc *firestore.DocumentRef
   
   	isNewSession := false
   
   	ctx := context.Background()
   
   	client, err := firestore.NewClient(ctx, a.projectID)
   	if err != nil {
   		log.Fatalf("firestore.NewClient: %v", err)
   	}
   	defer client.Close()
   
   	// cookieName is a non-empty identifier for this app, it is used as the key name
   	// that contains the session's id value.
   	//
   	// Set it to something more descriptive for your app.
   	cookieName := "session_id"
   
   	// If err is different to nil, it means the cookie has not been set, so it will be created.
   	cookie, err := r.Cookie(cookieName)
   	if err != nil {
   		// isNewSession flag is set to true
   		isNewSession = true
   	}
   
   	// If isNewSession flag is true, the session will be created
   	if isNewSession {
   		// Get unique id for new document
   		doc = client.Collection(a.collectionID).NewDoc()
   
   		session.Greetings = greetings[rand.Intn(len(greetings))]
   		session.Views = 1
   
   		// Cookie is set
   		cookie = &http.Cookie{
   			Name:  cookieName,
   			Value: doc.ID,
   		}
   		http.SetCookie(w, cookie)
   	} else {
   		// The session exists
   
   		// Retrieve document from collection by ID
   		docSnapshot, err := client.Collection(a.collectionID).Doc(cookie.Value).Get(ctx)
   		if err != nil {
   			log.Printf("doc.Get error: %v", err)
   			http.Error(w, "Error getting session", http.StatusInternalServerError)
   			return
   		}
   
   		// Unmarshal documents's content to local type
   		err = docSnapshot.DataTo(&session)
   		if err != nil {
   			log.Printf("doc.DataTo error: %v", err)
   			http.Error(w, "Error parsing session", http.StatusInternalServerError)
   			return
   		}
   
   		doc = docSnapshot.Ref
   
   		// Add 1 to current views value
   		session.Views++
   	}
   
   	// The document is created/updated
   	_, err = doc.Set(ctx, session)
   	if err != nil {
   		log.Printf("doc.Set error: %v", err)
   		http.Error(w, "Error creating session", http.StatusInternalServerError)
   		return
   	}
   
   	if err := a.tmpl.Execute(w, session); err != nil {
   		log.Printf("Execute: %v", err)
   	}
   }
   

   Das folgende Diagramm zeigt, wie Firestore Sitzungen für die Cloud Run-Anwendung verarbeitet.

   

Hinweis: Firestore ist eine nichtflüchtige, verteilte Transaktionsdatenbank. Oft ist es sinnvoller, für Sitzungen eine andere Speicherlösung wie Memcache oder Redis auszuwählen, deren Designs die Vorgänge in diesem Anwendungsfall beschleunigen können.

Sitzungen löschen

Sie können Sitzungsdaten löschen oder eine automatische Löschstrategie implementieren.Google Cloud Wenn Sie zum Speichern von Sitzungen Lösungen wie Memcache oder Redis verwenden, werden abgelaufene Sitzungen automatisch gelöscht.

Lokal ausführen

1. Erstellen Sie die Binärdatei sessions im Terminalfenster:

   go build
   

2. Starten Sie den HTTP-Server:

   ./sessions
   

3. Sehen Sie sich die App in Ihrem Webbrowser an:

   Cloud Shell

   Klicken Sie in der Symbolleiste von Cloud Shell auf Webvorschau und wählen Sie Vorschau auf Port 8080 aus.

   Lokaler Computer

   Rufen Sie http://localhost:8080 im Browser auf:

   Eine dieser fünf Begrüßungen wird angezeigt: "Hello World", "Hallo Welt", "Hola mundo", "Salut le Monde" oder "Ciao Mondo". Die Sprache ändert sich, wenn Sie die Seite in einem anderen Browser oder im Inkognitomodus öffnen. Sie können die Sitzungsdaten in der Google Cloud -Konsole ansehen und bearbeiten.

   

4. Drücken Sie im Terminalfenster Control+C, um den HTTP-Server zu beenden.

In Cloud Run bereitstellen und ausführen

Mit Cloud Run können Sie eine Anwendung erstellen und bereitstellen, die unter hoher Last und mit großen Datenmengen zuverlässig ausgeführt wird.

1. Stellen Sie die Anwendung in Cloud Run bereit:

       gcloud run deploy firestore-tutorial-go 
   
       --source . --allow-unauthenticated --port=8080 
   
       --set-env-vars=GOOGLE_CLOUD_PROJECT=YOUR_PROJECT_ID
       

2. Rufen Sie die von diesem Befehl zurückgegebene URL auf, um zu sehen, wie Sitzungsdaten zwischen dem Laden der Seite beibehalten werden.

Die Begrüßung wird nun von einem Webserver bereitgestellt, der in einer Cloud Run-Instanz ausgeführt wird.

Fehler in der Anwendung beheben

Wenn Sie keine Verbindung zu Ihrer Cloud Run-Anwendung herstellen können, prüfen Sie Folgendes:

1. Überprüfen Sie, ob die gcloud-Bereitstellungsbefehle erfolgreich ausgeführt wurden und keine Fehler ausgegeben haben. Wenn Fehler aufgetreten sind (z.–B. message=Build failed), beheben Sie diese und versuchen Sie noch einmal, die Cloud Run-Anwendung bereitzustellen.

2. Rufen Sie in der Google Cloud Console die Seite Log-Explorer auf:

   Zur Seite „Log-Explorer“

   1. Klicken Sie in der Drop-down-Liste Zuletzt ausgewählte Ressourcen auf Cloud Run-Anwendung und dann auf Alle Werte für module_id. Es wird eine Liste der Anfragen abgerufen, die Sie beim Besuch Ihrer Anwendung gestellt haben. Wenn keine Anfragenliste angezeigt wird, bestätigen Sie, dass Sie Alle Werte für module_id aus der Drop-down-Liste ausgewählt haben. Wenn Fehlermeldungen in der Google Cloud Konsole angezeigt werden, prüfen Sie, ob der Code Ihrer Anwendung mit dem Code im Abschnitt zum Schreiben der Webanwendung übereinstimmt.

   2. Sorgen Sie dafür, dass die Firestore API aktiviert ist.

Bereinigen

Projekt löschen

Achtung: Das Löschen von Projekten hat folgende Auswirkungen:

• Alle Inhalte des Projekts werden gelöscht. Wenn Sie für die Aufgaben in diesem Dokument ein bereits bestehendes Projekt verwendet haben und dieses löschen, werden auch alle anderen im Rahmen des Projekts erstellten Daten gelöscht.
• Benutzerdefinierte Projekt-IDs gehen verloren. Beim Erstellen dieses Projekts haben Sie möglicherweise eine benutzerdefinierte Projekt-ID erstellt, die Sie weiterhin verwenden möchten. Damit die URLs, die die Projekt-ID nutzen, zum Beispiel eine appspot.com-URL, erhalten bleiben, sollten Sie ausgewählte Ressourcen innerhalb des Projekts löschen, anstatt das gesamte Projekt.

Wenn Sie mehrere Architekturen, Anleitungen und Kurzanleitungen durcharbeiten möchten, können Sie die Überschreitung von Projektkontingenten verhindern, indem Sie Projekte wiederverwenden.

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Cloud Run-Instanz löschen

1. In the Google Cloud console, go to the Versions page for App Engine.

   Go to Versions

2. Select the checkbox for the non-default app version that you want to delete.
   Hinweis: Die einzige Möglichkeit, die Standardversion Ihrer App Engine-Anwendung zu löschen, besteht im Löschen Ihres Projekts. Sie können jedoch die Standardversion in der Google Cloud Console anhalten. Diese Aktion fährt alle mit der Version verbundenen Instanzen herunter. Sie können diese Instanzen später neu starten.

   In der Standardumgebung der App Engine können Sie die Standardversion nur dann anhalten, wenn Ihre Anwendung eine manuelle oder einfache Skalierung aufweist.

3. Klicken Sie zum Löschen der Anwendungsversion auf Löschen.

Nächste Schritte

• Anleitungen für Cloud Run Functions
• Weitere Informationen zu Cloud Run
• Cloud Run testen, um zustandslose Container in einer vollständig verwalteten Umgebung oder im eigenen Google Kubernetes Engine-Cluster auszuführen