开发容器教程

本教程将引导你使用 Dev Containers 扩展在 Docker 容器中运行 Visual Studio Code。完成本教程无需 Docker 的先验知识。

在 Docker 容器内部运行 VS Code 有很多好处，但在本演练中，我们将重点介绍如何使用 Docker 容器设置一个与本地环境分离的开发环境。

先决条件

你需要安装 Visual Studio Code。

安装 Docker

创建和管理容器需要 Docker。

Docker Desktop

下载并安装 Docker Desktop，或其他 Docker 选项，例如远程主机上的 Docker 或符合 Docker 规范的 CLI。

启动 Docker

运行 Docker Desktop 应用程序以启动 Docker。如果你在活动托盘中看到 Docker 鲸鱼图标，则说明它正在运行。

Docker 可能需要几分钟才能启动。如果鲸鱼图标正在动画，则它可能仍在启动过程中。你可以单击该图标查看状态。

检查 Docker

Docker 运行后，你可以通过打开一个新的终端窗口并输入命令来确认一切正常。

docker --version
# Docker version 18.09.2, build 6247962

安装扩展

Dev Containers 扩展允许你在 Docker 容器中运行 Visual Studio Code。

安装 Dev Containers 扩展

检查安装

安装 Dev Containers 扩展后，你会在最左侧看到一个新的状态栏项。

远程状态栏项可以快速显示 VS Code 正在运行的上下文（本地或远程），单击该项将调出 Dev Containers 命令。

获取示例

要创建 Docker 容器，我们将打开一个包含 Node.js 项目的 GitHub 仓库。

打开命令面板 (F1) 运行命令 Dev Containers: Try a Dev Container Sample... 并从列表中选择 Node 示例。

注意：还有其他开发容器示例，例如 vscode-remote-try-python 或 vscode-remote-try-java，但本教程将使用 vscode-remote-try-node。

等待容器构建

窗口将重新加载，但由于容器尚不存在，VS Code 将创建一个容器并将示例仓库克隆到一个隔离的容器卷中。这可能需要一些时间，进度通知将提供状态更新。幸运的是，下次打开文件夹时无需此步骤，因为容器将已存在。

容器构建完成后，VS Code 会自动连接到它，并将本地文件系统中的项目文件夹映射到容器中。

检查容器

容器运行并连接后，你应该会在状态栏左下角看到远程上下文发生变化。

检查你的环境

在容器中开发的一个有用之处在于，你可以使用应用程序所需的特定版本依赖项，而不会影响本地开发环境。

本教程的特定容器安装了 Node.js v18，你可以通过打开新终端 终端 > 新建终端 (⌃⇧` (Windows, Linux Ctrl+Shift+`)) 并输入以下命令来检查：

node --version; npm --version

这将显示以下版本：

运行应用程序

我们现在可以按 F5，这将在容器内运行应用程序。一旦进程启动，导航到 http://localhost:3000，你应该会看到简单的 Node.js 服务器正在运行！

结束容器连接

你可以通过 文件 > 关闭远程连接 结束在容器中的会话，并返回到本地运行 VS Code。

工作原理

下一节将更详细地描述 Dev Containers 扩展如何设置和配置你的容器。

Dev Containers 扩展使用 .devcontainer 文件夹中的文件，即 devcontainer.json，以及可选的 Dockerfile 或 docker-compose.yml，来创建你的开发容器。

在我们刚刚探索的示例中，项目有一个 .devcontainer 文件夹，其中包含一个 devcontainer.json 文件。该 devcontainer.json 使用镜像 mcr.microsoft.com/devcontainers/javascript-node:0-18。你可以在 devcontainers/images 仓库中更详细地探索此镜像。

首先，你的镜像由提供的 Dockerfile 或镜像名称（本例中为 mcr.microsoft.com/devcontainers/javascript-node:0-18）构建。然后，使用 devcontainer.json 中的一些设置创建并启动一个容器。最后，根据 devcontainer.json 中的设置再次安装和配置你的 Visual Studio Code 环境。例如，本示例中的开发容器安装了 streetsidesoftware.code-spell-checker 扩展。

注意：基于基础镜像中的内容，容器中将自动添加额外的配置。例如，我们在上面看到了 streetsidesoftware.code-spell-checker 扩展，容器还将包含 "dbaeumer.vscode-eslint"，因为它是 mcr.microsoft.com/devcontainers/typescript-node 的一部分。这在使用 devcontainer.json 预构建时会自动发生，你可以在预构建部分阅读更多相关内容。

完成所有这些操作后，你的本地 Visual Studio Code 副本将连接到在新开发容器内运行的 Visual Studio Code 服务器。

devcontainer.json

devcontainer.json 本质上是一个配置文件，它决定了你的开发容器如何构建和启动。

//devcontainer.json
{
  "name": "Node.js",

  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
  "image": "mcr.microsoft.com/devcontainers/javascript-node:0-18",

  // Features to add to the dev container. More info: https://containers.dev/features.
  // "features": {},

  "customizations": {
    "vscode": {
      "settings": {},
      "extensions": ["streetsidesoftware.code-spell-checker"]
    }
  },

  // "forwardPorts": [3000],

  "portsAttributes": {
    "3000": {
      "label": "Hello Remote World",
      "onAutoForward": "notify"
    }
  },

  "postCreateCommand": "yarn install"

  // "remoteUser": "root"
}

上面的示例是从我们在教程中使用的 vscode-remote-try-node 仓库中提取的。

你可以查看 devcontainer.json 选项的完整列表。

恭喜

恭喜，你已成功完成本教程！

这只是开发容器功能的一个简要概述。作为下一步，我们建议查看如何在容器中打开机器上的现有文件夹或在隔离容器卷中打开 GitHub 仓库或 PR。

查看其他远程开发扩展。

• 远程 - SSH
• WSL

或者通过安装远程开发扩展包来获取所有这些扩展。

故障排除

验证 Docker 上下文

如果你没有使用全新的 Docker 安装，并且 Dev Containers: Try a Dev Container Sample... 示例在当前上下文遇到问题，你应该检查你的 Docker 上下文。全新安装将有一个“default”上下文，你可以将其设置为当前上下文。

# Displays the list of contexts, '*' denotes the current context
docker context list

# Switches the list to the 'default' context
docker context use default