教育领域的开发容器:讲师指南
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 的全部功能,包括 IntelliSense 和调试。
开发容器扩展仅适用于基于 Linux 的容器,因此尽管学生的计算机可能具有不同的操作系统,但编码环境在所有计算机上都将保持一致。
我们已经看到讲师在课堂上成功使用开发容器。您可以查看使用 DevContainers 标准化学生开发环境:经验报告,以了解在加州大学圣地亚哥分校的一门课程中使用开发容器的三位研究人员的经验。
这篇文章将作为指导,指导希望在课堂上实施开发容器的讲师,为学生创建更流畅、更一致的环境。
要了解开发容器的实际应用以及学生如何在短短 5 分钟内入门,请查看我们的入门学生视频。
讲师指南
使用传统的设置方法,学生在设置环境时可能会遇到各种各样的问题。一些示例包括他们独特的操作系统、项目文件存储位置或他们安装的运行时或工具的细微差异。讲师需要精通所有这些细微之处,才能帮助学生解决这些问题。
一个常见的问题是管理工具的不同版本。以 Python 为例:有 Python 2 和 Python 3,以及不同的次要版本。拥有多个版本的 Python,然后拥有多个配套工具(如 lint 工具),可能会令人困惑并导致错误。
为了节省大量时间和避免混淆,我们可以使用开发容器在我们的班级中创建一个标准化的 Python 开发环境。学生将获得相同版本的 Python,避免了安装新版本或卸载任何旧版本的需要,并且每个运行相同容器和源代码的人都会获得完全相同的结果。
先决条件
- 安装Visual Studio Code。
- 安装 Docker Desktop。
- Docker 是构建和共享容器的行业标准。我们建议使用 Docker Desktop Stable 2.3.0.3,因为它是 Docker Desktop 的最新且性能最高的版本。
- 新推出了对 Windows 家庭版的 Docker Desktop 支持。它需要 Windows 10,版本 2004,并启用 Windows Subsystem for Linux 2 (WSL 2) 后端。按照WSL 2 安装指南启用 WSL 2。
- 对于那些不希望配置 WSL 2 后端的学生,适用于 Windows 的 Docker Desktop也可以在 Windows 10 Pro、Enterprise 或 Education(内部版本 16299 或更高版本)上使用,并且必须启用 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 |
字符串 | 容器注册表(例如 DockerHub)中镜像的名称,VS Code 应使用该镜像创建开发容器。 |
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 存储库上打开一个 issue,或者在 Twitter 上给我们发推 @code。
编码愉快!
Brigit Murtaugh,VS Code 项目经理 @BrigitMurtaugh