教程的问题

2022 年 3 月 8 日，作者：Burke Holland，@burkeholland

写一篇优秀的教程并不容易。我深有体会——我写过很多教程，但并非每个都取得了巨大成功。

事实证明，制作一篇优秀的教程不在于你写了“什么”，而在于开发者是否无需阅读每个字就能成功。在本文中，我们将探讨开发容器如何减少用户可能遇到的错误，以及 Laravel PHP 项目如何在他们自己的教程中巧妙地实现这一点，并取得了显著效果。

没人爱阅读

我们自己的关于如何在 Visual Studio Code 中使用开发容器的教程长期以来完成率都很低——大约 4-6%。

为了找出人们放弃的地方，我们进行了用户研究，并观察人们尝试完成我们的教程。那真是……痛苦。

人们无法完成教程的原因立即变得清晰：**没人阅读它**。人们跳过说明，直接进入操作步骤。不可避免地，他们会因为犯了一个错误而卡住，如果他们阅读了说明，他们就不会犯这个错误。

宾夕法尼亚州立大学教授 John M. Carroll 在他的开创性著作 《纽伦堡漏斗——为实用计算机技能设计极简主义教学》中谈到了这一点。他写道：“[学习者]太忙于学习，以至于无法充分利用教学。这就是意义建构的悖论。”

我对此深有同感，你可能也是。当我浏览教程时，我的眼睛会扫描代码块，因为我正在尝试通过实践来学习。我真的太忙于学习而无暇阅读说明。

**人们不会阅读你的教程。**或者至少不会像你希望的那样多读。你能做的最好事情是尽可能地消除读者在学习过程中可能犯错的地方。一种方法是使用预配置的容器环境，完全移除所有环境设置步骤。

容器化开发环境

任何教程的很大一部分通常都专门用于列举先决条件和环境设置。我清楚地记得，我曾尝试学习 Ruby on Rails，大部分时间都花在尝试在 Windows 上正确安装 Ruby 上——疑惑“gem”到底是什么，以及为什么它们总是莫名其妙地丢失。

容器化开发环境背后的理念是，你在 Docker 容器内部进行开发。这使得拥有一个完全可移植、完全配置的开发环境成为可能，你可以随意启动或关闭它。然后，你可以将该环境以一套配置文件形式提供给其他人。

但是你如何在容器**内部**进行开发呢？容器又没有 UI，让你能直接启动 VS Code。

VS Code 的 开发容器 扩展正是做到了这一点。它既包含了将 Docker 容器配置为开发环境的机制，也允许你从 VS Code 连接到该环境。它通过在容器内安装一个小型服务器组件来实现这一点，你的本地 VS Code 会与该组件通信。然后你就可以像在本地开发一样进行开发，只不过 VS Code 连接的是容器环境而不是你的本地环境。

为了创建容器化开发环境，你通常需要了解一些 Docker 的知识。很多人确实了解，但也有很多人**不了解**（你看不见我，但我正在举手），所以这个扩展试图尽可能地抽象容器设置过程。我设置了一个新的 Python 容器。一个向导会引导你选择基础镜像和 Python 版本。然后它会让你有机会通过一个选择列表向镜像添加额外的软件。在这种情况下，我添加了 Azure CLI、Dotnet CLI 和 PowerShell……

这个过程会在该项目下添加一个包含必要 `Dockerfile` 的 `.devcontainer` 文件夹。它还会添加一个 `devcontainer.json` 文件，这是定义开发容器各方面（例如应该安装哪些扩展、容器构建后应该运行哪些设置命令等）的标准。由于你可以完全控制环境及其设置，因此你可以自动完成几乎所有事情——包括依赖项安装、库版本等。

通过这种方式，完全有可能直接为某人提供一个完整、即用型环境，无需额外的设置步骤，也无需因 Ruby gem 而引发存在危机。

有些人已经在使用基于开发容器的方法，让他们的用户能够快速启动和运行那些原本非常复杂的环境。一个很好的例子就是 PHP 的 Laravel 框架。

Laravel 解决方案

