在容器中进行开发

Visual Studio Code 开发容器扩展允许您使用容器作为功能齐全的开发环境。它允许您打开容器内部（或挂载到容器中）的任何文件夹，并利用 Visual Studio Code 的全部功能集。项目中的 devcontainer.json 文件会告诉 VS Code 如何访问（或创建）一个具有明确定义工具和运行时堆栈的开发容器。此容器可用于运行应用程序或隔离处理代码库所需的工具、库或运行时。

工作区文件从本地文件系统挂载或复制/克隆到容器中。扩展程序安装并运行在容器内，在那里它们可以完全访问工具、平台和文件系统。这意味着您只需连接到不同的容器，即可无缝切换整个开发环境。

Container Architecture

这使得 VS Code 能够提供本地质量的开发体验，包括完整的智能感知（代码补全）、代码导航和调试，无论您的工具（或代码）位于何处。

开发容器扩展支持两种主要操作模式

您可以将容器用作全职开发环境
您可以附加到正在运行的容器以检查它。

注意：开发容器扩展支持开放的开发容器规范，该规范使得任何工具中的任何人都可以配置一致的开发环境。您可以在我们的开发容器常见问题解答以及规范网站 containers.dev 上了解更多信息。

入门

注意：您可以通过开发容器入门教程快速了解如何开始使用开发容器。

系统要求

本地 / 远程主机

您可以采用以下几种方式将 Docker 与开发容器扩展结合使用，包括

本地安装 Docker。
在远程环境上安装 Docker。
其他符合 Docker 规范的 CLI，本地或远程安装。
- 其他 CLI 可能可以使用，但不受官方支持。请注意，附加到 Kubernetes 集群仅需要正确配置的 kubectl CLI。

您可以在其他 Docker 选项文档中了解更多信息。

以下是一些在本地或远程主机上配置 Docker 的具体方法

Windows： Windows 10 专业版/企业版上的 Docker Desktop 2.0+。Windows 10 家庭版 (2004+) 需要 Docker Desktop 2.3+ 和 WSL 2 后端。（不支持 Docker Toolbox。不支持 Windows 容器镜像。）
macOS：Docker Desktop 2.0+。
Linux：Docker CE/EE 18.06+ 和 Docker Compose 1.21+。（不支持 Ubuntu snap 包。）
远程主机： 需要 1 GB RAM，但建议至少 2 GB RAM 和双核 CPU。

容器:

x86_64 / ARMv7l (AArch32) / ARMv8l (AArch64) Debian 9+、Ubuntu 16.04+、CentOS / RHEL 7+
x86_64 Alpine Linux 3.9+

其他基于 glibc 的 Linux 容器如果具有所需的 Linux 先决条件，也可能可以使用。

安装

要开始使用，请按照以下步骤操作

使用以下路径之一或其他 Docker 选项（例如远程主机上的 Docker 或兼容 Docker 的 CLI）为您的操作系统安装和配置 Docker。

Windows / macOS:
1. 安装 Docker Desktop for Windows/Mac。
2. 如果您在 Windows 上使用 WSL 2，请确保已启用 WSL 2 后端：右键单击 Docker 任务栏图标，然后选择 Settings。勾选 Use the WSL 2 based engine，并在 Resources > WSL Integration 下验证您的分发版已启用。
3. 当不使用 WSL 2 后端时，右键单击 Docker 任务栏图标，选择 Settings，并在 Resources > File Sharing 中更新存放源代码的位置。有关故障排除，请参阅技巧与窍门。
Linux:
1. 按照适用于您的分发版的 Docker CE/EE 官方安装说明进行操作。如果您使用 Docker Compose，也请按照Docker Compose 说明进行操作。
2. 使用终端运行以下命令将您的用户添加到 docker 组：sudo usermod -aG docker $USER
3. 退出并重新登录以使更改生效。
安装 Visual Studio Code 或 Visual Studio Code Insiders。
安装开发容器扩展。如果您计划在 VS Code 中使用其他远程扩展，可以选择安装远程开发扩展包。

使用 Git？

这里有两个注意事项

如果您在本地 Windows 和容器内使用同一个存储库，请确保设置一致的行尾符。有关详细信息，请参阅技巧与窍门。
如果您使用 Git 凭据管理器克隆，您的容器应该已经可以访问您的凭据！如果您使用 SSH 密钥，您也可以选择共享它们。有关详细信息，请参阅与容器共享 Git 凭据。

