快速入门:在 App Engine 柔性环境中使用 Python

区域 ID

REGION_ID 是 Google 根据您在创建应用时选择的地区分配的缩写代码。此代码不对应于国家/地区或省,尽管某些地区 ID 可能类似于常用国家/地区代码和省代码。在 App Engine 网址中包含 REGION_ID.r 对于现有应用是可选项,但在不久后将成为所有新应用的必要项。

为了确保顺利过渡,我们正在逐步更新 App Engine 以使用地区 ID。如果我们尚未更新您的 Google Cloud 项目,则您不会看到应用的区域 ID。由于该 ID 对于现有应用是可选的,因此您在现有应用可以使用区域 ID 后无需更新网址或进行其他更改。

详细了解区域 ID

本快速入门介绍了如何创建一个显示简短消息的小型 App Engine 应用。

准备工作

  1. 登录您的 Google Cloud 帐号。如果您是 Google Cloud 新手,请创建一个帐号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金,用于运行、测试和部署工作负载。
  2. 在 Google Cloud Console 的项目选择器页面上,选择或创建一个 Google Cloud 项目。

    转到“项目选择器”

  3. 确保您的 Cloud 项目已启用结算功能。 了解如何确认您的项目是否已启用结算功能

  4. 启用 Cloud Build API。

    启用 API

  5. 安装并初始化 Cloud SDK

其他前提条件

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

    gcloud app create --project=[YOUR_PROJECT_ID]
    

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

  2. 安装以下必备组件:

    • 运行以下命令,安装包含 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 应用,则可以通过执行以下任一操作来查看其地区:

  • 运行 gcloud app describe 命令。

  • 在 Cloud Console 中打开 App Engine 信息中心。该地区会显示在页面顶部附近。

此快速入门演示了一个使用 Flask Web 框架编写的简单 Python 应用,该应用可以部署到 App Engine。虽然此示例使用 Flask,但您可以使用满足上述要求的任何 Web 框架。可供选用的框架包括 DjangoPyramidBottleweb.py

下载 Hello World 应用

我们创建了一个简单的 Python 版 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

  1. 在项目以外的目录中创建一个独立的 Python 环境并将其激活:
    python3 -m venv env
    source env/bin/activate
  2. 导航到项目目录并安装依赖项:
    cd YOUR_PROJECT_DIR
    pip install  -r requirements.txt
  3. 运行应用:
    python main.py
  4. 在网络浏览器中,输入以下地址:
    http://localhost:8080

Windows

使用 Powershell 运行 Python 软件包。

  1. 找到已安装的 Powershell
  2. 右键点击 Powershell 的快捷方式,并以管理员身份启动。
  3. 在项目以外的目录中创建一个独立的 Python 环境并将其激活:
    python -m venv env
    env\Scripts\activate
  4. 导航到项目目录并安装依赖项:
    cd YOUR_PROJECT
    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 工具中初始化为默认值的 Cloud 项目 ID 指定一个备用 Cloud 项目。示例:--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。

此时,在 App Engine 实例上运行的 Web 服务器提供显示 Hello World 消息的页面。

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

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

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

清理

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

  1. 在 Cloud Console 中,转到管理资源页面。

    转到“管理资源”

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

后续步骤

了解整个平台

现在,您已了解如何开发和部署 App Engine 应用,接下来您可以探索 Google Cloud 的其余部分。您已经安装了 Cloud SDK,它可为您提供与 Cloud SQL、Cloud Storage、Firestore 等产品交互的工具。

如需查看如何创建使用整个平台(而不仅仅是 App Engine)的应用的操作指南,请参阅我们的有关创建 Bookshelf 应用快速入门。

了解 App Engine 柔性环境

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

Hello World 代码讨论

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

main.py

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

import logging

from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello():
    """Return a friendly HTTP greeting."""
    return 'Hello World!'

@app.errorhandler(500)
def server_error(e):
    logging.exception('An error occurred during a request.')
    return """
    An internal error occurred: <pre>{}</pre>
    See logs for full stacktrace.
    """.format(e), 500

if __name__ == '__main__':
    # This is used when running locally. Gunicorn is used to run the
    # application on Google App Engine. See entrypoint in app.yaml.
    app.run(host='127.0.0.1', port=8080, debug=True)

app.yaml

app.yaml 文件描述应用的部署配置:

# 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:
  python_version: 3

# 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

在以上示例中,app.yaml 指定了该应用使用的运行时,并设置了 env: flex 以指定该应用使用柔性环境

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

此外,可选的 runtime_config 部分将 python_version 设置为使用 Python 3。如果未指定 python_version,则默认使用 Python 2。您也可以明确指定 python_version: 2

requirements.txt

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

Flask==2.0.1
gunicorn==20.1.0

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