在 App Engine 柔性环境中创建 Python 应用

在 App Engine 柔性环境中创建 Python 应用

区域 ID

REGION_ID 是 Google 根据您在创建应用时选择的区域分配的缩写代码。此代码不对应于国家/地区或省，尽管某些区域 ID 可能类似于常用国家/地区代码和省代码。对于 2020 年 2 月以后创建的应用，REGION_ID.r 包含在 App Engine 网址中。对于在此日期之前创建的现有应用，网址中的区域 ID 是可选的。

详细了解区域 ID。

确定

本快速入门演示了如何创建和部署一个显示简短消息的应用。您可以通过在 app.yaml 文件中指定运行时版本和操作系统，将本快速入门中的示例应用用于任何受支持的 Python 版本。

准备工作

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 Cloud Build 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 Cloud Build API.

   Enable the API

10. Install the Google Cloud CLI.

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

    gcloud init

其他前提条件

1. 初始化您的项目的 App Engine 应用并选择应用的区域：

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   系统提示时，选择您希望自己的 App Engine 应用所在的区域。

   注意：应用的区域一经设置便无法更改。

2. 安装以下必备组件：

   • 下载并安装 Git。

• 运行以下命令，安装包含 App Engine Python 扩展程序的 gcloud 组件：

  gcloud components install app-engine-python
  

3. 准备 Python 开发环境。建议您在自己的系统中安装最新版本的 Python、pip 和其他相关工具。如需了解相关说明，请参阅 Python 开发环境设置指南。

App Engine 位置

App Engine 是区域级的，这意味着运行您的应用的基础架构位于特定区域并由 Google 代管，以使其在该区域内的所有可用区以冗余方式提供。

选择要在哪个区域运行应用时，首先要考虑该区域是否能满足您的延迟时间、可用性或耐用性要求。通常，您可以选择距离应用的用户最近的地区，但也要考虑提供 App Engine 的位置以及应用使用的其他 Google Cloud 产品和服务的位置。跨多个位置使用服务可能会影响应用的延迟时间及其价格。

应用的区域一经设置，便无法更改。

注意：App Engine 命令和 Google Cloud 控制台中称为 europe-west 和 us-central 的两个位置，在 Google 文档中的其他地方分别称为 europe-west1 和 us-central1。

如果您已创建 App Engine 应用，则可以通过执行以下任一操作来查看其区域：

• 运行 gcloud app describe 命令。

• 打开 Google Cloud 控制台中的 App Engine 信息中心。该区域会显示在页面顶部附近。

确定

本快速入门演示了使用 Flask Web 框架编写并且可部署到 App Engine 的最新 Python 3 应用。虽然此示例使用 Flask，但您可以使用满足上述要求的任何 Web 框架。可供选用的框架包括 Django、Pyramid、Bottle、web.py。

下载 Hello World 应用

我们创建了一个 App Engine 版 Hello World 应用，以便您快速了解如何将应用部署到 Google Cloud。

1. 将 Hello World 示例应用代码库克隆到本地机器。

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples
   

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

2. 切换到包含示例代码的目录。

      cd python-docs-samples/appengine/flexible/hello_world
   

在本地机器上运行 Hello World

如需在本地计算机上运行 Hello World 应用，请执行以下操作：

Mac OS/Linux

注意：以下说明介绍如何在 Python 3 中设置虚拟环境。对于 Python 2 应用，请使用 virtualenv 设置虚拟环境。

1. 创建一个独立的 Python 环境：

   python3 -m venv env
   source env/bin/activate

2. 如果您当前不在包含示例代码的目录中，则导航到包含 hello_world 示例代码的目录。然后安装依赖项：

   cd YOUR_SAMPLE_CODE_DIR
   pip install -r requirements.txt

3. 运行应用：

   python main.py

4. 在网络浏览器中，输入以下地址：

   http://localhost:8080

   如果您使用的是 Cloud Shell，请改为在工具栏中点击网页预览，然后选择在端口 8080 上预览。

Windows

注意：以下说明介绍如何在 Python 3 中设置虚拟环境。对于 Python 2 应用，请使用 virtualenv 设置虚拟环境。

使用 Powershell 运行 Python 包。

1. 找到已安装的 PowerShell。
2. 右键点击 Powershell 的快捷方式，并以管理员身份启动。
3. 创建一个独立的 Python 环境。

   python -m venv env
   .\env\Scripts\activate

4. 导航到项目目录并安装依赖项。如果您当前不在包含示例代码的目录中，则导航到包含 hello_world 示例代码的目录。然后安装依赖项：

   cd YOUR_SAMPLE_CODE_DIR
   pip install -r requirements.txt

5. 运行应用：

   python main.py

6. 在网络浏览器中，输入以下地址：

   http://localhost:8080

页面中随即会显示来自示例应用的 Hello World 消息。在终端窗口中，按 Ctrl+C 退出 Web 服务器。

在 App Engine 上部署并运行 Hello World

要将应用部署到 App Engine 柔性环境，请执行以下操作：