选择快速入门

本文档包含 3 个快速入门 - 我们建议从最适合您的工作流程和兴趣的那个开始

想在一个简单的示例存储库中试用开发容器吗？请查看快速入门 1：试用开发容器。
想将开发容器添加到现有的本地克隆项目吗？请查看快速入门 2：在容器中打开现有文件夹。
想处理存储库的隔离副本，例如评审 PR 或研究分支而不影响您的本地工作吗？请查看快速入门 3：在隔离容器卷中打开 Git 存储库或 PR。

快速入门：试用开发容器

最简单的入门方法是尝试一个示例开发容器。容器教程将引导您设置 Docker 和开发容器扩展，并让您选择一个示例

Select a sample from the list

注意：如果您已安装 VS Code 和 Docker，则可以使用在开发容器中打开。您可以在创建开发容器指南中了解有关此内容以及如何将其添加到您的存储库的更多信息。

快速入门：在容器中打开现有文件夹

本快速入门介绍如何为现有项目设置开发容器，以便使用文件系统上的现有源代码作为全职开发环境。请按照以下步骤操作

启动 VS Code，从命令面板 (F1) 或快速操作状态栏项运行 Dev Containers: Open Folder in Container... 命令，并选择要为其设置容器的项目文件夹。

提示： 如果您想在打开文件夹之前编辑容器的内容或设置，可以改为运行 Dev Containers: Add Dev Container Configuration Files...。
现在为您的开发容器选择一个起点。您可以从可筛选列表中选择一个基础开发容器模板，或者使用您选择的文件夹中现有的 Dockerfile 或 Docker Compose 文件（如果存在）。

注意： 使用 Alpine Linux 容器时，由于扩展内原生代码中的 glibc 依赖关系，某些扩展可能无法工作。

列表将根据您打开的文件夹的内容自动排序。

您可以通过附加功能 (Features) 定制开发容器，有关详细信息，请阅读下文。

显示的开发容器模板来自我们的第一方和社区索引，该索引是开发容器规范的一部分。我们在 devcontainers/templates 存储库中作为规范的一部分托管了一套模板。您可以浏览该存储库的 src 文件夹以查看每个模板的内容。

您还可以选择使用开发容器 CLI 发布和分发自己的开发容器模板。
选择容器的起点后，VS Code 将开发容器配置文件添加到您的项目（.devcontainer/devcontainer.json）。
VS Code 窗口将重新加载并开始构建开发容器。进度通知将提供状态更新。您只需在第一次打开开发容器时构建它；首次成功构建后再次打开文件夹会快得多。
构建完成后，VS Code 将自动连接到容器。

现在，您可以在 VS Code 中与您的项目进行交互，就像在本地打开项目一样。从现在起，当您打开项目文件夹时，VS Code 将自动检测并重用您的开发容器配置。

提示： 想使用远程 Docker 主机吗？请参阅有关在容器中打开远程 SSH 主机上的文件夹的部分以获取信息。

虽然使用这种方法将本地文件系统绑定挂载到容器中很方便，但在 Windows 和 macOS 上会带来一些性能开销。有一些技巧可以用来提高磁盘性能，或者您也可以改用隔离容器卷在容器中打开存储库。

在 Windows 上的容器中打开 WSL 2 文件夹

如果您使用Linux 的 Windows 子系统 v2 (WSL 2) 并已启用 Docker Desktop 的 WSL 2 后端，则可以使用存储在 WSL 内的源代码！

启用 WSL 2 引擎后，您可以选择以下任一方式

从已使用 WSL 扩展打开的文件夹中，使用 Dev Containers: Reopen in Container 命令。
从命令面板 (F1) 选择 Dev Containers: Open Folder in Container...，并使用本地 \\wsl$ 共享（从 Windows 端）选择 WSL 文件夹。

快速入门的其余部分照常适用！您可以在WSL 扩展的文档中了解更多信息。

在容器中打开远程 SSH 主机上的文件夹

如果您使用 Linux 或 macOS SSH 主机，可以同时使用 Remote - SSH 和开发容器扩展。您甚至不需要在本地安装 Docker 客户端。

为此

按照 Remote - SSH 扩展的安装和 SSH 主机设置步骤进行操作。
可选： 设置 SSH 基于密钥的身份验证到服务器，这样您就不需要多次输入密码。
在您的 SSH 主机上安装 Docker。您不需要在本地安装 Docker。
按照 Remote - SSH 扩展的快速入门连接到主机并在那里打开文件夹。
从命令面板 (F1, ⇧⌘P (Windows, Linux Ctrl+Shift+P)) 使用 Dev Containers: Reopen in Container 命令。

