使用了一段时间的Neovim(Vim的一个变种)之后,发现再也离不开了,目前已经把Neovim作为主力开发工具了。刚也把PHP的调试功能给配置上了,这里记录一下在Neovim中配置PHP调试的整个过程,也适用于Vim。
我的开发环境如下
- 编程环境:
- Macbook Air(macOS Mojave 10.14.1)
- iTerm2(3.2.9)
- Neovim(0.3.7)
- 代码运行环境:
- Virtualbox(6.0.6)
- Vagrant(2.2.5)
- Ubuntu(18.04)
- Nginx(1.14.0)
- PHP(php-fpm 7.2.19)
安装Xdebug
这里是Xdebug官方的安装指南:Xdebug Installation,由于我的PHP运行环境是搭建在Ubuntu虚拟机里的,所以可以直接使用Ubuntu的包管理工具来安装Xdebug。
# 先更新一下包索引
sudo apt update
sudo apt install php-xdebug
安装好之后,Xdebug会在目录下/usr/lib/php/20170718/
目录下生成一个xdebug.so
二进制文件,同时在/etc/php/7.2/fpm/conf.d/
中生成一个ini配置文件:20-xdebug.ini
。后面我们会在这个配置文件中添加自定义的配置来实现远程调试。
在Nginx的网站目录下创建了一个index.php
,写一行代码来检测Xdebug是否安装正确了。
<?php phpinfo() ?>
如图所示,我们的Xdebug已经安装上了。
添加自定义的Xdebug配置
Xdebug的配置文件是/etc/php/7.2/fpm/conf.d/20-xdebug.ini
,打开这个文件添加下面着几行配置。
zend_extension=/usr/lib/php/20170718/xdebug.so
xdebug.remote_enable=1
xdebug.remote_connect_back=1
xdebug.remote_port=9000
第一行指定扩展xdebug.so
文件的位置,注意是zend_extension
而不是extension
。
xdebug.remote_enable=1
开启远程调试。由于我是在Mac主机上调试Ubuntu虚拟机中的代码,相当于是两台电脑,因此需要开启Xdebug的远程调试。
Xdebug远程调试需要知道调试主机的IP地址。有两种方案可以指定,第一个方案是通过xdebug.remote_host=<your-network-ip>
来指定一个固定的IP地址。这种方法把IP固定死了,只能单人调试。第二个方案就是上面的设置xdebug.remote_connect_back=1
,指定调试的IP地址即发起网页请求的主机的IP地址,这样任何发起网页请求的主机都可以调试代码。这样在开发环境中比较方便。
xdebug.remote_port=9000
指定了Mac主机上用于监听Xdebug发来的调试信号的端口。
在Vim/Neovim中安装Vdebug插件
Vdebug提供了在Vim/Neovim中调试代码的用户界面和工具,这里是Vdebug的GitHub网址:vim-vdebug/vdebug。
Vdebug中使用了Python的代码,因此要先确保电脑中安装了Python3。同时还要确认一下自己的Vim/Neovim是否支持Python3。Vim可以在命令栏中输入:versioin
,查看输出中是否有+python3
,Neovim则是在命令栏中输入:checkhealth
,若输出中有类似- OK: Python3.6.1+ was successful
则说明支持Python3。
我使用Vim/Neovim插件管理器是vim-plug,所以只需要在插件列表中添加如下一行即可安装Vdebug。
Plug 'vim-vdebug/vdebug'
接着让Vim/Neovim重新加载一下配置文件。
:source ~/.vimrc " Vim用户运行
- - - - OR - - - -
:source ~/.config/nvim/init.vim “ Neovim用户运行
执行vim-plug插件的安装命令
:PlugInstall
安装好Vdebug之后我们还要Vim/Neovim的配置文件中配置一下调试参数,在Vim/Neovim配置文件的最后面添加如下配置:
if !exists('g:vdebug_options')
let g:vdebug_options = {}
endif
let g:vdebug_options.port = 9000
let g:vdebug_options.path_maps = { "/var/www": "/Users/xiaer/program/www" }
let g:vdebug_options.break_on_open = 0
让Vdebug去监听Mac主机的9000端口,一旦9000端口收到Xdebug发来的信息就可以开始调试。path_maps
是将Ubuntu虚拟机上的代码和Mac主机的代码映射好,这样就可以通过本地代码调试远程的代码。当break_on_open
设置为1的时候每一次调试都会在第一行的停一下,设置为0就会直接运行到第一个断点才暂停。
修改了Vim/Neovim的配置文件要记得再source一下才会生效哦!
开始调试
在Vim/Neovim中使用Vdebug调试的过程如下:
- 在需要调试的地方打一个断点(默认快捷键是F10)。
- 然后启动Vdebug调试(默认快捷键是F5),Vdebug会监听Mac主机的9000端口。
- 接着在浏览器地址栏输入要调试的网页链接,并在链接的后面加上一个
XDEBUG_SESSION_START=1
请求参数,比如原链接是http://localhost/posts
,那么添加调试参数后就是http://localhost/posts?XDEBUG_SESSION_START=1
。 - 如果没有意外的话现在程序已经停在你第一个断点的位置了。
- 调试完成之后,退出调试模式的默认快捷键是F6。
Vim/Neovim的PHP调试配置到这里就完成了。