使用 Firestore 处理会话

---

本教程介绍了如何在 App Engine 上处理会话。

许多应用需要处理会话以进行身份验证和设定用户偏好设置。 Gorilla Web Toolkit sessions 软件包附带一个基于文件系统的实现，用于执行此操作 函数。但此实现不适用于可以通过多个实例提供的应用，因为各实例之间记录的会话可能不同。通过 gorilla/sessions 还附带有基于 Cookie 的实施方法但此实现需要加密 Cookie 并将整个会话存储在客户端上，而不仅仅是执行加密和存储会话 ID，整个会话对于某些应用而言可能过大。

目标

• 编写应用。
• 在本地运行应用。
• 在 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. Install the Google Cloud CLI.

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

   gcloud init

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

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Firestore API.

   Enable the API

10. Install the Google Cloud CLI.

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

    gcloud init

12. 更新 gcloud 组件：

    gcloud components update

13. 准备开发环境。

设置项目

1. 在终端窗口中，将示例应用代码库克隆到本地机器：

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

2. 转到包含示例代码的目录：

   cd golang-samples/getting-started/sessions

了解 Web 应用

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

您需要先存储会话中当前用户的相关信息，然后应用才能拿存储用户偏好设置。此示例应用使用 Firestore 来存储会话数据。

您可以使用与 gorilla/sessions 兼容的会话存储库 firestoregorilla。

1. 应用首先导入依赖项，指定用于保存 sessions.Store 和 HTML 模板的 app 类型，并指定问候语列表。

   
   // Command sessions starts an HTTP server that uses session state.
   package main
   
   import (
   	"context"
   	"fmt"
   	"html/template"
   	"log"
   	"math/rand"
   	"net/http"
   	"os"
   
   	"cloud.google.com/go/firestore"
   	firestoregorilla "github.com/GoogleCloudPlatform/firestore-gorilla-sessions"
   	"github.com/gorilla/sessions"
   )
   
   // app stores a sessions.Store. Create a new app with newApp.
   type app struct {
   	store sessions.Store
   	tmpl  *template.Template
   }
   
   // 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. 接下来，该应用会定义 main 函数，以创建新的 app 实例、注册索引处理程序并启动 HTTP 服务器。newApp 函数使用 firestoregorilla.New 函数初始化 sessions.Store，以创建 app 实例。

   
   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")
   	}
   
   	a, err := newApp(projectID)
   	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 string) (*app, error) {
   	ctx := context.Background()
   	client, err := firestore.NewClient(ctx, projectID)
   	if err != nil {
   		log.Fatalf("firestore.NewClient: %v", err)
   	}
   	store, err := firestoregorilla.New(ctx, client)
   	if err != nil {
   		log.Fatalf("firestoregorilla.New: %v", err)
   	}
   
   	tmpl, err := template.New("Index").Parse(`<body>{{.views}} {{if eq .views 1.0}}view{{else}}views{{end}} for "{{.greeting}}"</body>`)
   	if err != nil {
   		return nil, fmt.Errorf("template.New: %w", err)
   	}
   
   	return &app{
   		store: store,
   		tmpl:  tmpl,
   	}, nil
   }
   

3. 索引处理程序获取用户的会话，如果需要的话，可创建一个会话。系统会为新会话分配一种随机语言，此时视图计数为 0。然后，视图计数会加 1，系统会保存会话，HTML 模板会写入响应。

   
   // index uses sessions to assign users a random greeting and keep track of
   // views.
   func (a *app) index(w http.ResponseWriter, r *http.Request) {
   	if r.RequestURI != "/" {
   		return
   	}
   
   	// name is a non-empty identifier for this app's sessions. Set it to
   	// something descriptive for your app. It is used as the Firestore
   	// collection name that stores the sessions.
   	name := "hello-views"
   	session, err := a.store.Get(r, name)
   	if err != nil {
   		// Could not get the session. Log an error and continue, saving a new
   		// session.
   		log.Printf("store.Get: %v", err)
   	}
   
   	if session.IsNew {
   		// firestoregorilla uses JSON, which unmarshals numbers as float64s.
   		session.Values["views"] = float64(0)
   		session.Values["greeting"] = greetings[rand.Intn(len(greetings))]
   	}
   	session.Values["views"] = session.Values["views"].(float64) + 1
   	if err := session.Save(r, w); err != nil {
   		log.Printf("Save: %v", err)
   		// Don't return early so the user still gets a response.
   	}
   
   	if err := a.tmpl.Execute(w, session.Values); err != nil {
   		log.Printf("Execute: %v", err)
   	}
   }
   

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

   

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

删除会话

firestoregorilla 不会删除旧的或已过期的会话。您可以 删除会话数据 在 Google Cloud 控制台中 或实施自动删除策略。如果您为会话使用 Memcache 或 Redis 等存储解决方案，系统会自动删除已过期的会话。

在本地运行

1. 在终端窗口中，构建 sessions 二进制文件：

   go build
   

2. 启动 HTTP 服务器：

   ./sessions
   

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

   Cloud Shell

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

   本地机器

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

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

   

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

在 App Engine 上部署并运行

您可以使用 App Engine 标准环境 来构建和部署可在负载繁重和具有大量数据的情况下可靠运行的应用。

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

app.yaml 文件包含 App Engine 标准环境配置：

runtime: go112

1. 在 App Engine 上部署应用：

   gcloud app deploy
   

2. 在浏览器中，输入以下网址：

   https://PROJECT_ID.REGION_ID.r.appspot.com

   替换以下内容：

   • PROJECT_ID：您的 Google Cloud 项目 ID
   • REGION_ID：App Engine 分配给您的应用的代码

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

调试应用

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

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

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

   转到“日志浏览器”页面

   1. 在最近选择的资源下拉列表中，点击 App Engine 应用，然后点击所有 module_id。您将看到访问您的应用时的请求列表，如果您未发现请求列表，请确认您是否已从下拉列表中选择所有 module_id。如果您发现 Google Cloud 控制台出现错误消息，请检查应用代码是否与“编写 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 Run functions 教程。
• 详细了解 App Engine。
• 试用 Cloud Run，该平台可让您在完全托管式环境或您的自定义 Google Kubernetes Engine 集群中运行无状态容器。