开发容器快速入门的其余部分照常适用。您可以在Remote - SSH 扩展的文档中了解更多信息。如果此模式不符合您的需求，您还可以查看在远程 Docker 主机上开发文章以获取其他选项。

在容器中打开远程隧道主机上的文件夹

您可以同时使用 Remote - Tunnels 和开发容器扩展，在容器中打开远程主机上的文件夹。您甚至不需要在本地安装 Docker 客户端。这类似于上面的 SSH 主机场景，但使用的是 Remote - Tunnels。

为此

按照 Remote - Tunnels 扩展的入门说明进行操作。
在您的隧道主机上安装 Docker。您不需要在本地安装 Docker。
按照 Remote - Tunnels 扩展的步骤连接到隧道主机并在那里打开文件夹。
从命令面板 (F1, ⇧⌘P (Windows, Linux Ctrl+Shift+P)) 使用 Dev Containers: Reopen in Container 命令。

开发容器快速入门的其余部分照常适用。您可以在Remote - Tunnels 扩展的文档中了解更多信息。如果此模式不符合您的需求，您还可以查看在远程 Docker 主机上开发文章以获取其他选项。

在容器中打开现有工作区

如果工作区仅引用 .code-workspace 文件所在文件夹的子文件夹（或文件夹本身）的相对路径，您还可以遵循类似的过程在单个容器中打开 VS Code 多根工作区。

您可以选择以下任一方式

使用 Dev Containers: Open Workspace in Container... 命令。
在容器中打开包含 .code-workspace 文件的文件夹后，使用 File > Open Workspace...。

连接后，您可能需要将 .devcontainer 文件夹添加到工作区，以便在不可见的情况下轻松编辑其内容。

另请注意，虽然不能在同一个 VS Code 窗口中为同一个工作区使用多个容器，但可以从单独的窗口中同时使用多个 Docker Compose 管理的容器。

快速入门：在隔离的容器卷中打开 Git 存储库或 GitHub PR

虽然可以在容器中打开本地克隆的存储库，但您可能希望使用存储库的隔离副本来进行 PR 评审或研究其他分支，而不影响您的工作。

存储库容器使用隔离的本地 Docker 卷，而不是绑定到本地文件系统。除了不污染您的文件树外，本地卷还具有提高 Windows 和 macOS 性能的额外好处。（有关如何在其他场景中使用这些类型的卷的信息，请参阅高级配置提高磁盘性能文章。）

例如，按照以下步骤在存储库容器中打开其中一个“try”存储库

启动 VS Code 并从命令面板 (F1) 运行 Dev Containers: Clone Repository in Container Volume...。
在出现的输入框中输入 microsoft/vscode-remote-try-node（或其他“try”存储库之一）、Git URI、GitHub 分支 URL 或 GitHub PR URL，然后按 Enter。

提示： 如果您选择私有存储库，您可能需要设置凭据管理器或将 SSH 密钥添加到 SSH 代理。请参阅与容器共享 Git 凭据。
如果您的存储库中没有 .devcontainer/devcontainer.json 文件，系统将要求您从可筛选列表或现有的 Dockerfile 或 Docker Compose 文件（如果存在）中选择一个起点。

注意： 使用 Alpine Linux 容器时，由于扩展内原生代码中的 glibc 依赖关系，某些扩展可能无法工作。

列表将根据您打开的文件夹的内容自动排序。显示的开发容器模板来自我们的第一方和社区索引，该索引是开发容器规范的一部分。我们在 devcontainers/templates 存储库中作为规范的一部分托管了一套模板。您可以浏览该存储库的 src 文件夹以查看每个模板的内容。
VS Code 窗口（实例）将重新加载、克隆源代码并开始构建开发容器。进度通知将提供状态更新。

如果您在步骤 2 中粘贴了 GitHub pull request URL，PR 将被自动检出，并且 GitHub Pull Requests 扩展将安装在容器中。该扩展提供了额外的 PR 相关功能，例如 PR 浏览器、与行内 PR 注释交互以及状态栏可见性。
构建完成后，VS Code 将自动连接到容器。现在，您可以在这个独立的环境中处理存储库源代码，就像您在本地克隆了代码一样。

