使用 Firestore 处理会话

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

目标

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

费用

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

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

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

准备工作

  1. 登录您的 Google Cloud 账号。如果您是 Google Cloud 新手，请创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金，用于运行、测试和部署工作负载。

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

    Go to project selector

  3. 确保您的 Google Cloud 项目已启用结算功能。

  4. 启用 Firestore API。

    启用 API

  5. Install the Google Cloud CLI.

  6. To initialize the gcloud CLI, run the following command: 

    gcloud init
    7.

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

    Go to project selector

  8. 确保您的 Google Cloud 项目已启用结算功能。

  9. 启用 Firestore API。

    启用 API

  10. Install the Google Cloud CLI.

  11. To initialize the gcloud CLI, run the following command: 

    gcloud init
    12.
  12. 在系统上安装 Python（pip 和 virtualenv）。如需查看说明，请参阅为 Google Cloud 设置 Python 开发环境。

设置项目

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

  2. 切换到 sessions 目录：

    cd sessions

  3. 请使用以下内容创建 requirements.txt：

    sessions/requirements.txt 
    google-cloud-firestore==2.5.2
flask==2.1.2

  4. 安装依赖项：

    pip install  -r requirements.txt

在本教程结束时，最终文件结构类似于以下内容：

sessions
├── app.yaml
├── main.py
└── requirements.txt

编写 Web 应用

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

多个应用窗口显示不同语言的问候语。

在应用存储用户偏好设置之前，您需要存储会话中当前用户的相关信息。此示例应用使用 Cookie 和 Firestore 来存储会话数据。

  • 在终端窗口中，使用以下内容创建名为 main.py 的文件：

    sessions/main.py 
    import random
from uuid import uuid4

from flask import Flask, make_response, request
from google.cloud import firestore

app = Flask(__name__)
db = firestore.Client()
sessions = db.collection('sessions')
greetings = [
    'Hello World',
    'Hallo Welt',
    'Ciao Mondo',
    'Salut le Monde',
    'Hola Mundo',
]

@firestore.transactional
def get_session_data(transaction, session_id):
    """ Looks up (or creates) the session with the given session_id.
        Creates a random session_id if none is provided. Increments
        the number of views in this session. Updates are done in a
        transaction to make sure no saved increments are overwritten.
    """
    if session_id is None:
        session_id = str(uuid4())   # Random, unique identifier

    doc_ref = sessions.document(document_id=session_id)
    doc = doc_ref.get(transaction=transaction)
    if doc.exists:
        session = doc.to_dict()
    else:
        session = {
            'greeting': random.choice(greetings),
            'views': 0
        }

    session['views'] += 1   # This counts as a view
    transaction.set(doc_ref, session)

    session['session_id'] = session_id
    return session

@app.route('/', methods=['GET'])
def home():
    template = '<body>{} views for "{}"</body>'

    transaction = db.transaction()
    session = get_session_data(transaction, request.cookies.get('session_id'))

    resp = make_response(template.format(
        session['views'],
        session['greeting']
        )
    )
    resp.set_cookie('session_id', session['session_id'], httponly=True)
    return resp

if __name__ == '__main__':
    app.run(host='127.0.0.1', port=8080)

  • 下图说明了 Firestore 如何处理 App Engine 应用的会话。

    架构图：用户、App Engine、Firestore。

删除会话

您可以删除会话数据或实施自动删除策略。如果您为会话使用 Memcache 或 Redis 等存储解决方案，系统会自动删除已过期的会话。

在本地运行

  1. 在您的终端窗口中，安装 Gunicorn HTTP 服务器：

    pip install gunicorn

  2. 运行 Gunicorn HTTP 服务器：

    gunicorn -b :8080 main:app

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

    Cloud Shell

    在 Cloud Shell 工具栏中，点击 Web 预览 Web 预览，然后选择在端口 8080 上预览。

    本地机器

    在浏览器中，转到 http://localhost:8080

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

    Cloud Console 中的 Firestore 会话。

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

在 App Engine 上部署并运行

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

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

  1. 在您的终端窗口中，创建一个 app.yaml 文件并复制以下内容：

    sessions/app.yaml 
    runtime: python37

  2. 在 App Engine 上部署应用：

    gcloud app deploy

  3. 访问 https://your-project-id.appspot.com 以查看实时应用：

    gcloud app browse

    其中 your-project-id 是您的 Google Cloud 项目 ID。

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

调试应用

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

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

  2. 在 Cloud Console 中，转到日志浏览器页面。

    转到“日志浏览器”页面

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

    2. 确保已启用 Firestore API。

清理

删除项目

  1. 在 Google Cloud 控制台中，进入管理资源页面。

    转到“管理资源”

  2. 在项目列表中，选择要删除的项目，然后点击删除。
  3. 在对话框中输入项目 ID，然后点击关闭以删除项目。

删除 App Engine 实例

  1. 在 Google Cloud 控制台中，转到 App Engine 的版本页面。

    转到“版本”

  2. 选中要删除的非默认应用版本对应的复选框。
  3. 如需删除应用版本，请点击删除。

后续步骤