使用 Firestore 处理会话

许多应用需要处理身份验证和用户偏好设置的会话。Sinatra 附带一个基于内存的实现，可执行此功能。但此实现不适用于可以通过多个实例提供的应用，因为各实例之间记录的会话可能不同。本教程介绍如何在 App Engine 上处理会话。

目标

• 编写应用。
• 在本地运行应用。
• 在 App Engine 上部署应用。

费用

在本文档中，您将使用 Google Cloud 的以下收费组件：

• App Engine
• Firestore

您可使用价格计算器根据您的预计使用情况来估算费用。 Google Cloud 新用户可能有资格申请免费试用。

完成本文档中描述的任务后，您可以通过删除所创建的资源来避免继续计费。如需了解详情，请参阅清理。

准备工作

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 Firestore API.

   Enable the API

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 Firestore API.

   Enable the API

8. 准备开发环境。

设置项目

1. 在终端窗口中，从您选择的目录启动，并创建一个名为 sessions 的新目录。本教程的所有代码均位于 sessions 目录内。

2. 切换到 sessions 目录：

   cd sessions
   

3. 初始化 Gemfile：

   bundle init
   

4. 将以下内容附加到生成的 Gemfile 中：

   getting-started/sessions/Gemfile

   在 GitHub 上查看

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

   Gemfile 列出了您的应用需要 App Engine 为其加载的所有非标准 Ruby 库：

   • google-cloud-firestore 是 Firestore API 的 Ruby 客户端。

   • Sinatra 是用于该应用的 Ruby 网络框架。

5. 安装依赖项：

   bundle install
   

编写 Web 应用

此应用为每位用户显示不同语言的问候语。回访用户始终会收到同一种语言的问候语。

• 使用文本编辑器在 sessions 目录中创建一个名为 app.rb 的文件，其中包含以下内容：

  get-started/sessions/app.rb

  在 GitHub 上查看

  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

创建会话存储

在应用存储用户偏好设置之前，您需要存储会话中当前用户的相关信息。下图说明了 Firestore 如何处理 App Engine 应用的会话。

Sinatra 内置了将会话数据保存到 Cookie 的支持。要改为保存到 Firestore，您必须定义自己的 Rack::Session 对象。

• 在 sessions 目录中，创建一个名为 firestore_session.rb 的文件，其中包含以下内容：

  getting-started/sessions/firestore_session.rb

  在 GitHub 上查看

  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

注意：Sinatra 支持多种会话存储选项。Firestore 是一个持久性分布式事务型数据库。通常，为会话选择其他存储解决方案（例如 Memcache 或 Redis）更为合适，在此使用场景中，这些解决方案的设计可能会显著提升操作速度。

删除会话

如上所示，此应用不会删除旧的或过期的会话。您可以在 Google Cloud Console 中删除会话数据，也可以实施自动删除策略。

在本地运行

1. 启动 HTTP 服务器：

   bundle exec ruby app.rb
   

2. 在网络浏览器中查看应用：

   您会看到五个问候语之一：“Hello World”、“Hallo Welt”、“Hola mundo”、“Salut le Monde”或“Ciao Mondo”。如果您使用其他浏览器或无痕模式打开网页，语言会更改。您可以在 Google Cloud Console 中查看和修改会话数据。

3. 要停止 HTTP 服务器，请在终端窗口中按 Control+C。

在 App Engine 上部署并运行

通过 App Engine 标准环境，您可以构建和部署在繁重负载和大量数据的压力下仍能可靠运行的应用。

本教程使用 App Engine 标准环境来部署服务器。

1. 在终端窗口中，创建一个 app.yaml 文件并将以下内容粘贴到该文件中：

   getting-started/sessions/app.yaml

   在 GitHub 上查看

   runtime: ruby25
   entrypoint: bundle exec ruby app.rb

2. 在 App Engine 上部署应用：

   gcloud app deploy
   

3. 通过以下网址查看实际应用，其中 PROJECT_ID 是您的 Google Cloud 项目 ID：

   https://PROJECT_ID.appspot.com

现在，问候语由在 App Engine 实例上运行的网络服务器提供。

调试应用

如果您无法连接到 App Engine 应用，请检查以下内容：

1. 检查 gcloud 部署命令是否已成功完成，并且未输出任何错误。如果存在错误（例如 message=Build failed），修复问题，然后再次尝试部署 App Engine 应用。

2. 在 Google Cloud 控制台中，转到日志浏览器页面。

   转到“日志浏览器”页面

   1. 在最近选择的资源下拉列表中，点击 App Engine 应用，然后点击所有 module_id。您将看到访问您的应用时的请求列表，如果您未发现请求列表，请确认您是否已从下拉列表中选择所有 module_id。如果您看到 Google Cloud Console 输出错误消息，请检查应用代码是否与“编写 Web 应用”相关部分中的代码匹配。

   2. 确保已启用 Firestore API。

清理

删除项目

注意：删除项目会产生以下影响：

• 项目中的所有内容都会被删除。如果您将现有项目用于本文档中的任务，则删除该项目后，还将删除您已在该项目中完成的任何其他工作。
• 自定义项目 ID 丢失。创建此项目时，您可能创建了要在将来使用的自定义项目 ID。要保留使用该项目 ID 的网址（例如 appspot.com 网址），请删除项目内的所选资源，而不是删除整个项目。

如果您打算探索多个架构、教程或快速入门，则重复使用项目可以帮助您避免超出项目配额限制。

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.

删除 App Engine 实例

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.
   注意： 要删除 App Engine 应用的默认版本，只需删除您的项目即可。不过，您可以在 Google Cloud 控制台中停用默认版本。此操作将关停与该版本关联的所有实例。如果需要，您可以稍后重启这些实例。

   在 App Engine 标准环境中，只有您的应用采用手动扩缩或基本扩缩服务时，您才能停用默认版本。

3. 如需删除应用版本，请点击删除。

后续步骤

• 试用更多 Cloud Functions 教程。
• 详细了解 App Engine。
• 试用 Cloud Run，该平台可让您在完全托管式环境或您的自定义 Google Kubernetes Engine 集群中运行无状态容器。