请注意，如果容器由于 Docker 构建错误等原因无法启动，您可以在出现的对话框中选择 Reopen in Recovery Container 进入一个“恢复容器”，允许您编辑 Dockerfile 或其他内容。这将在最小容器中打开包含克隆存储库的 docker 卷，并显示创建日志。修复完成后，使用 Reopen in Container 重试。

提示： 想使用远程 Docker 主机吗？请参阅有关在容器中打开远程 SSH 主机上的文件夹的部分以获取信息。

信任工作区

Visual Studio Code 非常重视安全性，并希望帮助您安全地浏览和编辑代码，无论来源或原始作者是谁。工作区信任功能允许您决定项目文件夹是允许还是限制自动代码执行。

开发容器扩展已采用工作区信任。根据您打开和与源代码交互的方式，系统会在不同时点提示您决定是否信任正在编辑或执行的代码。

在容器中重新打开文件夹

为现有项目设置开发容器需要信任本地（或 WSL）文件夹。窗口重新加载前，系统将要求您信任本地（或 WSL）文件夹。

此流程有几个例外情况

单击最近条目时。
如果尚未授予信任，使用 Open Folder in Container 命令将在窗口重新加载后要求信任。

附加到现有容器

附加到现有容器时，系统将要求您确认附加意味着您信任该容器。这只会确认一次。

Workspace trust prompt when attaching to container

在卷中克隆存储库

在容器卷中克隆存储库时，系统会要求您确认克隆存储库意味着您信任该存储库。这只会确认一次。

Workspace trust prompt when cloning in container volume

检查卷

检查卷会在受限模式下开始，您可以在容器内部信任文件夹。

远程运行 Docker daemon

这意味着信任运行 Docker daemon 的机器。没有额外的确认提示（只有上面列出的本地/WSL 情况下的提示）。

创建 devcontainer.json 文件

VS Code 的容器配置存储在 devcontainer.json 文件中。此文件类似于用于调试配置的 launch.json 文件，但用于启动（或附加到）您的开发容器。您还可以指定容器运行后要安装的任何扩展或用于准备环境的 post-create 命令。开发容器配置位于 .devcontainer/devcontainer.json 下，或者作为 .devcontainer.json 文件（注意点前缀）存储在项目根目录中。

从命令面板 (F1) 选择 Dev Containers: Add Dev Container Configuration Files... 命令将所需的文件添加到您的项目作为起点，您可以根据自己的需求进一步自定义。该命令允许您根据文件夹的内容从列表中选择预定义的容器配置，重用现有的 Dockerfile，或重用现有的 Docker Compose 文件。

Select a node Dev Container Template

您也可以手动创建 devcontainer.json，并使用任何镜像、Dockerfile 或一组 Docker Compose 文件作为起点。这是一个使用预构建的开发容器镜像之一的简单示例

{
  "image": "mcr.microsoft.com/devcontainers/typescript-node",
  "forwardPorts": [3000],
  "customizations": {
    // Configure properties specific to VS Code.
    "vscode": {
      // Add the IDs of extensions you want installed when the container is created.
      "extensions": ["streetsidesoftware.code-spell-checker"]
    }
  }
}

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

要了解有关创建 devcontainer.json 文件的更多信息，请参阅创建开发容器。

开发容器功能 (Features)

开发容器的“Feature”是独立的、可共享的安装代码和开发容器配置单元。这个名称来源于这样的理念：引用其中一个 Feature，就可以让您或您的协作者快速轻松地将更多工具、运行时或库“Feature”添加到您的开发容器中以供使用。

当您使用“开发容器：添加开发容器配置文件”时，系统会显示一个脚本列表，用于自定义现有的开发容器配置，例如安装 Git 或 Azure CLI。

Dev container Features list drop down

当您在容器中重建并重新打开时，您选择的 Features 将在您的 devcontainer.json 文件中可用。

"features": {
    "ghcr.io/devcontainers/features/github-cli:1": {
        "version": "latest"
    }
}

直接编辑 devcontainer.json 中的 "features" 属性时，您将获得 IntelliSense 支持。

Intellisense when modifying terraform Feature

“开发容器：配置容器 Feature”命令允许您更新现有配置。

VS Code UI 中使用的 Features 现在来自一个中心索引，您也可以为其贡献。请参阅 Dev Containers 规范网站查看当前列表，并了解如何发布和分发 Feature。