1. 从 hello_world 目录运行以下命令来部署 Hello World 应用：

   gcloud app deploy

   了解可选标志。

   常见的 gcloud 命令标志

   • 添加 --version 标志，可以指定用来唯一标识应用版本的 ID，否则系统会为您生成一个 ID。示例：--version [YOUR_VERSION_ID]
   • 添加 --project 标志，可以为您在 gcloud 工具中初始化为默认值的 Google Cloud 项目 ID 指定一个备用 Google Cloud 项目 ID。示例：--project [YOUR_PROJECT_ID]

   示例：

   gcloud app deploy --version pre-prod-5 --project my-sample-app

   如需详细了解如何从命令行部署应用，请参阅测试和部署应用。如需查看所有命令标志的列表，请参阅 gcloud app deploy 参考。

   确定

2. 启动浏览器，然后访问 https://PROJECT_ID.REGION_ID.r.appspot.com 以查看此应用

   gcloud app browse

   其中，PROJECT_ID 表示您的 Google Cloud 项目 ID。

这一次，显示 Hello World 消息的页面由在 App Engine 实例上运行的 Web 服务器提供。

恭喜！您已将第一个 App Engine 应用部署到 App Engine 柔性环境！

如果您在部署应用时遇到任何错误，请查看问题排查提示。

如需了解有关清理的信息以及可执行的后续步骤的链接，请参阅以下部分。

清理

为避免产生费用，您可以删除 Google Cloud 项目，以停止对该项目中使用的所有资源计费。

注意：删除项目会产生以下影响：
• 项目中的所有内容都会被删除。如果您将现有项目用于本文档中的任务，则删除该项目后，还将删除您已在该项目中完成的任何其他工作。
• 自定义项目 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 应用，接下来您可以探索 Google Cloud 的其余部分。您已经安装了 Google Cloud CLI，它可为您提供与 Cloud SQL、Cloud Storage、Firestore 等产品交互的工具。

了解 App Engine 柔性环境

以下主题有助于您继续了解 App Engine：

• App Engine 概览
• 请求路由
• 请求处理
• 管理实例

Hello World 代码审核

Hello World 是最简单的 App Engine 应用，因为它只包含一项服务，只有一个版本，并且所有代码都位于应用的根目录中。本部分会详细介绍每个应用文件。

main.py

Hello World 应用是一个基本的单文件式 Flask 应用。

from flask import Flask


app = Flask(__name__)


@app.route("/")
def hello() -> str:
    """Return a friendly HTTP greeting.

    Returns:
        A string with the words 'Hello World!'.
    """
    return "Hello World!"


if __name__ == "__main__":
    # This is used when running locally only. When deploying to Google App
    # Engine, a webserver process such as Gunicorn will serve the app.
    app.run(host="127.0.0.1", port=8080, debug=True)

app.yaml

app.yaml 文件描述了应用的以下配置：

• 设置 env: flex，以指示您的应用使用 App Engine 柔性环境。

• 指定应用使用的运行时。如果您排除 runtime_version 设置，则 App Engine 会使用最新的 Python 版本作为应用的默认版本。

• entrypoint 用于告知 App Engine 如何启动应用。此应用使用 gunicorn 来提供 Python 应用，以替代 Flask 的开发服务器（在本地运行时使用）。$PORT 变量由 App Engine 在启动应用时设置。如需详细了解 entrypoint，请参阅应用启动。

注意：这是运行 gunicorn 的最简单方法。但是，此方法使用单个屏蔽工作器来运行应用，意味着所有 HTTP 请求是采用连续处理，包括健康检查。在实际运行中，这会导致应用在请求缓慢时无响应。如需详细了解如何配置用于生产环境的 gunicorn，请参阅推荐的 gunicorn 配置。

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

runtime: python
env: flex
entrypoint: gunicorn -b :$PORT main:app

runtime_config:
  operating_system: ubuntu22

# This sample incurs costs to run on the App Engine flexible environment.
# The settings below are to reduce costs during testing and are not appropriate
# for production use. For more information, see:
# https://cloud.google.com/appengine/docs/flexible/python/configuring-your-app-with-app-yaml
manual_scaling:
  instances: 1
resources:
  cpu: 1
  memory_gb: 0.5
  disk_size_gb: 10

• 如需详细了解 Python 运行时的工作原理，请参阅 Python 运行时。

• 如需详细了解如何设计应用以利用多个版本和多项服务，请参阅 App Engine 概览。

• 如需详细了解 App Engine 的配置设置，请参阅使用 app.yaml 配置应用。

requirements.txt

requirements.txt 和 Python 软件包管理系统 pip 用于声明和安装应用依赖项。Hello World 应用需要使用 Web 框架 Flask 和 WSGI 服务器 Gunicorn。

Flask==3.0.3; python_version > '3.6'
Flask==2.3.3; python_version < '3.7'
Werkzeug==3.0.3; python_version > '3.6'
Werkzeug==2.3.7; python_version < '3.7'
gunicorn==22.0.0

requirements.txt 定义将在本地以及向 App Engine 部署应用时安装的库。