Laravel 是一个开源的 PHP MVC 框架。它功能全面，包括对象关系映射器 (ORM)、直接数据库访问、打包系统等等。Laravel 功能强大。为了体验它，你一开始至少需要一个数据库。通常这会要求用户不仅安装 PHP，还需要安装一个数据库——通常是 MySQL。当用户只是尝试你的框架时，这是一个很大的要求。

Laravel 通过容器化开发环境和一个名为 Sail 的工具来解决这个问题。要从头开始使用 Laravel、MySQL 服务器和 Redis 缓存，你只需运行一个命令……

    curl -s "https://laravel.build/example-app?with=mysql,redis" | bash

这将创建一个带有 `docker-compose` 文件的新项目。此文件设置了三个容器——一个应用程序容器、一个 MySQL 容器和一个 Redis 容器。你无需了解容器或这三个服务中的任何一个。Sail 为你抽象了所有这些。然后你执行 Sail 命令来启动环境……

    ./vendor/bin/sail up

示例应用程序直接运行。无需安装 PHP。无需安装 Laravel。无需解决依赖项。直接成功。

我指定了我们的项目有一个 MySQL 服务器和一个 Redis 缓存，所以当项目启动时，我们实际上会得到三个容器。我们可以使用 VS Code 的 Docker 扩展 来查看。

这些容器通过网络连接在一起，这样我们就可以从应用程序容器中调用 MySQL 或 Redis 缓存容器。

如果你将交互式终端连接到 `sail-8.1/app container`，你会在 `/var/www/html` 文件夹中看到你的项目。Docker 将你的机器上的项目“挂载”到容器中，因此你在开发过程中所做的任何更改都会在刷新时反映到应用程序中。

添加开发容器

还增加了对 开发容器 扩展的支持。要将正确的开发容器配置添加到此项目，你可以构建相同的项目并添加 `&devcontainer` 标志。

    curl -s "https://laravel.build/example-app?with=mysql,redis&devcontainer" | bash

请注意，如果你想向现有的 Sail/Laravel 项目添加一个开发容器，可以通过运行 `php artisan sail:install --devcontainer` 来实现。

这将创建相同的项目配置，但会包含一个 `.devcontainer` 文件夹。VS Code 会自动检测该文件夹，并提示你在容器中重新打开项目，从而跳过必需的 `sail up` 步骤。

VS Code 会连接到容器，因此你正在容器环境**内部**进行开发，而不是在本地环境。你会知道这一点，因为 VS Code 左下角的远程指示器会告诉你……

在容器中开发而不是在容器外部开发有一些明显的优势。

开发环境与应用环境镜像一致

连接到容器后，你正在开发的上下文与应用程序运行的上下文是相同的。所以你的终端就变成了容器的终端……

开发容器扩展还提供了更完整的视图，例如哪些端口被转发了——以防你忘记应用程序在哪里运行。

Laravel 应用程序会自动启动，应用程序日志会导入到容器日志中。由于你可能想查看应用程序中发生了什么，开发容器扩展在 VS Code 中提供了一个新的视图，你可以在其中查看所有正在运行的容器，并连接到流式容器日志。

自动化开发环境设置

最佳的开发者体验将包括编辑器的自定义设置。这包括编辑器本身的设置，以及需要添加到开箱即用体验中的任何扩展或其他支持。

对于 VS Code 和 Laravel，`devcontainer.json` 中建议了扩展，但被注释掉，因此不会自动安装。这允许用户从一组已识别的扩展中进行选择，而不必去寻找正确配置编辑器的方法。

    ...
    "extensions": [
        // "mikestead.dotenv",
        // "amiralizadeh9480.laravel-extra-intellisense",
        // "ryannaddy.laravel-artisan",
        // "onecentlin.laravel5-snippets",
        // "onecentlin.laravel-blade"
    ],

少读多做

人们不爱阅读。这应该没问题。Laravel 的教程不一定比其他教程短，但重要的是，如果你直接跳到代码并运行命令，它就能奏效。开发容器使这成为可能。现在，如果我们能想出如何为我们自己的在 Visual Studio Code 中使用 Docker 容器作为开发环境教程创建一个开发容器就好了……

编码愉快！

Burke Holland (@burkeholland)