“始终安装”的 Feature

类似于您可以将扩展设置为在开发容器中始终安装的方式，您可以使用 dev.containers.defaultFeatures 用户设置来设置您始终希望安装的 Features。

"dev.containers.defaultFeatures": {
    "ghcr.io/devcontainers/features/github-cli:1": {}
},

创建您自己的 Feature

创建和发布您自己的 Dev Container Features 也非常容易。已发布的 Features 可以作为 OCI Artifact 存储，并通过任何支持的公共或私有容器注册表进行共享。您可以在 containers.dev 上查看当前已发布的 Features 列表。

Feature 是一个独立的实体，位于一个文件夹中，至少包含一个 devcontainer-feature.json 文件和一个 install.sh 入口脚本。

+-- feature
|    +-- devcontainer-feature.json
|    +-- install.sh
|    +-- (other files)

请查看 feature/starter 仓库，了解如何使用 dev container CLI 发布您自己的公共或私有 Features 的说明。

Feature 规范和分发

Features 是开源 Development Containers Specification 的关键部分。您可以查阅关于 Feature 工作原理的更多信息以及它们的分发。

预构建开发容器镜像

我们建议预构建包含您所需工具的镜像，而不是每次在开发容器中打开项目时都创建和构建容器镜像。使用预构建的镜像将带来更快的容器启动、更简单的配置，并允许您固定到特定版本的工具，以提高供应链安全性并避免潜在的破坏。您可以通过使用 DevOps 或持续集成 (CI) 服务（例如 GitHub Actions）安排构建来自动执行镜像的预构建。

更好的是，预构建的镜像可以包含 Dev Container 元数据，因此当您引用镜像时，设置将自动拉取过来。

我们建议使用 Dev Container CLI（或支持规范的其他工具，例如 GitHub Action）来预构建镜像，因为它与 Dev Containers 扩展的最新功能（包括开发容器 Feature）保持同步。构建完镜像后，您可以将其推送到容器注册表（例如 Azure Container Registry、GitHub Container Registry 或 Docker Hub）并直接引用它。

您可以使用 devcontainers/ci 仓库中的 GitHub Action 来帮助您在工作流中复用开发容器。

有关详细信息，请访问关于预构建镜像的 dev container CLI 文章。

继承元数据

您可以通过镜像标签在预构建的镜像中包含 Dev Container 配置和 Feature 元数据。这使得镜像具备自包含性，因为当引用该镜像时（无论是直接引用、在引用的 Dockerfile 中的 FROM 中引用，还是在 Docker Compose 文件中引用），这些设置都会自动被拾取。这有助于防止您的 Dev Container 配置和镜像内容不同步，并允许您通过简单的镜像引用将相同配置的更新推送到多个仓库。

当您使用 Dev Container CLI（或支持规范的其他工具，例如 GitHub Action 或 Azure DevOps 任务）进行预构建时，会自动添加此元数据标签，并包含来自 devcontainer.json 以及所有引用的 Dev Container Features 的设置。

这允许您拥有一个单独的更复杂的 devcontainer.json 文件用于预构建镜像，然后在或多个仓库中拥有一个大大简化的文件。在创建容器时，镜像的内容将与此简化的 devcontainer.json 内容合并（有关合并逻辑的信息，请参阅规范）。但最简单的情况是，您只需在 devcontainer.json 中直接引用该镜像即可使设置生效。

{
  "image": "mcr.microsoft.com/devcontainers/go:1"
}

请注意，您也可以选择手动将元数据添加到镜像标签中。即使您没有使用 Dev Container CLI 进行构建，这些属性也会被拾取（即使您使用了，CLI 也可以更新它们）。例如，考虑这段 Dockerfile 片段：

LABEL devcontainer.metadata='[{ \
  "capAdd": [ "SYS_PTRACE" ], \
  "remoteUser": "devcontainer", \
  "postCreateCommand": "yarn install" \
}]'

检查卷

有时，您可能会遇到使用 Docker 命名卷并希望检查或更改其内容的情况。您可以通过从命令面板 (F1) 中选择“**开发容器：在开发容器中探索卷...**”，而无需创建或修改 devcontainer.json 文件，即可使用 VS Code 处理这些内容。

您还可以在远程资源管理器中检查您的卷。确保在下拉列表中选择了“容器”，然后您会看到一个“**开发卷**”部分。您可以右键单击一个卷来检查其创建信息，例如卷的创建时间、克隆到其中的仓库以及挂载点。您也可以在开发容器中探索它。

