使用 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) 扩展。要安装开发容器扩展，请打开“扩展”视图（⇧⌘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://: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 并在第 6 行通过点击边栏或按下 F9 来设置断点。
res.render('index', { title: 'Express' });
现在，在您的浏览器中访问 https://:3000，您将看到断点如期触发！
安装扩展
就像普通的 VS Code 实例一样，在附加到开发容器时，您可以安装和使用扩展。
根据扩展的类型，它可以在客户端运行，也可以在远程 VS Code 服务器上的容器中运行。主要基于 UI 的扩展（例如主题和代码片段）保留在客户端，而所有其他扩展都安装在容器中。这使得您在每个环境中工作时只拥有所需的扩展，同时在所有环境中保持一致的 UI。
如果您打开“扩展”视图（⇧⌘X (Windows, Linux Ctrl+Shift+X)），您将看到已在本地安装的扩展以及已在当前容器实例中安装的扩展列表。需要安装在容器中的本地已安装扩展（例如下面的 Azure 帐户扩展）将显示为灰色。
让我们通过在“扩展”视图中键入“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