教育场景开发容器实战:用 VS Code Dev Containers 为课堂构建一致的编码环境

原创2026-10-09 15:03:121,674 阅读
文章标签:文档教程

教育场景开发容器实战:用 VS Code Dev Containers 为课堂构建一致的编码环境

新学期伊始,很多编程课程的第一周往往消耗在为学生配置五花八门的开发环境上——不同的 Python 版本、不同的编译器、不同的系统路径,最终学生可能仍得不到一致的开发体验。Visual Studio Code 的 Dev Containers 扩展(扩展 ID:ms-vscode-remote.remote-containers)提供了一条更优的路径:教师为班级或作业准备一个统一的开发容器,学生打开容器即可获得完全相同版本的运行时、工具与依赖。本文面向希望在教学场景落地开发容器的教师,基于官方博客文章《Development Containers in Education: A Guide for Instructors》并结合本仓库的 Dev Containers 官方文档,完整讲解容器概念、环境准备、访问现成容器、从零创建班级容器、分享与获取作业的端到端流程,帮助你在课堂上用几分钟(而非几节课)完成环境搭建。

为什么课堂需要开发容器:动机与场景

传统教学环境中,学生的环境配置问题层出不穷:操作系统各不相同(Windows / macOS / Linux)、项目文件存放位置各异、安装的运行时或工具版本存在细微差异,教师不得不熟悉所有这些差异才能逐个排查。最常见的痛点之一是工具多版本并存——以 Python 为例,存在 Python 2 与 Python 3 的差异,以及众多小版本差异,再叠加 linter 等配套工具,版本混乱极易引发错误。

官方博客引用了一线教师的真实反馈:

"为我的学生配置环境通常要花掉五个课时。要处理各种 Python 版本,复杂度很高。遗憾的是,这种复杂度耗费了大量时间和金钱。"——美国某社区学院 CS 101 教授

"我更希望有一个专门为 Python 安装而配置的 VS Code 版本。"——某文理学院助理教授

开发容器正是针对这一痛点的解法:它能保证学生拥有一致的编码环境,把配置工作前置、集中化,让教师和学生迅速跳过环境配置,把精力放在真正重要的事情上——学习和编写代码。

什么是开发容器:镜像、Dockerfile 与容器

容器是一种软件打包方式,它将代码以及代码运行所需的所有依赖打包在一起,包括运行时、工具、库和设置。容器最初用于在一致环境中部署和管理应用、更高效地利用硬件,后来逐渐演变为提供一致的构建环境,再进一步演变为开发环境——"dev container(开发容器)"之名由此而来。

理解开发容器需要先理清三个概念:

  • 镜像(Image):创建容器时的初始内容来源。可以把它想象成一个"迷你磁盘",预装了操作系统和其他工具。描述镜像内容的是 Dockerfile。
  • 容器(Container):镜像被运行后就成为容器。
  • 开发容器:提供与宿主机隔离的编码环境。例如你在容器中下载某个特定版本的依赖,该版本只存在于容器内,不会污染你的电脑。

如下图所示,容器内包含了应用及其所需依赖,宿主机(Host OS 与 Infrastructure)保持干净、不被依赖污染:

开发容器架构:应用与依赖封装在容器内,与宿主机隔离

对教师而言,这意味着你可以为某个作业创建专属镜像,无论学生使用什么操作系统、电脑上已安装过什么文件,每个学生拿到的依赖版本(如特定版本的 Python 或某个 C++ 编译器)都完全一致。相同容器配合相同源码,运行结果也完全一致,这为作业评测的一致性提供了坚实基础。

Dev Containers 扩展:容器成为 VS Code 编码环境

Dev Containers 扩展(扩展 ID:ms-vscode-remote.remote-containers)让你把容器当作主力编码环境。课堂场景下,教师可以复用现成的容器定义、或自行创建,再分享给整个班级;学生只需在 VS Code 中打开容器,即可自动获得开发所需的工具与运行时,同时完整享有 VS Code 的全部功能,包括 IntelliSense 和调试。

