教育中的开发容器：讲师指南
2020年7月27日，作者：Brigit Murtaugh，@BrigitMurtaugh
我们从许多教育工作者那里听说，学期的前几天或几周可能会因为配置学生所需的正确环境而浪费掉。即便如此，学生最终可能仍然会遇到低质量的开发体验，或者他们的作业评分不足。
“为我的学生进行设置通常需要五个课时。要处理不同版本的 Python。有很多复杂性。遗憾的是，解决这些复杂性需要大量时间和金钱。” -[美国社区大学 CS 101 教授]
“我更喜欢一个专门为 Python 安装而设置的 VS Code 版本……” -[文理学院助理教授]
带有 Visual Studio Code 的开发容器可以作为教育中出色的工具，确保学生拥有一个一致的编码环境。它们负责设置，以便学生和讲师可以快速跳过配置阶段，转而专注于真正重要的内容：学习和编写出色的代码！
开发容器
那么，什么是开发容器？容器是打包代码及其运行所需所有依赖项的软件片段，包括运行时、工具、库和设置。容器最初是为了在一致的环境中部署和管理应用程序，并更有效地利用硬件而创建的。后来，它们发展到帮助提供一致的构建环境，而最近，则用于开发环境。这就是“开发容器”这个名称的由来。
当你创建一个容器时，其初始内容来自所谓的“镜像”。可以将镜像视为一个预装了操作系统和其他工具的微型磁盘驱动器。你使用 Dockerfile 描述镜像中包含的内容，一旦运行该镜像，它就变成了容器。
开发容器提供了一个与你计算机分离的编码环境。例如，如果你下载某个特定版本的依赖项，该版本将是容器独有的。在下图所示中，请注意容器如何包含应用程序及其必要的依赖项，从而使计算机（主机操作系统和基础设施）不受任何依赖项的影响，保持干净。
作为讲师，你可以为一项作业创建一个特定的镜像。每个学生都将获得完全相同版本的依赖项，例如相同版本的 Python 或 C++ 编译器，无论他们的操作系统或计算机上已安装的任何其他文件如何。
VS Code 中的开发容器
Visual Studio Code 开发容器扩展允许你使用容器作为主要的编码环境。在课堂上，讲师可以获取一个现有的开发容器，或者创建自己的容器，并与班级共享。每个学生都可以在 VS Code 中打开容器，并自动拥有开发应用程序所需的工具和运行时。学生在编码时还可以使用 VS Code 的所有功能，包括智能感知和调试。
开发容器扩展仅适用于基于 Linux 的容器，因此尽管学生的计算机上可能安装了不同的操作系统，编码环境在所有计算机上都将保持一致。
我们已经看到讲师们成功地在课堂上使用了开发容器。你可以查看使用开发容器标准化学生开发环境：经验报告，以了解在加州大学圣地亚哥分校的课程中使用开发容器的三位研究人员的经验。
本文将作为一份指南，帮助希望在课堂上实施开发容器的讲师为学生创建一个更流畅、更一致的环境。
要亲眼见证开发容器的实际操作以及学生如何在短短 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 家庭版现已引入 Docker Desktop 支持。它需要 Windows 10 版本 2004 并启用适用于 Linux 的 Windows 子系统 2 (WSL 2) 后端。请遵循 WSL 2 安装指南启用 WSL 2。
- 对于不想配置 WSL 2 后端的学生，可以在 Windows 10 专业版、企业版或教育版（Build 16299 或更高版本）上使用 适用于 Windows 的 Docker Desktop，并且必须启用 Hyper-V 和容器 Windows 功能。
我们首先启动 VS Code，可以通过在命令提示符或终端中键入 code（或者直接在计算机上选择 VS Code）来完成。
VS Code 启动后，请确保您已安装 开发容器扩展。
当我们安装任何远程扩展时，绿色远程指示器会添加到状态栏的左下角。
您可以单击它以打开命令面板并验证开发容器命令是否已列出。
访问课程容器
让我们通过一个示例开发容器来帮助学生获得一致的编码环境。在我们的课堂上，我们可以创建一个 GitHub 仓库来存储共享相同技术栈的练习。例如，所有的 Python 作业都可以使用相同的容器并存储在同一个仓库中。
我们有一个示例 vscode-course-sample GitHub 仓库，其中包含一个 Python 开发容器和两个 Python 入门作业。让我们在 VS Code 中打开它。
您可以选择左下角的远程指示器，或者使用命令面板，来调出开发容器命令。
我们来调用在容器卷中克隆仓库...
我们需要输入存储我们容器的 GitHub 仓库的 URL，在我们的例子中是 microsoft/vscode-course-sample。
你可以创建唯一的卷。卷是我们文件中容器存储的位置。
现在我们选择了容器仓库，VS Code 重新加载以构建镜像并启动容器。
一旦容器构建并运行，我们的文件就会加载，我们就可以在 Python 环境中开始编码了！
单击“资源管理器”中的 sort.py 以打开它，然后按 F5（或右上角的绿色运行图标）来运行它。
我们的 Python 代码成功运行，而无需在本地计算机上设置 Python。
我们还可以利用 VS Code 的所有优点，例如设置断点以暂停程序并帮助我们调试。让我们在对单词列表进行排序时设置一个断点。
我们可以用 F5 运行程序。注意程序在碰到断点时会停止。
为您的课程创建容器
现在我们已经看到了一个出色的容器示例，接下来让我们自己使用开发容器扩展来设置第一个容器。我们从一个“Hello World”Python 应用程序开始。
我们将选择 开发容器: 添加开发容器配置文件… 来开始设置开发容器所需的文件。
容器配置文件是创建和自定义开发容器所必需的。容器定义列表根据您的应用程序内容进行过滤，在我们的例子中是一个 Python 文件。让我们选择 Python 3。
开发容器扩展会自动添加一个 .devcontainer 文件夹和其中的两个配置文件：devcontainer.json 和一个 Dockerfile。让我们仔细看看这两个文件。
devcontainer.json
devcontainer.json 描述了 VS Code 应该如何启动我们的容器以及连接后要执行什么操作。此文件可以位于 .devcontainer/devcontainer.json 下，也可以直接存储在项目根目录中作为 devcontainer.json。
这是一个简单的 devcontainer.json 示例。它拉取一个预配置的 Node 镜像，自动设置端口 3000 的端口转发，并在创建容器时安装 eslint 扩展。
以下是我们的 Python 项目中稍微复杂一些的 devcontainer.json 示例。它使用 dockerfile 属性引用 Dockerfile 而不是直接引用镜像。它还会自动安装 Python 扩展，并在创建容器后建立一组特定于容器的设置，例如代码检查（linting）。
devcontainer.json 是一个绝佳的机会，可以创建定制的编码环境以满足学生的特定需求。您可以指定一些变量，为每个课程或作业创建独特的环境。
我们建议在教育用的 devcontainer.json 中从以下属性开始：
| 属性 | 类型 | 描述 |
|---|---|---|
image |
字符串 | VS Code 用于创建开发容器的容器注册表（即 DockerHub）中镜像的名称。 |
dockerFile |
字符串 | 定义容器内容的 Dockerfile 的位置。路径是相对于 devcontainer.json 文件的。您可以在 vscode-dev-containers 仓库中找到许多不同运行时的 Dockerfile 示例。 |
name |
字符串 | 容器的显示名称。 |
extensions |
数组 | 指定在创建容器时应安装在容器内的扩展 ID 数组。默认为 []。 |
settings |
对象 | 将默认的 settings.json 值添加到特定于容器/机器的设置文件中。 |
在此文件中设置一些变量将从长远来看节省您的课程时间。例如，您可以使用 extensions 变量来确保所有学生都自动安装相同的扩展集。设置路径也可能具有挑战性或导致学生计算机上的问题，但通过 settings 变量指定路径信息，您将节省课程时间并确保学生的计算机路径变量在此过程中不受损害。
devcontainer.json 参考中有关于此配置文件中可包含的所有可用属性的表格。
Dockerfile
Docker 可以通过读取 Dockerfile 中的指令来自动构建镜像。此文件至少会使用 FROM 指定一个基础镜像，并且还可以包含命令行指令。
这是我们 Python 应用程序中 Dockerfile 的样子。
打开容器
添加容器配置文件后，我们收到通知，我们的文件夹现在包含一个 devcontainer.json 文件。让我们选择在容器中重新打开。
VS Code 的新实例启动，其中正在构建我们的镜像，并且我们的应用程序正在开发容器中启动。
一旦我们的容器构建完成，我们拥有所有相同的文件，但现在左下角的指示器显示“开发容器：Python 3”，表示我们处于容器内部。我们可以轻松运行代码，无论我们的本地机器上安装了哪个版本的 Python（如果有的话）！
创建和分享作业
现在您拥有了一个开发容器，您可以将其上传到仓库，以便您的学生可以访问它来完成作业。您可以在 README 中包含作业说明，以及作业所需的任何基础或模板代码，以及一个 .devcontainer 文件夹，以便他们都能获得一致的开发体验。所有这些文件都可以作为一个单一的仓库上传。
确保您已安装 Git。您可以从 VS Code 中的容器项目初始化新的 Git 仓库。或者，您可以在命令行的项目目录中使用 git init。
下一步是将您的本地仓库连接到浏览器中 GitHub 的新仓库。
然后，我们将把本地 Git 仓库（我们计算机上的容器项目）连接到远程仓库（我们在浏览器中创建的 GitHub 仓库）。
系统可能会提示您登录 GitHub。登录后，您的文件可以添加到您的远程 Git 仓库中。
现在当我刷新浏览器中的 GitHub 时，我可以看到我的文件了！
有关如何将仓库上传到 GitHub 的更多信息，请查看此将现有项目添加到 GitHub 的指南。
访问作业
要了解学生如何从 GitHub 访问开发容器并轻松开始编程，请观看我们时长 5 分钟的快速视频。
反馈与更多资源
为了帮助您使用容器设置 VS Code，我们在 VS Code 远程开发文档中提供了详细的文章。如果您对我们的团队有任何疑问或反馈，请随时在 VS Code 远程开发 GitHub 仓库中提出问题或在 Twitter 上@我们 @code。
编码愉快！
Brigit Murtaugh，VS Code 项目经理 @BrigitMurtaugh