Right-click dev volumes in Remote Explorer

如果您安装了 Docker 扩展，您可以在“**Docker 资源管理器**”的“**卷**”部分右键单击一个卷，然后选择“**在开发容器中探索**”。

Explore in dev container in Docker context menu

管理扩展

VS Code 在两个位置之一运行扩展：在本地 UI/客户端侧，或在容器中。虽然影响 VS Code UI 的扩展（如主题和代码片段）是安装在本地的，但大多数扩展将驻留在特定的容器内。这允许您仅在容器中安装给定任务所需的扩展，并通过连接到新容器来无缝切换整个工具链。

如果您从扩展视图安装扩展，它将自动安装在正确的位置。您可以根据类别分组来判断扩展的安装位置。将有一个“**本地 - 已安装**”类别，还有一个是用于您的容器的类别。

Workspace Extension Category

Local Extension Category

注意： 如果您是扩展作者，并且您的扩展无法正常工作或安装位置不正确，请参阅支持远程开发了解详细信息。

实际需要在远程运行的本地扩展将显示在“**本地 - 已安装**”类别中并显示为“**已禁用**”。选择“**安装**”可在远程主机上安装扩展。

Disabled Extensions w/Install Button

您还可以通过转到扩展视图并使用“**本地 - 已安装**”标题栏右侧的云按钮选择“**在开发容器中安装本地扩展：{名称}**”，从而在开发容器中安装所有本地安装的扩展。这将显示一个下拉列表，您可以在其中选择要在容器中安装哪些本地安装的扩展。

Install all extensions

但是，某些扩展可能要求您在容器中安装其他软件。如果您遇到问题，请查阅扩展文档以获取详细信息。

将扩展添加到 devcontainer.json

您可以手动编辑 devcontainer.json 文件来添加扩展 ID 列表，也可以在扩展视图中右键单击任何扩展并选择“**添加到 devcontainer.json**”。

Add to devcontainer.json menu

排除扩展

如果基础镜像或 Feature 配置了您不希望安装在开发容器中的扩展，您可以通过使用减号列出该扩展来排除它。例如：

{
  "image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bookworm",
  "customizations": {
    "vscode": {
      "extensions": ["-dbaeumer.vscode-eslint"]
    }
  }
}

“始终安装”的扩展

如果有些扩展您希望在任何容器中始终安装，您可以更新 dev.containers.defaultExtensions 用户设置。例如，如果您想安装 GitLens 和 Resource Monitor 扩展，您可以按如下方式指定它们的扩展 ID：

"dev.containers.defaultExtensions": [
    "eamodio.gitlens",
    "mutantdino.resourcemonitor"
]

高级：强制扩展在本地或远程运行

扩展通常被设计和测试为在本地或远程运行，而不是两者兼而有之。但是，如果某个扩展支持，您可以在 settings.json 文件中强制它在特定位置运行。

例如，以下设置将强制 Docker 扩展在本地运行，而 Remote - SSH: 编辑配置文件扩展在远程运行，而不是使用它们的默认设置。

"remote.extensionKind": {
    "ms-azuretools.vscode-docker": [ "ui" ],
    "ms-vscode-remote.remote-ssh-edit": [ "workspace" ]
}

将值设置为 "ui" 而不是 "workspace" 将强制扩展在本地 UI/客户端侧运行。通常，这仅应用于测试，除非扩展文档中另有说明，因为这可能会破坏扩展。有关详细信息，请参阅首选扩展位置部分。

转发或发布端口

容器是独立的环境，因此如果您想访问容器内的服务器、服务或其他资源，您需要将端口“转发”或“发布”到您的主机。您可以配置容器始终暴露这些端口，或者仅临时转发它们。

始终转发端口

通过在 devcontainer.json 中使用 forwardPorts 属性，您可以指定在连接或在容器中打开文件夹时**始终**希望转发的端口列表。

"forwardPorts": [3000, 3001]

只需重新加载/重新打开窗口，当 VS Code 连接到容器时，设置就会生效。

临时转发端口

如果您需要访问未添加到 devcontainer.json 或未在 Docker Compose 文件中发布的端口，您可以通过从命令面板 (F1) 运行“**转发端口**”命令来**临时转发**一个新端口，其持续时间为会话期间。

Forward port input

