教程的问题

2022 年 3 月 8 日，由 Burke Holland 发布，@burkeholland

写一篇优秀的教程并非易事。我很清楚这一点——我写过很多教程，但并非每一篇都取得了巨大成功。

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

没人读

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

为了弄清楚人们在哪里放弃，我们进行了用户研究，观察人们尝试完成我们教程的过程。那真是……痛苦。

为什么人们无法完成教程立刻就清楚了：根本没人读。人们直接跳过说明，直接进入操作步骤。不可避免地，他们会因为犯了错误而卡住，而如果他们读了说明，这些错误本可以避免。

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

我对此深有体会，你可能也是。当我学习教程时，我的眼睛在寻找代码块，因为我正尝试通过实践来学习。我确实忙于学习，而顾不上阅读说明。

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

容器化开发环境

任何教程的很大一部分通常都致力于列出冗长的先决条件和环境设置。我清楚地记得，我曾尝试学习 Ruby on Rails，却将大部分时间花在尝试在 Windows 上正确安装 Ruby 上——疑惑“gem”到底是什么，以及为什么它们似乎都缺失了。

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

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

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

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

这个过程会在项目中添加一个 `.devcontainer` 文件夹，其中包含必要的 `Dockerfile`。它还会添加一个 `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 容器`，你会在 `/var/www/html` 文件夹中看到你的项目。Docker 将你的机器上的项目“挂载”到容器中，因此你在开发时所做的任何更改都会在你刷新应用程序时反映出来。

添加开发容器

对 开发容器 (Dev Containers) 扩展的支持也已添加。要将正确的开发容器配置添加到此项目，你可以搭建相同的项目并添加 `&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 的教程不一定比其他教程短，但重要的是，如果你跳到代码部分直接运行命令，它就能工作。开发容器使这成为可能。现在，要是我们也能弄清楚如何为我们自己的将 Docker 容器用作 Visual Studio Code 的开发环境教程制作一个开发容器就好了……

编码愉快！

Burke Holland (@burkeholland)