Vim/Neovim中配置PHP的代码调试

使用了一段时间的Neovim(Vim的一个变种)之后,发现再也离不开了,目前已经把Neovim作为主力开发工具了。刚也把PHP的调试功能给配置上了,这里记录一下在Neovim中配置PHP调试的整个过程,也适用于Vim。

Neovim中使用Vdebug调试PHP代码

我的开发环境如下

  • 编程环境:
    • 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() ?>
phpinfo中查看xdebug

如图所示,我们的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调试的过程如下:

  1. 在需要调试的地方打一个断点(默认快捷键是F10)。
  2. 然后启动Vdebug调试(默认快捷键是F5),Vdebug会监听Mac主机的9000端口。
  3. 接着在浏览器地址栏输入要调试的网页链接,并在链接的后面加上一个XDEBUG_SESSION_START=1请求参数,比如原链接是http://localhost/posts,那么添加调试参数后就是http://localhost/posts?XDEBUG_SESSION_START=1
  4. 如果没有意外的话现在程序已经停在你第一个断点的位置了。
  5. 调试完成之后,退出调试模式的默认快捷键是F6。

Vim/Neovim的PHP调试配置到这里就完成了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,478评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,825评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,482评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,726评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,633评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,018评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,168评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,320评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,264评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,288评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,995评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,587评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,909评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,284评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,862评论 2 339

推荐阅读更多精彩内容