选择端口后，通知会告诉您用于访问容器中该端口的 localhost 端口。例如，如果您转发了一个侦听端口 3000 的 HTTP 服务器，通知可能会告诉您它被映射到 localhost 上的端口 4123。然后您可以使用 http://localhost:4123 连接到此远程 HTTP 服务器。

如果您以后需要访问此信息，可以在远程资源管理器的“**已转发端口**”部分找到相同的信息。

如果您希望 VS Code 记住您转发的任何端口，请在设置编辑器 (⌘, (Windows, Linux Ctrl+,)) 中勾选“**远程：恢复已转发端口**”，或在 settings.json 中设置 "remote.restoreForwardedPorts": true。

Restore forwarded ports setting

发布端口

Docker 有在创建容器时“发布”端口的概念。已发布的端口的行为与您向本地网络提供的端口非常相似。如果您的应用程序仅接受来自 localhost 的调用，它将拒绝来自已发布端口的连接，就像您的本地计算机拒绝网络调用一样。另一方面，转发的端口对于应用程序来说实际上看起来像 localhost。每种方式在不同情况下都很有用。

要发布端口，您可以：

使用 appPort 属性： 如果您在 devcontainer.json 中引用镜像或 Dockerfile，可以使用 appPort 属性将端口发布到主机。
```
"appPort": [ 3000, "8921:5000" ]
```
使用 Docker Compose 端口映射： 端口映射可以轻松添加到您的 docker-compose.yml 文件中以发布其他端口。
```
ports:
- "3000"
- "8921:5000"
```

在每种情况下，您都需要重建容器才能使设置生效。在连接到容器时，可以通过在命令面板 (F1) 中运行“**开发容器：重建容器**”命令来完成此操作。

打开终端

从 VS Code 在容器中打开终端非常简单。在容器中打开文件夹后，您在 VS Code 中打开的**任何终端窗口**（“**终端 > 新建终端**”）都将在容器中自动运行，而不是在本地运行。

您还可以从同一个终端窗口使用 code 命令行来执行多种操作，例如在容器中打开新文件或文件夹。输入 code --help 可了解命令行可用的选项。

Using the code CLI

在容器中调试

在容器中打开文件夹后，您就可以像在本地运行应用程序一样使用 VS Code 的调试器。例如，如果您在 launch.json 中选择一个启动配置并开始调试 (F5)，应用程序将在远程主机上启动并将调试器附加到它。

有关在 .vscode/launch.json 中配置 VS Code 调试功能的详细信息，请参阅调试文档。

容器特定设置

当您连接到开发容器时，VS Code 的本地用户设置也会被重用。虽然这能保持您的用户体验一致，但您可能希望在本地计算机和每个容器之间更改其中一些设置。幸运的是，连接到容器后，您还可以通过从命令面板 (F1) 运行“**首选项：打开远程设置**”命令或在设置编辑器中选择“**远程**”选项卡来设置特定于容器的设置。每当您连接到容器时，这些设置将覆盖您所有的本地设置。

Container specific settings tab

默认的容器特定设置

您可以使用 settings 属性在 devcontainer.json 中包含容器特定设置的默认值。创建容器后，这些值将自动放置在容器内的容器特定设置文件中。

例如，将此添加到 .devcontainer/devcontainer.json 将设置 Java home 路径：

// Configure tool-specific properties.
"customizations": {
    // Configure properties specific to VS Code.
    "vscode": {
        "settings": {
            "java.home": "/docker-java-home"
        }
    }
}

由于这只是建立默认值，因此在容器创建后，您仍然可以根据需要更改设置。

管理容器

默认情况下，当您打开文件夹时，Dev Containers 扩展会自动启动 devcontainer.json 中提到的容器。当您关闭 VS Code 时，扩展会自动关闭您已连接的容器。您可以通过在 devcontainer.json 中添加 "shutdownAction": "none" 来更改此行为。

虽然您可以使用命令行管理容器，但也可以使用**远程资源管理器**。要停止容器，请从下拉菜单中选择“容器”（如果存在），右键单击正在运行的容器，然后选择“**停止容器**”。您还可以启动已退出的容器、移除容器以及移除最近的文件夹。在详细信息视图中，您可以转发端口并在浏览器中打开已转发的端口。

Containers Explorer screenshot

如果您想清理镜像或批量删除容器，请参阅清理未使用的容器和镜像以获取不同的选项。

使用 dotfile 存储库进行个性化