需要特别说明的两点:

  • Dev Containers 扩展仅支持基于 Linux 的容器,因此学生本机操作系统可以不同,编码环境却始终一致。本仓库的 Dev Containers 官方文档进一步给出了受支持容器系统的范围:x86_64 / ARMv7l / ARMv8l 架构的 Debian 9+、Ubuntu 16.04+、CentOS / RHEL 7+,以及 x86_64 的 Alpine Linux 3.9+。
  • 该场景已有真实教学实践:UC San Diego 的三位研究者发表了《Using DevContainers to Standardize Student Development Environments: An Experience Report》,记录了在课程中使用开发容器的经验。

官方还提供了约 5 分钟的入门学生视频,演示学生如何快速进入容器开始编程。

环境准备:前置条件

在教师动手创建容器之前,先完成以下安装:

  1. 安装 Visual Studio Code。
  2. 安装 Docker Desktop。Docker 是构建与分享容器的行业标准工具。原博客发布时推荐 Docker Desktop Stable 2.3.0.3;本仓库的 Dev Containers 文档给出的系统要求为:Windows 上需 Docker Desktop 2.0+(Windows 10 Pro/Enterprise),macOS 上需 Docker Desktop 2.0+,Linux 上需 Docker CE/EE 18.06+ 与 Docker Compose 1.21+。
  3. Windows Home 用户的特殊配置:Docker Desktop 新增了对 Windows Home 的支持,要求 Windows 10 版本 2004 及以上,并启用 Windows Subsystem for Linux 2(WSL 2)后端;需按照 WSL 2 安装指南启用 WSL 2。若学生不想配置 WSL 2 后端,Windows 10 Pro / Enterprise / Education(Build 16299 或更高)也可以使用基于 Hyper-V 的 Docker Desktop,但必须启用 Hyper-V 和 Containers 两个 Windows 功能。

环境就绪后,在命令提示符或终端中输入 code 启动 VS Code(或直接点击桌面上的 VS Code 图标),然后安装 Dev Containers 扩展。安装任一 Remote 系列扩展后,VS Code 状态栏左下角会出现绿色的 Remote 指示器;点击它即可打开命令面板,确认其中列出了 Dev Containers 相关的命令。

小提示:如果你偏好更省事的路径,本仓库的 Dev Containers 教程提供了从零起步的完整演练,无需任何 Docker 前置知识;安装完成后也可用 docker --version 在终端验证 Docker 是否正常运行。

教师实战一:直接使用现成的班级容器

最快上手的方式是直接复用官方准备的示例仓库 microsoft/vscode-course-sample,它包含一个 Python 开发容器和两个 Python 入门作业。操作步骤如下:

  1. 点击状态栏左下角的 Remote 指示器(或通过命令面板),调出 Dev Containers 命令。
  2. 选择 Dev Containers: Clone Repository in Container Volume... 命令。
  3. 在输入框中粘贴存放容器的 GitHub 仓库地址,即 microsoft/vscode-course-sample。
  4. 选择 Create a unique volume(创建独立卷)。卷(volume)是容器中存放文件的位置,独立卷还能带来 Windows / macOS 上更好的磁盘性能,并且不会污染本地文件树。
  5. VS Code 重新加载窗口,开始构建镜像并启动容器,期间会有进度通知。
  6. 容器构建并运行后,文件被加载进来,你就可以在 Python 环境中开始编码了。

在资源管理器中点击 sort.py 打开它,按 F5(或点击右上角的绿色 Run 图标)运行:

运行 sort.py 程序

程序在从未于本地安装 Python 的情况下成功运行。你还能使用 VS Code 的全部调试能力,例如在排序列表处设置断点,再按 F5 运行,程序便会在断点处暂停,方便逐步检查:

在断点处暂停调试

教师实战二:从零创建班级容器

理解了现成容器的用法后,我们来亲手创建第一个容器。以"Hello World"Python 应用为例:

  1. 在命令面板中执行 Dev Containers: Add Dev Container Configuration Files...,开始创建开发容器所需的配置文件。
  2. 命令面板会基于应用内容(此处为 Python 文件)过滤出一个容器定义列表,从中选择 Python 3。
  3. 扩展会自动在项目中添加 .devcontainer 文件夹,内含两个配置文件:devcontainer.json 和一个 Dockerfile。

