基于 VSCode 与 Docker Desktop 配置 Flarum 本地开发环境

zgq354

修改于 2023-09-21 20:04:48

2.6K0

修改于 2023-09-21 20:04:48

文章被收录于专栏：0x00010x0001

上篇文章我们写了 Flarum 二次开发项目的规划，这里也分享一下本地开发与调试 Flarum 的配置的方案，助你快速搭起 Flarum 的本地开发调试环境。

基础软件

关键软件：

Windows 下的额外配置：

WSL2
Docker Desktop 最好设置 WSL2 backend
VSCode Remote WSL 插件（支持 WSL 的本地开发）

本地配置

首先配置好需要安装的 VSCode、插件与 Docker Desktop 的开发环境，然后准备一个项目目录，这里我们以 ~/flarum-dev 为例。

然后准备 Docker 环境，这里用我在基于 Docker 的 Flarum 轻论坛部署方案提到的 flarum-docker-env 项目，直接克隆下来即可。然后新建一个 flarum-site 目录，按上篇文章配置 Flarum 的项目结构。

一系列操作完毕之后大致是这样的目录结构：

接下来通过软连接将 flarum-docker-env 与 flarum-site 关联在一起，然后 docker-compose 启动环境：

到这里，环境已经跑起来了，但由于域名没有配置，我们需要在本地配置代理，将该域名的请求都转发到本地。

代理配置

本地环境的代理配置在前文已有简略提到，按照前文的说明使用 LightProxy 作为开发环境调试的代理工具，我们以 example.com 为例，在 LightProxy 的配置页面添加一组 whistle 规则：

如图，要使用本地环境，只需双击启用，若需要线上环境，再双击取消即可：

到这里我们可以直接在浏览器访问 example.com，执行安装操作。

开发

简单一条命令，快速启动 VSCode 开始开发：

以 flarum-dev 作为工作区根目录，每次打开 Terminal 都会定位到根目录，而大多数情况我们只需要在 flarum-site 目录下操作，不太方便，所以这里需要修改一下 CWD 的配置，创建 .vscode/settings.json，内容如下：

有时候我们需要运行 php flarum cache:clear，php flarum migrate 之类的命令，我们需要进入 php-fpm 容器内部去执行。

这么长的命令，打起来不太顺手，可以直接写成 alias 加到你的 shell 配置文件。

然后直接 flarum 即可进入容器内部，然后执行那些依赖 PHP 的命令行脚本。

XDebug 调试支持

完成上面的工作，Flarum 开发基本没什么大问题，有一个调试器的话，可以大大提高你的 Debug 效率，所以这里也介绍 XDebug 的配置与使用。

PHP-FPM 容器的配置

首先在 flarum-docker-env 里面 php-fpm 容器的 Dockerfile 里加上调用 Pecl 安装 XDebug 的指令：

然后准备一段 XDebug 配置文件，容器内部对应 docker-php-ext-xdebug.ini，我们在宿主机创建这个文件，填充内容：

XDebug 的调试是 PHP 主动连接本地的 IDE 实现的，PHP 需要知道远程连接的 IDE 的 IP 地址，这里我设置了一个名为 XDEBUG_HOST 的环境变量。

这里依赖 docker-compose.yml 指定环境变量来配置，我们可以通过 host.docker.internal 获得宿主机。但这个操作在 WSL Remote 有问题，所以在 Windows 下开发，得手动指定 WSL 的 IP 地址，所以我设置了通过 .env 文件配置地址的机制，默认使用 host.docker.internal。docker-composer.yml 的 volume 和 environment 配置如下：

完整的修改参见 commit 提交的变动记录。

所有的修改提交到了 flarum-docker-env 的 dev 分支里，若你基于我的仓库来搭建，可以直接切换分支，一键完成。（毕竟还是有必要简单介绍一下这里的修改，不至于太过神秘）

然后重新构建容器并启动：

容器重建并启动后，我们可以在 ~/flarum-site/public/ 建一个 info.php 文件，然后调用 phpinfo(); 查看它的输出，看 XDebug 扩展是否启用，还有它的各项配置参数。