使用 VS Code 检查容器

2019 年 10 月 31 日，Bowden Kelly，@bowdenk7

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

此技术允许您通过命令行检查容器环境，但它没有为您提供一套丰富的工具来诊断问题。

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

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

准备工作

这篇博客文章假设您已安装 Docker Desktop 和 Visual Studio Code。您还需要 Dev Containers 扩展。要安装 Dev Containers 扩展，请打开扩展视图 (⇧⌘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

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

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

构建并运行

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

docker-compose up

如果一切正常，您应该看到如下输出

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

附加到容器

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

在活动栏中选择“远程资源管理器”，以在“其他容器”部分中查看您可以附加到的正在运行的容器列表。找到我们刚刚启动的容器，它的名称为“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' });

现在在浏览器中转到 https://127.0.0.1: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

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

后续步骤

在这篇博客文章中，我们介绍了如何使用 Dev Containers 扩展来附加到您现有的容器化应用程序。

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

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

远程编码愉快！

Bowden Kelly，VS Code 项目经理 @bowdenk7