从源码角度看,仓库 create-dev-container.md 将 devcontainer.json 描述为"与调试配置的 launch.json 类似、但用于启动(或附加)开发容器"的配置入口;它既可以放在 .devcontainer/devcontainer.json,也可以以 .devcontainer.json(注意点前缀)形式存放在项目根目录。

devcontainer.json:描述容器如何启动

devcontainer.json 描述 VS Code 应如何启动容器、连接后做什么。最简单的示例直接拉取一个预配置的 Node 镜像、自动设置 3000 端口的端口转发,并在容器创建时安装 eslint 扩展。本仓库的 containers.md 给出了与之对应的可复制 JSON 示例:

{
    "image": "mcr.microsoft.com/devcontainers/typescript-node",
    "forwardPorts": [ 3000 ],
    "customizations": {
        // 针对 VS Code 的专属配置
        "vscode": {
            // 容器创建时要安装的扩展 ID
            "extensions": [
                "streetsidesoftware.code-spell-checker"
            ]
        }
    }
}

而 Python 项目的示例则使用 dockerfile 属性引用 Dockerfile(而非直接引用镜像),自动安装 Python 扩展,并在容器创建后写入一组容器专属设置(如 linting):

Python 项目的 devcontainer.json 示例

devcontainer.json 是打造"量身定制编码环境"的关键入口。原博客为教学场景推荐了以下核心变量:

属性 类型 说明
image string 容器注册表(如 Docker Hub)中镜像的名称,VS Code 用它创建开发容器。
dockerFile string 定义容器内容的 [Dockerfile] 位置,路径相对于 devcontainer.json;可在 vscode-dev-containers 仓库中找到多种运行时对应的示例 Dockerfile。
name string 容器的显示名称。
extensions array 容器创建时需安装的扩展 ID 数组,默认为 []。
settings object 向容器/机器专属设置文件中写入默认的 settings.json 值。

仅配置这几个变量,长期就能为班级省下大量时间。例如用 extensions 变量确保所有学生自动安装同一组扩展;路径设置在学生电脑上最容易出问题,通过 settings 变量统一指定路径信息,既能省时又能避免破坏学生电脑的环境变量。

结合本仓库 create-dev-container.md 的说明,有两个现代写法的演进值得教师关注:

  • extensions 与 settings 的现代写法:当前官方规范推荐将扩展与设置放在 customizations.vscode 对象下(见上文 JSON 示例),旧式顶层 extensions、settings 写法仍被兼容。若想在所有容器中都固定安装某些扩展,可在用户设置中配置 dev.containers.defaultExtensions。
  • dockerFile 的现代写法:当前推荐使用 "build": { "dockerfile": "Dockerfile" } 结构,通过 build 对象引用同目录下的 Dockerfile。

