使用 VS Code 检查容器

2019 年 10 月 31 日，作者：Bowden Kelly，@bowdenk7

开发容器化应用程序时，通常会通过使用 docker exec --it {containerID} /bin/sh 将 shell 附加到正在运行的容器来尝试调试构建和运行时问题。

此技术允许您通过命令行检查容器环境，但无法提供丰富的工具集来诊断问题。

在本文中，我们将探讨如何将 Visual Studio Code 附加到容器，以便您可以使用 VS Code 的全部功能（包括调试）来检查容器、找出问题所在并进行修复。

今年 5 月发布的开发容器扩展允许您将本地 VS Code 连接到容器主机，同时保留您的所有个性化设置、主题和键盘绑定。

先决条件

本博客文章假定您已安装Docker Desktop和Visual Studio Code。您还需要开发容器扩展。要安装开发容器扩展，请打开扩展视图（⇧⌘X（Windows、Linux Ctrl+Shift+X）），搜索“Dev Containers”，选择安装，并在出现提示时重启 VS Code。

应用程序

我们首先需要一个可以在容器中运行的应用程序。如果您已经有了，那就太好了！您可以跳过此步骤。如果没有，您可以克隆这个简单的 Node.js Express 应用程序。

注意：您无需在本地安装 Node.js，我们将在容器中运行此应用程序！

git clone https://github.com/microsoft/vscode-express-sample.git

此应用程序有一个基于 Node 10 镜像的简单 Dockerfile，以及一个我们将用于运行镜像、暴露适当端口并映射本地文件系统的 docker-compose.yml 文件。我们使用 –inspect 标志运行 Node，以便像本地运行时那样调试应用程序。在实际应用程序中，您可能需要一个单独的 Docker Compose 文件用于生产部署。

注意：您不需要 Docker Compose 文件，您也可以附加到使用单个 Dockerfile 创建的容器。

构建并运行

要构建并运行应用程序，我们首先安装依赖项，然后从终端/命令提示符运行 docker-compose up。这将下载 Node 基础镜像，复制依赖项，并启动容器

docker-compose up

如果一切顺利，您应该看到类似这样的输出

并且，您应该能够导航到 http://localhost:3000 并看到以下内容

附加到容器

现在，我们可以使用开发容器扩展附加到正在运行的容器，检查环境并调试应用程序。

选择活动栏中的远程资源管理器，可在其他容器部分查看可以附加的正在运行的容器列表。找到我们刚刚启动的容器，其名称为 'express_server_1'，然后使用连接到容器按钮附加到它。该容器现在应该显示在远程资源管理器的附加容器部分。

这将启动一个新的 VS Code 窗口（实例），右下角带有以下通知。

在此期间，VS Code 正在您应用程序运行的容器内安装一个 VS Code 服务器实例。要查看有关此安装步骤的更多详细信息和进度，可以单击通知中显示的详细信息链接。VS Code 服务器安装完成后，您的本地 VS Code 客户端将连接到远程 VS Code 服务器。结果是您的本地 VS Code 实例，包含所有设置、主题和键盘绑定，连接到容器内与应用程序一起运行的“后端”。

连接完成后，您将看到一个新的 VS Code 窗口，左下角有一个绿色指示器，表示此 VS Code 实例正在远程上下文中运行。如果您单击该指示器，将看到与当前远程上下文相关的命令下拉列表。

我们来打开应用程序，方法是选择打开文件夹按钮并导航到 /usr/src/app。请注意，“打开文件夹”对话框显示的是正在运行的容器中的文件系统，而不是本地文件系统。

打开源文件夹后，您会注意到编辑器中打开了一个文件，文件名为 express-server.json。此名称派生自您所附加到的容器镜像名称。在我们的示例中，docker-compose 创建的镜像名称是 'express_server'，它派生自文件夹名 express 和 docker-compose.yml 文件中定义的服务器名 server。此文件是与您的镜像关联的配置文件，当您附加到基于此镜像的容器时，它会记住配置设置。如果您未开启自动保存，则需要确保保存此文件。今后，当您附加到此镜像时，VS Code 将重新打开此源文件夹。

注意：您可以通过从命令面板（⇧⌘P（Windows、Linux Ctrl+Shift+P））运行命令打开容器配置文件来查看当前开发容器的此文件。

此时，VS Code 看起来与普通的本地 VS Code 窗口相同。

您可以在普通的本地 VS Code 上下文中执行任何操作。

例如，打开 app.js。右键单击第 8 行，然后执行查找所有引用以查找 usersRouter 的所有用法。任何编辑都会持久保存到本地磁盘，因为我们使用 docker-compose 文件将本地文件系统挂载到了容器中。

在容器内调试

为了进一步展示开发容器与本地环境的相似性，我们来附加一个调试器。我们在 docker-compose.yaml 中使用了 –inspect 参数启动了 Node 应用程序，因此我们只需将调试器附加到该进程即可。

在命令面板（⇧⌘P（Windows、Linux Ctrl+Shift+P））中，搜索并选择调试: 附加到 Node 进程。容器内可能正在运行多个 Node 进程。我们需要运行应用程序的那个进程，因此选择显示 bin/www 的进程。

接下来，打开 index.js，通过单击行号旁的空白区域或按 F9 在第 6 行设置一个断点。

res.render('index', { title: 'Express' });

现在，在浏览器中访问 http://localhost:3000，您会看到断点按预期触发！

安装扩展

就像普通的 VS Code 实例一样，当您附加到开发容器时，也可以安装和使用扩展。

根据扩展的类型，它可以在客户端运行，也可以在容器中的远程 VS Code 服务器上运行。主要基于 UI 的扩展（如主题和代码片段）保留在客户端，而所有其他扩展则安装在容器中。这使得您在每个环境中工作时只拥有所需的扩展，同时在所有环境中保持一致的 UI。

如果您打开扩展视图（⇧⌘X（Windows、Linux Ctrl+Shift+X）），您将看到您在本地安装的扩展列表以及在当前容器实例中安装的扩展。需要在容器中安装的本地安装扩展（如下面的 Azure Account 扩展）将显示为灰色。

我们来安装GitLens扩展，方法是在扩展视图中键入“gitlens”，然后选择在附加容器中安装。

这将提示您重启 VS Code，重启后，您会短暂看到正在安装开发容器的通知，因为容器和 VS Code 服务器将随我们新安装的扩展一起重启。

您还会注意到，我们之前看到的容器配置文件再次打开，并更新了一个新属性，列出了我们每次附加到此镜像时希望安装的扩展。

{
  "workspace": "/usr/src/app",
  "extensions": ["eamodio.gitlens"]
}

现在打开任何文件，选择一行代码，您会注意到 GitLens 提供了内联的 Git 信息！

清理

完成后，您可以从命令面板运行关闭远程连接命令，或者直接关闭 VS Code 窗口以终止远程连接。

现在，从终端/命令提示符运行 docker-compose down 以停止正在运行的容器。这将释放内存并解除占用的端口。

docker-compose down

现在您已准备好启动另一个容器并处理另一个项目了！

后续步骤

在此博客文章中，我们介绍了如何使用开发容器扩展附加到现有容器化应用程序。

您还可以创建一个devcontainer.json文件，它描述了您希望创建或附加到的开发环境，并与您的项目一起存放，以便与您的团队成员共享。

其他有用资源包括完整的在容器内开发文档、高级容器配置以及我们关于使用开发容器扩展构建独立开发环境的入门教程。

远程编程愉快！

Bowden Kelly，VS Code 项目经理 @bowdenk7