安装 Cloud Code for VS Code 扩展程序

Cloud Code for VS Code 扩展程序在 VS Code 中添加了对 Google Cloud 开发的支持。

准备工作

在安装 Cloud Code 之前,请确认您的系统已安装并设置了以下工具:

  1. 在您的机器上安装和设置 Visual Studio Code
  2. 安装和配置语言支持。

    Cloud Code 扩展程序与以下语言搭配使用时效果最佳:

  3. 安装 Git。 将示例复制到您的计算机需要使用 Git。

  4. 安装 Docker 客户端并将其添加到 PATH 环境变量:

    • 如果您仅使用 Cloud Build 或 Jib 进行构建,则可以跳过安装 Docker。
    • 如果您使用的是 Windows Home 版,如需了解设置 Docker 客户端的步骤,请参阅 Docker Desktop for Windows Home 指南
    • 如果您使用的是 WSL,但无法安装 Docker for Desktop,请改用 minikube 进行 Cloud Code 本地开发。
  5. 如果您使用 Google Cloud,请创建 Google Cloud 项目,然后启用结算功能

    通过项目,您可以在一个位置收集单个应用的相关资源,并可管理 API、启用 Google Cloud 服务、添加和移除协作者以及管理对 Google Cloud 资源的权限。

安装 Cloud Code

从 Visual Studio Code Marketplace 安装 Google Cloud Code 扩展程序

或者,在 VS Code 中打开 Extensions 视图:

  1. 点击 “扩展程序”图标 扩展程序或按 Ctrl/Cmd+Shift+X

  2. 搜索 Google Cloud Code

    VSC Marketplace 中的 Cloud Code 扩展程序

  3. 点击安装

  4. 如果出现提示,请重启 VS Code。

    扩展程序成功安装后,Cloud Code 图标会添加到活动栏中并可供使用。您可以使用顶级应用任务栏指定您的偏好设置,以进一步配置 Cloud Code 安装:Code > Preferences > Settings > Extensions > Cloud Code

依赖项的自定义版本

默认情况下,Cloud Code 会启用自动依赖项,并自动为您安装一些命令行依赖项。如果关闭自动依赖项,您可以使用依赖项的自定义版本,但必须自行安装依赖项,Cloud Code 才能正常运行。

如需使用 Cloud Code 依赖项的自定义版本,请执行以下操作:

  1. 依次点击 settings 管理 > 设置,然后将自动依赖项 (cloudcode.autoDependencies) 设置为 off
  2. 在您的 PATH 上安装以下依赖项:

可选:使用 VsixSignTool 验证 Cloud Code vsix

如需使用 VsixSignTool 验证 Cloud Code vsix,请执行以下步骤:

  1. 确保使用以下各项:

    • Nuget 软件包管理器
    • Windows 操作系统
    • Cloud Code 的正式版
  2. 安装 Microsoft VsixSignTool,并记下安装路径。

  3. 打开 VS Code 并导航到 VSC 中的“扩展程序”图标 Extensions > Cloud Code

  4. 详细信息标签页中的扩展程序资源下,点击市场

  5. 在浏览器的 Marketplace 页面上的资源下,点击下载扩展程序以下载 Cloud Code 的打包版本。这会将 Cloud Code 的打包版本(文件扩展名为 .vsix)下载到您的默认下载目录中。

  6. 如果您希望验证与最新版本不同的其他版本,请点击版本历史记录标签页,然后选择要下载的其他版本。

  7. 下载完成后,打开终端窗口并运行以下命令:

    PATH_TO_VSIXSIGNTOOL verify PATH_TO_DOWNLOADED_VSIX
    
  8. 确认输出内容与以下内容匹配:

    VsixSignTool Success: Package PATH_TO_DOWNLOADED_VSIX is valid.

对 Google Cloud 的凭据进行身份验证

为帮助使用 Google Cloud API 开发应用,当您登录 gcloud CLI 时,系统会更新您的应用默认凭据

登录 Google Cloud

如果您尚未登录 Google Cloud,请按照以下步骤登录:

  1. 在 Cloud Code 状态栏中,点击 Cloud Code - 登录
  2. 如果这是您第一次在 IDE 中连接到 Google Cloud,系统会提示您将 https://accounts.google.com 添加到可信网域。在显示的对话框中点击配置可信网域

    “Configure Trusted Domain”(配置可信网域)对话框

  3. 按照提示使用网络浏览器登录。

  4. 当系统提示您允许 Cloud Code 访问您的 Google 帐号时,点击允许

已知问题:边缘浏览器在身份验证回调时重定向到 HTTPS

使用 Microsoft Edge 浏览器验证凭据时,您可能会注意到 Edge 浏览器将网址 http://localhost:3000 重定向到 https://localhost:3000。这会导致出现以下失败消息:

The connection for this site is not secure. localhost sent an invalid response. Try running Windows Network Diagnostics. ERR_SSL_PROTOCOL_ERROR.

要解决此问题,您可以从重定向中排除 localhost

  1. 在 Edge 浏览器的地址栏中,输入 edge://net-internals/#hsts

  2. 转到删除网域安全政策部分。

  3. 输入 localhost,然后点击删除

退出 Google Cloud

  1. 点击 Cloud Code,然后展开帮助和反馈
  2. 点击退出 Google Cloud,并在出现提示时选择退出帐号
  3. 或者,您也可以使用 Command Palette 退出。按 Ctrl/Cmd+Shift+P 或点击视图 > Command Palette,然后点击退出 Google Cloud SDK 中的所有帐号

更改活跃的 Google Cloud 项目

  1. 在 Cloud Code 状态栏中,点击活跃项目名称。

    状态栏中的活跃项目名称

  2. 在随即显示的“快速选择”菜单中,选择 sync_alt Switch Project

  3. 选择项目或在搜索栏中输入关键字以过滤项目。

对用于在本地调试应用的凭据进行身份验证

除了登录 Google Cloud 部分中的身份验证步骤之外,您还需要对凭据进行身份验证,才能在 IDE 中本地调试进行 Google API 调用的应用。

如果您没有对用于调试应用的凭据进行身份验证,则当您尝试运行/调试尝试调用 Google API 的本地应用时,IDE 会显示错误消息。

如需对凭据进行身份验证,以便在本地调试应用,请执行以下步骤:

  1. 如果您尚未将 gcloud 安装到您的机器,请执行此操作。

  2. 运行以下命令:

    gcloud auth application-default login
    
  3. 完成本地调试后,您可以通过运行以下命令来退出帐号:

    gcloud auth application-default revoke
    

如需详细了解应用默认凭据和 Google API,请参阅使用客户端库向 Cloud 服务进行身份验证

后续步骤

获取帮助

如需发送反馈,请在 GitHub 上报告问题,或者在 Stack Overflow 上提问。