教育中的开发容器：面向指导的指南

Name: Visual Studio Code
Author: Microsoft

2020 年 7 月 27 日，Brigit Murtaugh，@BrigitMurtaugh

我们从许多教育工作者那里了解到，学期的最初几天或几周可能会浪费在为学生配置正确的环境上。即便如此，学生最终可能仍然会获得低质量的开发体验，或者他们的作业评分不足

“为我的学生设置环境通常需要五个课时。需要处理 Python 版本。其中有很多复杂性。可悲的是，这种复杂性需要花费大量时间和金钱来解决。” -[美国社区大学教授 CS 101]

“我更喜欢一个专门为 Python 安装设置的 VS Code 版本……” -[文理学院助理教授]

使用 Visual Studio Code 的开发容器可以作为教育中的绝佳工具，以确保学生拥有一致的编码环境。它们负责环境设置，以便学生和教师可以快速跳过配置，而专注于真正重要的事情：学习和编写出色的代码！

开发容器

那么，什么是开发容器？容器是软件包代码以及代码运行所需的所有依赖项的软件片段，包括运行时、工具、库和设置。容器最初是作为一种在一致的环境中部署和管理应用程序并更有效地利用硬件的方式而创建的。后来，它们发展为帮助提供一致的构建环境，以及最近的开发环境。这就是开发容器名称的由来。

当你创建容器时，其初始内容来自所谓的“镜像”。镜像可以被认为是一个迷你磁盘驱动器，其中预装了操作系统和其他工具。你使用 Dockerfile 描述镜像中包含的内容，一旦你运行镜像，它就会变成一个容器。

开发容器提供与你的计算机隔离的编码环境。例如，如果你下载特定版本的依赖项，则该版本将是容器独有的。在下图中，请注意容器如何包含应用程序及其必要的依赖项，从而使计算机（主机操作系统和基础架构）免受任何依赖项的影响并保持清洁

Containers diagram

作为讲师，你可以为作业创建特定的镜像。每个学生都将获得完全相同版本的依赖项，例如相同版本的 Python 或 C++ 编译器，而无需考虑他们的操作系统或计算机上已安装的任何其他文件。

VS Code 中的开发容器

Visual Studio Code Dev Containers 扩展允许你使用容器作为你的主要编码环境。在课堂上，讲师可以采用现有的开发容器，或创建自己的容器，并将其与班级分享。每个学生都可以在 VS Code 中打开容器，并自动获得开发应用程序所需的工具和运行时。学生在编码时还可以访问 VS Code 的完整功能集，包括 IntelliSense 和调试。

Dev Containers 扩展仅适用于基于 Linux 的容器，因此，尽管学生的计算机上可能安装了不同的操作系统，但编码环境在所有计算机上将保持一致。

我们已经看到讲师在课堂上成功使用 Dev Containers。你可以查看使用 DevContainers 标准化学生开发环境：经验报告，以了解更多关于三位研究人员在加州大学圣地亚哥分校的课程中使用开发容器的经验。

这篇文章将作为指导，帮助希望在课堂上实施开发容器的讲师，为他们的学生创建更顺畅、更一致的环境。

要亲眼目睹开发容器的实际应用以及学生如何在短短 5 分钟内入门，请查看我们的学生入门介绍视频。

面向指导的指南

使用传统的设置方法，学生在设置环境时可能会遇到各种各样的问题。一些示例包括他们独特的操作系统、项目文件的存储位置，或者他们已安装的运行时或工具的细微差异。讲师需要精通所有这些细微之处，才能帮助学生解决这些问题。

一个常见的问题是管理工具的不同版本。让我们以 Python 为例：有 Python 2 和 Python 3，以及不同的次要版本。拥有多个 Python 版本，以及多个随附的工具（例如 linters），可能会令人困惑并导致错误。

为了节省大量时间和避免混淆，我们可以使用开发容器为我们的班级创建一个标准化的 Python 开发环境。学生都将获得相同版本的 Python，从而避免安装新版本或卸载任何旧版本，并且每个人运行相同的容器和源代码都将获得完全相同的结果。

先决条件

安装 Visual Studio Code。
安装 Docker Desktop。
- Docker 是构建和共享容器的行业标准。我们推荐使用 Docker Desktop Stable 2.3.0.3，因为它是最新且性能最佳的 Docker Desktop 版本。
- 新推出了Windows Home 上的 Docker Desktop 支持。它需要 Windows 10 版本 2004 并启用 Windows Subsystem for Linux 2 (WSL 2) 后端。按照 WSL 2 安装指南启用 WSL 2。
- 对于不希望配置 WSL 2 后端的学生，可以选择在 Windows 10 专业版、企业版或教育版（Build 16299 或更高版本）上使用适用于 Windows 的 Docker Desktop，并且必须启用 Hyper-V 和容器 Windows 功能。

让我们从启动 VS Code 开始，我们可以通过在命令提示符或终端中键入 code 来完成（或者只是在你的计算机上选择 VS Code）

