Sitzungen mit Cloud Firestore verarbeiten

Viele Anwendungen benötigen eine Sitzungsverarbeitung zur Authentifizierung und für Nutzereinstellungen. Sinatra enthält eine speicherbasierte Implementierung, um diese Funktion auszuführen. Diese Implementierung eignet sich jedoch nicht für eine Anwendung, die von mehreren Instanzen bereitgestellt werden kann, da sich die auf einer Instanz aufgezeichnete Sitzung von anderen Instanzen unterscheiden kann. In dieser Anleitung wird gezeigt, wie Sitzungen in App Engine verarbeitet werden.

Lernziele

• Anwendung schreiben
• Anwendung lokal ausführen
• Anwendung in App Engine bereitstellen

Kosten

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

• App Engine
• Firestore

Mit dem Preisrechner können Sie eine Kostenschätzung für Ihre voraussichtliche Nutzung vornehmen. Neuen Google Cloud-Nutzern 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.

Hinweis

1. Melden Sie sich bei Ihrem Google Cloud-Konto an. Wenn Sie mit Google Cloud noch nicht vertraut sind, erstellen Sie ein Konto, um die Leistungsfähigkeit unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.

2. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

   Hinweis: Wenn Sie die Ressourcen, die Sie in diesem Verfahren erstellen, nicht behalten möchten, erstellen Sie ein Projekt, anstatt ein vorhandenes Projekt auszuwählen. Wenn Sie fertig sind, können Sie das Projekt löschen und dadurch alle mit dem Projekt verknüpften Ressourcen entfernen.

   Zur Projektauswahl

3. Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.

4. Firestore API aktivieren.

   Aktivieren Sie die API

5. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

   Hinweis: Wenn Sie die Ressourcen, die Sie in diesem Verfahren erstellen, nicht behalten möchten, erstellen Sie ein Projekt, anstatt ein vorhandenes Projekt auszuwählen. Wenn Sie fertig sind, können Sie das Projekt löschen und dadurch alle mit dem Projekt verknüpften Ressourcen entfernen.

   Zur Projektauswahl

6. Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.

7. Firestore API aktivieren.

   Aktivieren Sie die API

8. Bereite deine Entwicklungsumgebung vor.

Projekt einrichten

1. Beginnen Sie im Terminalfenster in einem Verzeichnis Ihrer Wahl und erstellen Sie ein neues Verzeichnis mit dem Namen sessions. Der gesamte Code für diese Anleitung befindet sich im Verzeichnis sessions.

2. Wechseln Sie in das Verzeichnis sessions:

   cd sessions
   

3. Initialisieren Sie Gemfile:

   bundle init
   

4. Hängen Sie Folgendes an das resultierende Gemfile an:

   getting-started/sessions/Gemfile

   Auf GitHub ansehen

   gem "google-cloud-firestore", "~> 2.0"
   gem "sinatra", "~> 2.0"

   Das Gemfile listet alle nicht standardmäßigen Ruby-Bibliotheken auf, die App Engine zum Laden von App Engine benötigt:

   • google-cloud-firestore ist der Ruby-Client für die Firestore API.

   • Sinatra ist das Ruby-Web-Framework, das für die Anwendung verwendet wird.

5. Installieren Sie die Abhängigkeiten:

   bundle install
   

Webanwendung schreiben

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

• Erstellen Sie mit einem Texteditor im Verzeichnis sessions eine Datei namens app.rb mit folgendem Inhalt:

  getting-started/sessions/app.rb

  Auf GitHub ansehen

  require "sinatra"
  
  require_relative "firestore_session"
  
  use Rack::Session::FirestoreSession
  
  set :greetings, ["Hello World", "Hallo Welt", "Ciao Mondo", "Salut le Monde", "Hola Mundo"]
  
  get "/" do
    session[:greeting] ||= settings.greetings.sample
    session[:views] ||= 0
    session[:views] += 1
    "<h1>#{session[:views]} views for \"#{session[:greeting]}\"</h1>"
  end

Sitzungsspeicher erstellen

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. Das folgende Diagramm veranschaulicht, wie Firestore Sitzungen für die App Engine-Anwendung verarbeitet.

