在 App Engine 柔性环境中创建 Node.js 应用

在 App Engine 柔性环境中创建 Node.js 应用

区域 ID

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

详细了解区域 ID。

确定

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

准备工作

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。
   • 为 Node.js 开发准备好环境。

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 信息中心。该区域会显示在页面顶部附近。

确定

本快速入门演示了一个使用 Express.js 框架编写的简单 Node.js 应用。

重要提示：要在 Windows 上获得最佳体验，请运行 npm install -g npm 升级到最新版本的 Node.js 软件包管理器 (npm)。最新版本的 npm 在扁平化目录结构中安装依赖项，因此安装过程不太可能与 Windows 中 255 个字符的最大路径长度限制产生冲突。如果您希望继续使用旧版本的 npm，可以将项目移动到驱动器的根目录（例如 C:\）来缩短路径长度。

下载 Hello World 应用

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

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

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

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

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

      cd nodejs-docs-samples/appengine/hello-world/flexible/
   

在本地机器上运行 Hello World

1. 安装此项目的依赖项。

   npm install
   

   或者，如果您使用的是 Yarn，请运行以下命令：

   yarn install
   

2. 运行启动脚本。

   npm start
   

   或者，如果您使用的是 Yarn，请运行以下命令：

   yarn start
   

3. 在网络浏览器中查看您的应用。

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

   • 如果您没有使用 Cloud Shell，请输入以下地址：

   http://localhost:8080

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

在 App Engine 上部署并运行 Hello World

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

1. 从 hello-world/flexible/ 目录运行以下命令来部署 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 参考。

   确定
   注意：在部署期间，系统会默认使用 npm install 来安装依赖项；不过，如果存在 yarn.lock 文件且该文件没有列在 app.yaml 文件的 skip_files 部分中，系统会改用 yarn install --production。要回退到使用 npm install 命令，请删除 yarn.lock 文件，或者将 yarn.lock 添加到 app.yaml 文件的 skip_files 部分。

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 应用，因为它只包含一项服务，只有一个版本，并且所有代码都位于应用的根目录中。本部分详细介绍各应用文件。

app.js

app.js 文件包含用于启动服务器和响应请求的 JavaScript 代码。

以下代码会通过在端口 8080 上运行的服务器来响应来自网络客户端的请求，响应方法是显示“Hello World”消息。

const express = require('express');

const app = express();

app.get('/', (req, res) => {
  res.status(200).send('Hello, world!').end();
});

// Start the server
const PORT = parseInt(process.env.PORT) || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

app.yaml

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

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

• 指定应用使用的运行时。

  runtime: nodejs
  env: flex
  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/nodejs/configuring-your-app-with-app-yaml
  manual_scaling:
    instances: 1
  resources:
    cpu: 1
    memory_gb: 0.5
    disk_size_gb: 10
  

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

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

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

  package.json

  package.json 用于指定应用依赖项、节点版本和应用启动。

  {
    "name": "appengine-hello-world",
    "description": "Simple Hello World Node.js sample for Google App Engine Flexible Environment.",
    "version": "0.0.2",
    "private": true,
    "license": "Apache-2.0",
    "author": "Google Inc.",
    "repository": {
      "type": "git",
      "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
    },
    "engines": {
      "node": ">=16.0.0"
    },
    "scripts": {
      "start": "node app.js",
      "test": "c8 mocha -p -j 2 --exit test/*.test.js"
    },
    "dependencies": {
      "express": "^4.17.1"
    },
    "devDependencies": {
      "c8": "^10.0.0",
      "mocha": "^10.0.0",
      "supertest": "^7.0.0"
    }
  }
  

  在上述示例中，package.json 文件指定应用使用 Node.js 18 及更高版本，并且依赖于 express。如需详细了解如何安装和运行应用，请参阅 Node.js 运行时文档。