Dev Containers 通过 Docker 容器统一开发环境,解决依赖与配置不一致问题;需安装 VS Code、Remote - Containers 扩展及 Docker Desktop;支持基于镜像快速启动、自定义 Dockerfile、端口转发、调试集成及 Git 共享配置。
如果您在本地开发环境中遇到依赖版本不一致、环境配置复杂或“在我机器上能运行”的问题,则可能是由于开发环境与生产环境存在差异。dev containers 通过将开发环境定义为代码,利用 docker 容器隔离并复现完整开发栈,从而确保团队成员使用完全一致的工具链、运行时和依赖项。
本文运行环境:MacBook Pro,macOS Sequoia。
一、安装必要组件
要启用 Dev Containers 功能,需在本地安装 VS Code 及其官方扩展,并配置 Docker 运行时环境。VS Code 通过 Remote - Containers 扩展与 Docker CLI 通信,从而拉取镜像、启动容器并挂载工作区。
1、访问 code.visualstudio.com 下载并安装最新版 VS Code。
2、打开 VS Code,进入扩展市场,搜索并安装 Remote - Containers 扩展。
3、前往 docker.com 下载并安装 Docker Desktop,确保其后台服务正在运行。
二、基于现有镜像快速启动容器
无需编写 Dockerfile,可直接使用 Docker Hub 上已构建好的官方镜像(如 mcr.microsoft.com/vscode/devcontainers/python)作为基础开发环境。VS Code 将自动创建 devcontainer.json 配置文件并启动对应容器。
1、在本地新建一个空项目文件夹,例如 my-python-app。
2、在该文件夹中打开 VS Code,按下 Cmd+Shift+P(Mac)调出命令面板。
3、输入并选择 Dev Containers: Add Development Container Configuration Files...。
4、在模板列表中选择 Python 3,然后按提示完成配置。
5、配置完成后,点击右下角弹出的 Reopen in Container 按钮,等待容器构建并连接。
三、自定义 Dockerfile 构建专属环境
当标准镜像无法满足需求(如需特定 C 库、私有包源或非标准端口暴露),可通过编写自定义 Dockerfile 控制底层镜像构建过程。devcontainer.json 中的 image 属性将替换为 build.context 和 build.dockerfile 路径引用。
1、在项目根目录下新建 .devcontainer/Dockerfile 文件。
2、在该文件中写入基础指令,例如:FROM mcr.microsoft.com/vscode/devcontainers/python:3.11。
3、添加自定义指令,例如:RUN pip install --extra-index-url https://my-private-repo/simple/ my-package。
4、修改 .devcontainer/devcontainer.json,设置 "build": { "dockerfile": "Dockerfile" }。
5、重新执行 Dev Containers: Rebuild Container 命令以应用变更。
四、配置容器内端口与调试支持
开发过程中常需访问容器内运行的服务(如 Web 应用、数据库),或在容器中调试 Python/Node.js 程序。Dev Containers 支持端口转发与内置调试器集成,使本地浏览器和 VS Code 调试器无缝对接容器内部进程。
1、在 devcontainer.json 的 "forwardPorts" 字段中添加端口号,例如:[3000, 5432]。
2、保存后,VS Code 自动在 Ports 视图中显示已转发端口,并支持点击链接在浏览器中打开。
3、为启用调试,在 .devcontainer/devcontainer.json 中添加 "customizations": { "vscode": { "settings": { "python.defaultInterpreterPath": "/usr/local/bin/python" } } }。
4、在容器内打开 Python 文件,点击左侧行号旁的红色圆点设置断点,再按 F5 启动调试会话。
五、共享配置与版本控制
将 .devcontainer 目录纳入 Git 仓库,可使所有协作者一键复现相同开发环境。配置文件包含容器构建逻辑、扩展推荐、环境变量及初始化脚本,构成可执行的环境说明书。
1、确认 .devcontainer/devcontainer.json 和任何关联的 Dockerfile 或 postCreateCommand 脚本均位于项目根目录下的 .devcontainer 子目录中。
2、执行 git add .devcontainer 将配置文件加入暂存区。
3、在 devcontainer.json 中添加 "postCreateCommand": "pip install -r requirements.txt",确保每次重建容器时自动安装依赖。
4、提交并推送至远程仓库,其他开发者克隆后只需打开文件夹并选择 Reopen in Container 即可加载完整环境。