Dotfiles 是文件名以点号 (.) 开头的文件，通常包含各种应用程序的配置信息。由于开发容器可以涵盖广泛的应用程序类型，因此将这些文件存储在某个地方会很有用，这样您就可以在容器启动并运行后轻松地将它们复制到容器中。

一种常见的方法是将这些 dotfiles 存储在 GitHub 仓库中，然后使用工具克隆并应用它们。Dev Containers 扩展内置支持将这些 dotfiles 与您自己的容器一起使用。如果您刚接触这个概念，请查看现有的各种dotfiles 引导仓库。

要使用它，请将您的 dotfiles GitHub 仓库添加到 VS Code 的用户设置 (⌘, (Windows, Linux Ctrl+,)) 中，如下所示：

Settings for dotfiles

或在 settings.json 中：

{
  "dotfiles.repository": "your-github-id/your-dotfiles-repo",
  "dotfiles.targetPath": "~/dotfiles",
  "dotfiles.installCommand": "install.sh"
}

从此时起，每当创建容器时，都会使用该 dotfiles 仓库。

已知限制

Dev Containers 限制

不支持 Windows 容器镜像。
多根工作区中的所有根目录/文件夹将在同一个容器中打开，无论较低级别是否存在配置文件。
不支持适用于 Linux 的非官方 Ubuntu Docker snap 包。请遵循适用于您的发行版的官方 Docker 安装说明。
不支持 Windows 上的 Docker Toolbox。
如果您使用 SSH 克隆 Git 仓库并且您的 SSH 密钥有密码短语，当远程运行时，VS Code 的拉取和同步功能可能会卡住。请使用没有密码短语的 SSH 密钥，使用 HTTPS 克隆，或从命令行运行 git push 来解决此问题。
容器内部不会重用本地代理设置，这可能会阻止扩展正常工作，除非配置了适当的代理信息（例如带有适当代理信息的全局 HTTP_PROXY 或 HTTPS_PROXY 环境变量）。
当 Windows 上的 ssh-agent 运行版本 <= 8.8 且 SSH 客户端（在任何平台）运行版本 >= 8.9 时，OpenSSH 版本之间存在不兼容性。解决方法是将 Windows 上的 OpenSSH 升级到 8.9 或更高版本，可以使用 winget 或从 Win32-OpenSSH/releases 获取安装程序。（注意，ssh-add -l 可以正常工作，但 ssh <ssh-server> 将因 <ssh-server>: Permission denied (publickey) 而失败。这在使用 SSH 连接到仓库时也会影响 Git。）

请参阅此处查看与容器相关的活动问题列表。

Docker 限制

有关详细信息，请参阅适用于 Windows 或 Mac 的 Docker 故障排除指南，或查阅 Docker 支持资源。

Docker 扩展限制

如果您从 WSL、Remote - Tunnels 或 Remote - SSH 窗口使用 Docker 或 Kubernetes 扩展，在 Docker 或 Kubernetes 视图中使用“**附加 Visual Studio Code**”上下文菜单操作将要求您再次从可用容器中进行选择。

扩展限制

目前，大多数扩展无需修改即可在 Dev Containers 中运行。但是，在某些情况下，某些功能可能需要更改。如果您遇到扩展问题，请参阅此处，获取常见问题和解决方案的摘要，您可以在报告问题时向扩展作者提及。

此外，虽然支持 Alpine，但由于扩展内部原生代码中的 glibc 依赖项，容器中安装的一些扩展可能无法工作。有关详细信息，请参阅使用 Linux 进行远程开发文章。

高级容器配置

有关以下主题的信息，请参阅高级容器配置文章：

devcontainer.json 参考

还有一个完整的devcontainer.json 参考，您可以在其中查看文件架构，以帮助您自定义开发容器并控制如何连接到正在运行的容器。

问题或反馈

请参阅提示和技巧或常见问题。
在Stack Overflow 上搜索。
提交功能请求或报告问题。
为他人创建Dev Container 模板或Feature。
查看并提供关于Development Containers Specification 的反馈。
贡献于我们的文档或VS Code 本身。
有关详细信息，请参阅我们的贡献指南。

后续步骤

附加到正在运行的容器 - 附加到已在运行的 Docker 容器。
创建开发容器 - 为您的工作环境创建自定义容器。
高级容器 - 查找高级容器场景的解决方案。
devcontainer.json 参考 - 查看 devcontainer.json 架构。

05/08/2025