在 App Engine 彈性環境中建立 Python 應用程式

在 App Engine 彈性環境中建立 Python 應用程式

區域 ID

REGION_ID 是 Google 根據您在建立應用程式時選取的地區所指派的縮寫代碼。此代碼不對應至國家/地區或省份，即使部分區域 ID 可能與常用的國家/地區和省份代碼相似。如果是 2020 年 2 月後建立的應用程式，App Engine 網址會包含 REGION_ID.r。如果是這段時間前建立的現有應用程式，網址可選擇是否包含地區 ID。

進一步瞭解區域 ID。

確定

注意： 如要將新的 Python 網路服務部署至 Google Cloud，建議您先瞭解 Cloud Run。

本快速入門導覽課程說明如何建立及部署可顯示簡短訊息的應用程式。您可以在 app.yaml 檔案中指定執行階段版本和作業系統，針對任何支援的 Python 版本使用本快速入門導覽課程中的範例應用程式。

事前準備

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.

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

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

Enable the Cloud Build API.

Enable the API

Install the Google Cloud CLI.

如果您使用外部識別資訊提供者 (IdP)，請先 使用聯合身分登入 gcloud CLI。

如要初始化 gcloud CLI，請執行下列指令：

gcloud init

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

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

Enable the Cloud Build API.

Enable the API

Install the Google Cloud CLI.

如果您使用外部識別資訊提供者 (IdP)，請先 使用聯合身分登入 gcloud CLI。

如要初始化 gcloud CLI，請執行下列指令：

gcloud init

1. 由於新專案中 Cloud Build 使用服務帳戶的預設行為有所變更，以及預設安全機構政策變更，您可能需要將額外角色授予部署服務帳戶。如要進一步瞭解如何授予特定角色，請參閱疑難排解指南。

其他必要條件

1. 使用您的專案將 App Engine 應用程式初始化，然後選擇地區：

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   收到系統提示時，選取 App Engine 應用程式的存放地區。

   注意：應用程式的地區設定完成後即無法更改。

2. 在本機電腦上安裝下列項目：

   • 下載並安裝 Git。

• 執行下列指令來安裝包含 Python 專用 App Engine 擴充功能的 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 網路架構撰寫的最新 Python 3 應用程式 (可部署到 App Engine)。雖然本範例使用 Flask，但您也可利用其他符合上述需求的網路架構。其他架構包括 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，請在工具列中按一下「Web Preview」(網頁預覽)，然後選取「Preview on port 8080」(透過以下通訊埠預覽：8080)。

Windows

注意：這些操作說明講解的主題是如何在 Python 3 中設定虛擬環境。如果是 Python 2 應用程式，請使用 virtualenv 設定虛擬環境。

請使用 PowerShell 執行 Python 套件。

1. 尋找已安裝的 PowerShell。
2. 以滑鼠右鍵按一下 PowerShell 的捷徑，然後以系統管理員的身分啟動 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 鍵來關閉網路伺服器。

在 App Engine 上部署並執行 Hello World

如要將您的應用程式部署到 App Engine 彈性環境：

1. 在 hello_world 目錄執行下列指令，以部署 Hello World 應用程式：

   gcloud app deploy

   瞭解選用標記。

   常見的 gcloud 指令標記

   • 加上 --version 標記以指定專門用來辨識您應用程式版本的 ID。如未指定，將由系統自動產生，例如：--version [YOUR_VERSION_ID]
   • 加上 --project 標記以指定替代 Google Cloud 專案 ID，而不使用您在 gcloud 工具中初始化為預設值的 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 是您的專案 ID。 Google Cloud

此時，顯示 Hello World 訊息的頁面是由在 App Engine 執行個體上運作的網路伺服器提供。

恭喜！您已成功將第一個 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 的開發伺服器 (在本機執行時使用)。App Engine 啟動應用程式時會設定 $PORT 變數。如要進一步瞭解 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 需要 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.8; python_version < '3.7'
gunicorn==23.0.0

requirements.txt 用於定義程式庫；該程式庫將安裝於本機，也會在部署至 App Engine 時一併安裝。