Sinatra unterstützt das Speichern von Sitzungsdaten in einem Cookie. Wenn Sie stattdessen in Firestore speichern möchten, müssen Sie Ihr eigenes Rack::Session - Objekt definieren.

• Erstellen Sie im Verzeichnis sessions eine Datei namens firestore_session.rb mit folgendem Inhalt:

  getting-started/sessions/firestore_session.rb

  Auf GitHub ansehen

  require "google/cloud/firestore"
  require "rack/session/abstract/id"
  
  module Rack
    module Session
      class FirestoreSession < Abstract::Persisted
        def initialize app, options = {}
          super
  
          @firestore = Google::Cloud::Firestore.new
          @col = @firestore.col "sessions"
        end
  
        def find_session _req, session_id
          return [generate_sid, {}] if session_id.nil?
  
          doc = @col.doc session_id
          fields = doc.get.fields || {}
          [session_id, stringify_keys(fields)]
        end
  
        def write_session _req, session_id, new_session, _opts
          doc = @col.doc session_id
          doc.set new_session, merge: true
          session_id
        end
  
        def delete_session _req, session_id, _opts
          doc = @col.doc session_id
          doc.delete
          generate_sid
        end
  
        def stringify_keys hash
          new_hash = {}
          hash.each do |k, v|
            new_hash[k.to_s] =
              if v.is_a? Hash
                stringify_keys v
              else
                v
              end
          end
          new_hash
        end
      end
    end
  end

Hinweis: Sinatra unterstützt verschiedene Optionen für die Sitzungsspeicherung. 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

Wie bereits erwähnt, löscht diese App keine alten oder abgelaufenen Sitzungen. Sie können in der Google Cloud Console Sitzungsdaten löschen oder eine Strategie zum automatischen Löschen implementieren.

Lokal ausführen

1. Starten Sie den HTTP-Server:

   bundle exec ruby app.rb
   

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

   Sie sehen eine von fünf Begrüßungen: "Hallo Welt", "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 Console aufrufen und bearbeiten.

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

In App Engine bereitstellen und ausführen

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

In dieser Anleitung wird der Server mithilfe der App Engine-Standardumgebung bereitgestellt.

1. Erstellen Sie im Terminalfenster eine app.yaml-Datei und fügen Sie Folgendes in die Datei ein:

   getting-started/sessions/app.yaml

   Auf GitHub ansehen

   runtime: ruby25
   entrypoint: bundle exec ruby app.rb

2. Stellen Sie die Anwendung in App Engine bereit:

   gcloud app deploy
   

3. Rufen Sie die Live-Anwendung unter der folgenden URL auf, wobei PROJECT_ID Ihre Google Cloud-Projekt-ID ist:

   https://PROJECT_ID.appspot.com

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

Fehler in der Anwendung beheben

Wenn Sie keine Verbindung zu Ihrer App Engine-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 wie message=Build failed aufgetreten sind, beheben Sie diese und stellen Sie die App Engine-Anwendung noch einmal bereit.

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 Kürzlich ausgewählte Ressourcen auf App Engine-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 Console angezeigt werden, prüfen Sie, ob der Code Ihrer Anwendung dem Code im Abschnitt zum Schreiben der Webanwendung entspricht.

   2. Die Firestore API muss aktiviert sein.

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, z. B. eine appspot.com-URL, erhalten bleiben, sollten Sie ausgewählte Ressourcen innerhalb des Projekts löschen, statt 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. Wechseln Sie in der Google Cloud Console zur Seite Ressourcen verwalten.

   Zur Seite „Ressourcen verwalten“

2. Wählen Sie in der Projektliste das Projekt aus, das Sie löschen möchten, und klicken Sie dann auf Löschen.
3. Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie auf Shut down (Beenden), um das Projekt zu löschen.

App Engine-Instanz löschen

1. Rufen Sie in der Google Cloud Console die Seite Versionen für App Engine auf.

   Zur Seite "Versionen"

2. Klicken Sie auf das Kästchen für die nicht standardmäßige Anwendungsversion, die Sie löschen möchten.
   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.

Weitere Informationen

• Weitere Cloud Functions-Anleitungen testen
• Mehr über App Engine erfahren
• Cloud Run testen, um zustandslose Container in einer vollständig verwalteten Umgebung oder im eigenen Google Kubernetes Engine-Cluster auszuführen