使用本地 JetBrains IDE 开发代码

借助 Cloud Workstations 插件，您可以使用 JetBrains IDE（例如 IntelliJ IDEA Ultimate、PyCharm Professional、Rider、CLion、PhpStorm 和 WebStorm）启动 Cloud Workstations 远程开发会话。

支持的操作系统

Cloud Workstations 插件支持以下操作系统：

  • Windows
  • macOS（Intel 和 Apple Silicon）
  • Linux

支持的版本

Cloud Workstations 插件支持 JetBrains IDE 和 JetBrains Gateway 最新版本和一个先前版本。当新的 JetBrains IDE 主要版本发布后，下一个 Cloud Workstations 插件版本将支持新版本，并不再支持之前支持的最早版本。

为了更轻松地保持 JetBrains 应用为最新版本，您还可以安装 JetBrains Toolbox。

如需详细了解预配置的基础映像中的 JetBrains IDE 版本，请参阅 Cloud Workstations 版本说明。

准备工作

在安装 Cloud Workstations 插件之前，请务必按照以下步骤操作：

  1. 按照步骤创建工作站。当系统提示您进行配置时，请选择与您要使用的 JetBrains IDE 对应的映像。

  2. 输入工作站的名称后，点击创建。

  3. 点击工作站页面，然后等待工作站完成创建。

  4. 下载并安装受支持版本的 JetBrains Gateway。

安装 Cloud Workstations 插件

  1. 安装 Cloud Workstations 插件：

    1. 打开 JetBrains Gateway。

    2. 选择所有提供商。

    3. 在 Install More Providers（安装更多提供方）部分，找到 Google Cloud（Google Cloud），然后点击 Install（安装）以下载 Cloud Workstations 插件。

      连接到 Cloud Workstations

  2. 安装后，Cloud Workstations 会显示在 Run the IDE Remotely 部分中。

使用 Cloud Workstations 插件连接

如需使用该插件连接到工作站，请按以下步骤操作：

  1. 打开 JetBrains Gateway。

  2. 在 Run the IDE Remotely 部分中，点击 Connect to Google Cloud。

  3. 点击登录登录您的 Google 帐号。

    1. 按照提示向 Cloud Workstations 插件授予对 Google Cloud 的访问权限。

    2. 点击继续完成登录。

  4. 点击 浏览以打开项目选择器对话框，然后选择一个 Cloud 项目。

    连接到 Cloud Workstations

  5. 在云项目下选择一个工作站，点击下一步，然后等待所选工作站启动。

  6. 选择您的 IDE 和项目：

    1. 在远程主机中选择一个 IDE 版本。

    2. 在远程主机上输入 IDE 项目路径。

      选择您的 IDE 并输入项目名称

  7. 点击 Connect，然后等待 IDE 和项目打开。

重新连接到工作站

如需快速重新连接到工作站和 IDE 项目，请执行以下操作：

  1. 打开最近的连接面板。

  2. 点击项目路径以在 Cloud Workstations 中打开 IDE。

    最近使用过的工作站列表

  3. 等待 IDE 和项目打开。

使用端口转发

使用 IDE 和项目打开 JetBrains 客户端后，您可能需要从本地机器访问 Cloud Workstations 上的远程端口。例如，当您在工作站上运行 Python 服务器时，python -m SimpleHTTPServer 8080。在某些情况下，JetBrains Gateway 会自动为您执行端口转发，以便您可以通过本地浏览器访问远程运行的项目。

您还可以手动通过端口将 Cloud Workstations 转发到本地机器，如下所示：

  1. 对于 Windows 和 Linux，从主菜单中依次选择 File > Settings。

    对于 macOS，从主菜单中依次选择 IntelliJ IDEA > Preferences。

  2. 转到工具 > 端口转发，然后添加一条新规则来为端口 8080 转发 TCP。

  3. 设置此规则后，您可以通过 http://localhost:8080 在本地访问 Cloud Workstations 的端口 8080

替换 API 端点

对于需要替换 API 端点的虚拟私有云用户，请确保插件可以连接到您的云服务。如需替换 API 端点，请按以下步骤操作：

  1. 在 Windows 和 Linux 中，依次点击 settings 选项菜单 > 设置。

    在 macOS 中，依次点击 settings Options menu > Preferences。

  2. 可选：如需访问 IntelliJ 和其他 IDE 的 JetBrains 设置，请参阅配置项目设置。

  3. 转到工具 > Google Cloud Workstations > 高级。

  4. 添加了 API 端点替换网址。

  5. 点击应用。

如需详细了解如何在 Google Cloud 中使用端点，请参阅有关通过端点访问 Google API 的虚拟私有云说明。

适用于 BYOID 用户的备用连接说明

如果您使用 BYOID，则需要执行额外的步骤来与 JetBrains Gateway 连接。请按照以下步骤操作：

启动工作站并打开 TCP 连接

以下步骤将启动您的工作站并打开 TCP 连接：

  1. 按照“准备工作”部分中的说明操作。

  2. 确保您的工作站正在运行。您可以使用以下 gcloud CLI 命令来启动它。

    gcloud workstations start WORKSTATION_ID –-project=PROJECT \
  --cluster=WORKSTATION_CLUSTER_ID --config=WORKSTATION_CONFIG_ID \
  --region=WORKSTATION_CLUSTER_REGION

  3. 在端口 22 上启动通向工作站的 TCP 隧道：

    gcloud workstations start-tcp-tunnel --project=PROJECT \
    --cluster=WORKSTATION_CLUSTER_ID \
    --config=WORKSTATION_CONFIG_ID \
    --region=WORKSTATION_CLUSTER_REGION \
    WORKSTATION_ID 22 --local-host-port=127.0.0.1:2222

完成初始设置和安装后，下一步是启动 JetBrains Gateway。

启动 JetBrains Gateway

  1. 启动 JetBrains Gateway 后，选择 Connect via SSH。

  2. 在 Connect to SSH 页面上，点击 Settings 以设置新连接。

    在“SSH 配置”页面中：

    1. 点击 add添加新连接。
    2. 输入您的连接信息。例如，Local Host=127.0.0.1、Port=2222 和 Username=user。请务必使用适合您本地主机、端口和用户名配置的值。
    3. 将身份验证类型设置为密码，并将密码字段留空。
    4. 清除 Parse config file ~/.ssh/config 选项
    5. 点击确定以创建连接。
    6. 点击检查连接并继续。

  3. 在 Choose IDE and Project 页面上，选择以下选项：

    1. 选择要使用的 IDE。

    2. 依次点击 more_horiz 和 More，选择包含您项目的目录。请注意，您无法通过此菜单创建项目。您只能打开项目。如需创建新项目，请选择 Open an SSH Terminal（打开 SSH 终端）并运行命令，为您的 JetBrains 项目创建目录。

      或者，您也可以点击打开 SSH 终端，在工作站内运行 git 命令。例如，以下命令会克隆主目录中的 Cloud Code Samples 项目：

      git clone https://github.com/GoogleCloudPlatform/cloud-code-samples.git

    3. 选择项目目录后，点击 Download and Start IDE。

  4. 连接 IDE 后，您可以直接从 JetBrains IDE 访问工作站中的文件，该 IDE 还可以使用 Cloud Workstations 扩展程序帮助构建和运行代码。