在 Cloud Code for IntelliJ 中在本地运行和调试 App Engine 标准应用

注意 ：Cloud Code 最多支持 Java 8 运行时。自 2024 年 1 月 31 日起，我们已停止为 App Engine 提供 Java 8 支持，并将于 2026 年 1 月 31 日弃用 Java 8。因此，Cloud Code 默认会停用 App Engine。如需在 IDE 中启用 App Engine，请依次选择 Settings > Google Cloud Code > App Engine。由于 App Engine 即将弃用，我们不建议创建新的 App Engine 项目。如需详细了解 App Engine 弃用功能，请参阅功能弃用。如需详细了解 App Engine 的运行时支持时间表，请参阅运行时支持时间表。

在将应用部署到 App Engine 之前，您可以在本地运行和调试 App Engine 标准应用。本文档介绍如何从 IntelliJ IDEA 中配置 IDE 以在本地运行和调试应用。

注意：以下 IDE 支持此功能：

• IntelliJ IDEA - Ultimate 版
• IntelliJ IDEA - Community 版

注意： 对于 App Engine 标准环境，Cloud Code 仅支持使用 Java 8 运行时的 Java 应用。

准备工作

• 确保您的应用是包含 appengine-web.xml 文件的 App Engine 标准项目

• 要在本地访问 Cloud 客户端库，请完成将 Cloud 客户端库添加到 Maven 项目程序。

注意：针对本地运行和调试的运行配置仅在 IntelliJ Ultimate 版中可用。如果您使用的是 Community 版，则可以按照在 Community 版中本地调试应用的说明，使用 Maven 或 Gradle 插件进行本地运行。

在本地运行应用

如果您使用的是 IntelliJ IDEA Ultimate 版，则可以按照以下说明在本地运行 App Engine 应用：

1. 选择文件 > 打开以打开要运行的项目。

2. 转到包含项目的目录。

3. 依次选择工具 > Cloud Code > App Engine 在本地 App Engine 标准开发服务器上运行。

构建项目需要一些时间。

修改运行配置

配置服务器

您可以修改本地服务器的运行配置：

1. 选择 Run > Edit Configurations。

2. 在 Run/Debug Configurations 对话框中，根据需要更新配置设置。以下是一些常规设置：

   • 要部署的工件。
   • App Engine 主机。
   • App Engine 端口。

添加环境变量

如果需要，将环境变量添加到配置中。

1. 选择启动/连接 (Startup/Connection) 标签。

2. 选择运行。

3. 选中传递环境变量 (Pass environment variables) 复选框。

4. 添加必要的变量。

5. 选择调试。

6. 选中传递环境变量 (Pass environment variables) 复选框。

7. 添加必要的变量。

   

8. 完成后，点击 OK。

停止服务器

要停止开发应用服务器，请选择运行 > 停止“Google App Engine 标准本地服务器”(Stop 'Google App Engine Standard Local Server')。

调试应用

您可以使用先前创建的运行配置在调试模式下运行应用，如下所示：

1. 选择运行 > 调试。

2. 在对话框中，点击 Google App Engine 标准本地服务器 (Google App Engine Standard Local Server)。

3. 项目构建完成后，您可以设置断点来调试应用。

在 Community 版中本地调试应用

如果运行基于 Java servlet 的本地应用，IntelliJ Community 版不提供内置支持。如需使用 IntelliJ Community 版在本地调试应用，请将项目配置为使用 Maven 或 Gradle 插件。

MavenGradle

使用 Maven 插件配置项目

1. 将 App Engine Maven 插件添加到项目的 pom.xml 文件中。

2. 在开发服务器上配置调试。

3. 为 Maven 创建运行/调试配置。

   

   1. 选择 Run > Edit Configurations。

   2. 点击 + Add New Configuration 图标。

   3. 选择 Maven。

   4. 在 Command line 字段中，输入 appengine:run。

   5. 点击 OK。

4. 创建远程调试配置。

   

   1. 选择 Run > Edit Configurations。

   2. 点击 + Add New Configuration 图标。

   3. 选择远程 (Remote)。

   4. 确保端口号与您在 Maven App Engine 插件配置中配置的端口号相同。默认端口为 5005。

   5. 在 Before launch 部分中，点击 + Add。

   6. 选择运行另一个配置 (Run Another Configuration)。

   7. 选择 Maven 项目的运行配置。

   8. 点击确定。

5. 要在本地调试应用，请执行以下操作：

   1. 选择运行 > 调试。

   2. 选择您的远程调试配置。

      

      您现在可以在本地调试应用。

使用 Gradle 插件配置项目

1. 创建一个新的 Gradle 项目。

2. 在开发服务器上配置调试。

3. 为 Gradle 创建运行/调试配置。

   

   1. 选择 Run > Edit Configurations。

   2. 点击 + Add New Configuration 图标。

   3. 选择 Gradle。

   4. 在 Gradle project 字段中，选择您在其中配置了 appengine-gradle-plugin 插件的模块。

   5. 在 Tasks 字段中，输入 appengineRun。

   6. 点击 OK。

4. 创建远程调试配置。

   

   1. 选择 Run > Edit Configurations。

   2. 点击 + Add New Configuration 图标。

   3. 选择远程 (Remote)。

   4. 确保端口号与您在 Gradle App Engine 插件配置中配置的端口号相同。默认端口为 5005。

   5. 在 Before launch 部分中，点击 + Add。

   6. 选择运行另一个配置 (Run Another Configuration)。

   7. 选择 Gradle 项目的运行配置。

   8. 点击 OK。

5. 要在本地调试应用，请执行以下操作：

   1. 选择运行 > 调试。

   2. 选择您的远程调试配置。

      

      您现在可以在本地调试应用。

   3. 如果控制台日志中显示 Attach Debugger 链接，请点击该链接。

      注意 ：如果您选择的端口被阻止，请在 Gradle App Engine 插件配置中配置其他端口号（例如 5009），并将远程配置中的端口号更新为相同的端口号。

后续步骤

• 接下来，您可以将应用部署到 App Engine 标准环境。

获取支持

如需在 IntelliJ IDE 中提交反馈或报告问题，请前往工具 > Cloud Code > 帮助 / 简介 > 提交反馈或报告问题，在 GitHub 上报告问题。