Launch VS Code from command prompt

一旦 VS Code 启动，请确保你已安装 Dev Containers 扩展

Dev Containers extension

当我们安装任何远程扩展时，绿色的“远程指示器”将添加到状态栏的左下方

Remote indicator in VS Code

你可以单击它以打开命令面板并验证是否列出了 Dev Containers 命令

List of remote commands in Command Palette

访问你的课堂的容器

让我们一起完成一个示例开发容器，以帮助学生获得一致的编码环境。在我们的课堂中，我们可以创建一个 GitHub 仓库来存储共享相同技术堆栈的练习。例如，所有 Python 作业都可以使用相同的容器并存储在同一个仓库中。

我们有一个示例 vscode-course-sample GitHub 仓库，其中包含一个 Python 开发容器和两个 Python 入门作业。让我们在 VS Code 中打开它。

你可以选择左下角的“远程指示器”，或使用命令面板，调出 Dev Containers 命令。

让我们调用在容器卷中克隆仓库...

Clone Repository in Container Volume

我们需要输入 GitHub 仓库的 URL，其中存储了我们的容器，在我们的示例中是 microsoft/vscode-course-sample

Paste GitHub URL in Command Palette

你可以创建唯一的卷。卷是文件将存储在我们容器中的位置

Volume options in Command Palette

现在我们已经选择了我们的容器仓库，VS Code 重新加载以构建镜像并启动容器

Close-up on starting container notification

一旦容器构建并运行，我们的文件将被加载，我们就可以在我们的 Python 环境中开始编码了！

单击资源管理器中的 sort.py 以打开它，然后按 F5（或右上角的绿色“运行”图标）来运行它

Run sort.py program

我们的 Python 代码成功运行，而无需在本地计算机上设置 Python。

我们还可以访问 VS Code 的所有优点，例如设置断点以暂停我们的程序并帮助我们调试。当我们对单词列表进行排序时，让我们设置一个断点。

Setting a breakpoint

我们可以使用 F5 运行我们的程序。请注意，程序在到达断点后会停止

Program stops at breakpoint

为你的课堂创建容器

现在我们已经看到了一个很棒的容器示例，让我们使用 Dev Containers 扩展自己设置我们的第一个容器。让我们从“Hello World”Python 应用程序开始

Hello world Python app

我们将选择Dev Containers：添加 Dev Container 配置文件…以开始设置开发容器所需的文件

Add Dev Container Configuration Files command

容器配置文件是创建和自定义开发容器所必需的。出现的容器定义列表会根据你的应用程序的内容进行过滤，在我们的示例中，应用程序是一个 Python 文件。让我们选择 Python 3

Select Python 3 config file in Command Palette

Dev Containers 扩展会自动添加一个 .devcontainer 文件夹和两个配置文件：devcontainer.json 和 Dockerfile。让我们仔细看看这两个文件。

devcontainer.json

devcontainer.json 描述了 VS Code 应如何启动我们的容器以及连接后应执行的操作。此文件可以位于 .devcontainer/devcontainer.json 下，也可以直接作为 devcontainer.json 存储在项目的根目录中。

这是一个简单的 devcontainer.json 示例。它拉取预配置的 Node 镜像，自动设置端口 3000 的端口转发，并在创建容器时安装 eslint 扩展

Simple Node devcontainer.json

这是一个稍微复杂的 devcontainer.json 的示例，用于我们的 Python 项目。它使用 dockerfile 属性引用 Dockerfile 而不是直接引用镜像。它还自动安装 Python 扩展，并在创建容器后建立一组特定于容器的设置，例如 linting

More detailed Python devcontainer.json

devcontainer.json 是创建自定义编码环境以满足学生特定需求的好机会。你可以指定一些变量来为每个班级或作业创建唯一的环境。

我们建议在教育的 devcontainer.json 中从以下变量开始

属性	类型	描述
`image`	字符串	容器注册表（即 DockerHub）中镜像的名称，VS Code 应使用该镜像创建开发容器。
`dockerFile`	字符串	Dockerfile 的位置，它定义了容器的内容。路径相对于 `devcontainer.json` 文件。你可以在 vscode-dev-containers 仓库中找到许多不同运行时的示例 Dockerfile。
`name`	字符串	容器的显示名称。
`extensions`	数组	扩展 ID 数组，用于指定在创建容器时应在容器内安装的扩展。默认为 `[]`。
`settings`	对象	将默认的 `settings.json` 值添加到特定于容器/计算机的设置文件中。

在此文件中设置一些变量将在长期内为你的班级节省时间。例如，你可以使用 extensions 变量来确保你的所有学生都自动获得相同的扩展集。设置路径也可能具有挑战性或导致学生计算机上的问题，但是通过 settings 变量指定路径信息，你将为你的班级节省时间，并确保他们计算机的路径变量在此过程中不受损害。

在 devcontainer.json 参考的表格中，你可以找到可以包含在此配置文件中的所有可用属性。