此外,你还可以通过 forwardPorts 让容器在连接时总是转发指定端口(如 "forwardPorts": <a href="https://link.gitcode.com/i/72538c6c4ed370197d3f2df9384ae5b4" target="_blank">3000, 3001]);容器内运行 Web 服务时,端口转发让浏览器通过 localhost 即可访问容器内的服务。完整属性清单可查阅本仓库的 [devcontainer.json 参考页(其详细规范已迁移至 Dev Containers 规范站点)。

Dockerfile:定义容器内容

Docker 会按 Dockerfile 中的指令自动构建镜像。一个 Dockerfile 至少用 FROM 指定基础镜像,也可包含命令行指令。示例应用的 Dockerfile 如下:

Python 应用中的 Dockerfile

关于 Dockerfile 的编写,create-dev-container.md 给出了一个可复制的模式:用 FROM 指定基础镜像,用 RUN 安装软件,多个命令可用 && 串联:

FROM mcr.microsoft.com/devcontainers/javascript-node:0-18
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
    && apt-get -y install git

将 DEBIAN_FRONTEND 导出为 noninteractive 可以避免后续操作中的警告。相比在 postCreateCommand 中手动安装软件,把软件安装写进 Dockerfile 能利用 Docker 构建缓存、重建更快;不过 Dockerfile 在容器创建且工作区挂载之前执行,因此适合安装与工作区文件无关的软件包和工具,而 postCreateCommand(如 "postCreateCommand": "bash scripts/install-dependencies.sh")则在容器创建后执行,适合运行 npm install 或挂载源码树中的脚本。

打开容器

配置文件添加完成后,VS Code 会弹出通知提示文件夹中已有 devcontainer.json,选择 Reopen in Container:

Reopen in Container 通知

一个新的 VS Code 窗口会启动,镜像开始构建、应用在开发容器中启动。构建完成后,文件与之前完全一致,但左下角的 Remote 指示器显示为 "Dev Container: Python 3",表明你已身处容器内部——无论本地机器安装了哪个版本的 Python(甚至完全没装),代码都能顺利运行:

在开发容器中运行 Python 代码

关于配置的迭代,本仓库 containers.md 提醒:修改 devcontainer.json、Dockerfile 等配置后,需执行 Dev Containers: Rebuild Container 重建容器使改动生效;容器构建失败时,可使用 Reopen in Recovery Container 进入"恢复容器"编辑 Dockerfile 后重试。由于重建会"重置"容器到初始内容(本地源码除外),教学场景建议把必须的软件安装固化在 Dockerfile 或 Features 中,避免重建后丢失。

进阶:Dev Container Features 与预构建镜像

教学场景中还有两个官方推荐的进阶手段,能进一步提升一致性:

  • Dev Container Features:自包含、可共享的安装代码与配置单元。通过 Dev Containers: Configure Container Features 命令即可为容器加入 Git、Azure CLI 等工具,并在 devcontainer.json 中生成类似 "features": { "ghcr.io/devcontainers/features/github-cli:1": { "version": "latest" } } 的配置。详见 containers.md 的 Features 章节。
  • 预构建镜像:containers.md 建议用 CI(如 GitHub Actions)预先构建好镜像再推送到容器注册表,这样学生打开项目时容器启动更快、配置更简单,还能把工具固定到特定版本以改善供应链安全。预构建镜像可携带 Dev Container 元数据,被引用时设置会自动生效,甚至可以让课堂仓库中的 devcontainer.json 精简到只剩一行 "image": "..."。

创建并分享作业

容器就绪后,就可以把它连同作业一起上传到仓库,供学生访问。每个作业仓库建议包含:作业说明(写在 README 中)、作业所需的基础/模板代码,以及 .devcontainer 文件夹,这样所有学生都能获得一致的开发体验,全部文件可作为一个仓库整体上传。

具体步骤:

  1. 确保本机安装了 Git。
  2. 在容器项目所在的 VS Code 中初始化一个新的 Git 仓库(也可在项目目录的命令行执行 git init),详见本仓库的源代码管理文档。
  3. 在浏览器中登录 GitHub 并创建一个新的远程仓库。
  4. 将本地 Git 仓库(电脑上的容器项目)连接到远程仓库(浏览器中新建的 GitHub 仓库),期间可能需要登录 GitHub。
  5. 把文件推送到远程 Git 仓库。推送完成后刷新浏览器即可在 GitHub 上看到所有文件。

更详细的"将现有项目添加到 GitHub"流程可参考 GitHub 官方指南。

学生端:访问作业

学生访问开发容器的流程与教师"实战一"完全一致:安装 VS Code 与 Dev Containers 扩展、确保 Docker 运行后,执行 Dev Containers: Clone Repository in Container Volume...,粘贴教师提供的仓库地址,选择创建独立卷,等待容器构建完成即可开始编程——整个过程在 5 分钟内即可完成。学生获得的不仅是相同的工具链,还有 VS Code 完整的 IntelliSense 与调试体验。若需要在教学中为学生提供更多入门资源,本仓库的教师与学生入门页还介绍了 Coding Pack、CodeTour 等配套工具。

反馈与更多资源

Happy Coding!

登录后查看全文
vscode-docs