教育中的开发容器：教师指南

2020 年 7 月 27 日，作者：Brigit Murtaugh，@BrigitMurtaugh

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

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

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

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

开发容器

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

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

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

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

VS Code 中的开发容器

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

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

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

这篇文章将作为希望在课堂上实施开发容器的教师的指南，以创建更流畅、更一致的学生环境。

要亲眼目睹 dev container 的实际应用以及学生如何在短短 5 分钟内入门，请观看我们的学生入门视频。

教师指南

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

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

为了节省大量时间和避免困惑，我们可以使用 dev container 为我们的班级创建标准化的 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 的 Docker Desktop 也可以在 Windows 10 专业版、企业版或教育版（内部版本 16299 或更高版本）上使用，并且必须启用 Hyper-V 和容器 Windows 功能。

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

VS Code 启动后，请确保您已安装 Dev Containers 扩展程序

当我们安装任何 Remote 扩展程序时，绿色的 Remote 指示器会添加到状态栏的左下方

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

访问您班级的容器

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

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

您可以选择左下角的 Remote 指示器，或使用命令面板，以调出 Dev Containers 命令。

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

我们需要输入存储容器的 GitHub 存储库的 URL，在本例中为 microsoft/vscode-course-sample

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

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

容器构建并运行后，我们的文件已加载，我们可以开始在我们的 Python 环境中进行编码了！

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

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

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

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

为您班级创建容器

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

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

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

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

devcontainer.json

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

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

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

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

我们建议在教育领域的 devcontainer.json 中首先使用的变量是

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

devcontainer.json 参考中有表格列出了您可以包含在此配置文件中的所有可用属性。

Dockerfile

Docker 可以通过读取 Dockerfile 中的指令来自动构建镜像。此文件至少应使用 FROM 指定基本镜像，并且还可以包含命令行指令。

这是我们的 Python 应用程序中 Dockerfile 的外观

打开容器

添加容器配置文件后，我们会收到一条通知，指出我们的文件夹现在具有 devcontainer.json 文件。让我们选择在容器中重新打开

将启动 VS Code 的新实例，在其中构建我们的镜像，并且我们的应用程序在 dev container 中启动

容器构建完成后，我们拥有所有相同的文件，但现在左下角的指示器显示“Dev Container: Python 3”，表示我们位于容器内部。我们可以轻松运行代码，而无需考虑本地计算机上安装了哪个版本的 Python（如果有的话）！

创建和共享作业

现在您有了 dev container，您可以将其上传到存储库，以便您的学生可以访问它以完成他们的作业。您可以将作业说明包含在 README 中，以及作业所需的任何基本代码或模板代码，以及 .devcontainer 文件夹，以便他们都获得一致的开发体验。所有这些文件都可以作为单个存储库上传。

确保您已安装 Git。您可以从 VS Code 中的容器项目初始化新的 Git 存储库。或者，您可以从命令行中使用 git init 在项目目录中进行初始化。

下一步是将您的本地存储库连接到浏览器中的 新存储库，该存储库来自 GitHub

然后，我们将本地 Git 存储库（计算机上的容器项目）连接到远程存储库（我们在浏览器中创建的 GitHub 存储库）

系统可能会提示您登录 GitHub。登录后，您的文件可以添加到您的远程 Git 存储库

现在，当我刷新浏览器中的 GitHub 时，我可以查看我的文件了！

有关如何将存储库上传到 GitHub 的更多信息，请查看此将现有项目添加到 GitHub 指南。

访问作业

要了解学生如何从 GitHub 访问 dev container 并轻松开始编程，请观看我们的5 分钟快速视频。

反馈 & 更多资源

为了帮助设置带有容器的 VS Code，我们在 VS Code 远程开发文档中提供了详细的文章。如果您对我们的团队有任何疑问或反馈，请随时在 VS Code 远程开发 GitHub 存储库上打开一个 issue 或在 Twitter 上给我们发推文 @code。

祝您编码愉快！

Brigit Murtaugh，VS Code 项目经理 @BrigitMurtaugh