Zend Studio集成Xdebug断点调试详解

本文主要介绍如何在服务器上用VIM +
XDebug调试PHP程序,目前虽然有不少介绍如何用Eclipse +
XDebug在开发人员工作机上调试PHP的文章,但对于如何系统的配置VIM +
XDebug还是比较少的,而且目前关于VIM设置的文章都用一个比较老的插件。这里主要介绍一个新插件DBGPavim,它相对于老的一些插件有很多优势。同时该插件可完美的用于Python程序的调试。另外VIM

转自:

先下载PHP扩展Xdebug ,
可以复制自己的phpinfo粘贴到,
会生成需要下载的版本, php.ini的设置语句.

  • XDebug相对于Eclipse + XDebug也有不少优势,将在文章讲述。

Xdebug是PHP开发中两个常用的断点调试工具之一(另一个为Zend Debugger)。

下载好之后放入php目录的ext文件夹中, 然后设置php.ini, 在最后加上

实现原理

图片 1

DBGp是调试器后台和调试器界面通信的一种协议,用于多种脚本语言的调试。XDebug是用于调试PHP的DBGp实现。VIM要和XDebug互通,实现PHP的调试,需要能够理解DBGp协议,并能发送DBGp指令。DBGPavim就是这样一个插件,它使VIM能够接受DBGp请求,并发送DBGp指令,以达到调试目的。DBGPavim的名字源于DBGp@VIM。

ActiveState提供了用于调试Python/Ruby的DBGp实现Komodo Remote Debugging
Package,后面有一节将讲到如何使它和VIM互通,以调试Python。用户将能以此类推出如何调试ruby/nodejs等脚本语言。

现在,我们在Zend Studio中集成PHP的Xdebug模块,从而在Zend
Studio中实现断点调试功能。

zend_extension =
C:pathphpextphp_xdebug-2.4.0rc4-5.6-vc11-x86_64.dll
xdebug.remote_enable =1
xdebug.remote_handler = dbgp
xdebug.remote_host = localhost
xdebug.remote_mode = req
xdebug.remote_port = 9000
xdebug.idekey=PHPSTORM

配置XDebug

  1. 安装XDebug可以参考
  2. 编辑php.ini,加入以下两行:

    zend_extension=/path/to/xdebug.so
     xdebug.remote_enable=1
    
  3. 编辑你的httpd.conf,加入以下行:

     php_value xdebug.remote_autostart 1
    

如果有多个开发人员同时需要调试不同的VirtualHost,可以在你的VirtualHost段中加入以下行:

 php_value xdebug.remote_port 9009

注:这里的9009就是VIM作为DBGp服务器应当监听的端口,不同的开发人员在不同的VirtualHost中用各自不同的端口号。这个端口号和下一节提到的dbgPavimPort要一致。不加这一行,默认的端口号是9000。
最后可通过phpinfo.php检查你的XDebug配置是否正确,你必须能够看到以下这些行的值如下(主要是前两列):

xdebug.remote_autostart  On  Off
 xdebug.remote_enable   On  On
 xdebug.remote_handler  dbgp    dbgp
 xdebug.remote_host 127.0.0.1   127.0.0.1
 xdebug.remote_port 9009    9000

phpinfo.php文件内容如下:

<?php
     phpinfo();
 ?>

1、下载、安装、配置Xdebug

关于如何在PHP中安装、配置Xdebug模块,请直接参考文章PHP安装配置Xdebug模块详解。

然后重启apache, 去设置phpstorm

配置VIM + DBGPavim

DBGPavim插件本身是用Python实现的,所以需要你的VIM支持Python
2.7。打开你的VIM,输入命令

:version

如果能看到“+python”,说明你的VIM是支持Python的。
如果看到的是“-python”,说明你的VIM不支持Python,你可以按如下步骤编译自己的VIM:

  1. 安装Python 2.7
  2. export path=/path/to/python2.7/bin:$PATH
  3. 用以下命令编译VIM:

 ./configure --prefix=/opt/vim --enable-pythoninterp --with-python-config-dir=/usr/lib/python2.7/config
 make
 make install

注:这里的/usr/lib/python2.7/config取决于你把Python2.7安装到什么位置。

从这里或者这里下载DBGPavim,放到你的~/.vim目录下,并编辑的你的~/.vimrc,加入以下两行:

let g:dbgPavimPort = 9009
let g:dbgPavimBreakAtEntry = 0

注:这里的9009和上一节的9009要一致,如果上一节没有配置xdebug.remote_port,这里也不需要配置,因为它们都会使用默认的9000。
dbgPavimBreakAtEntry=0告诉VIM不在入口处停下,这样只会在断点处停下。

你可以重新启动VIM,按F5检查你的DBGPavim配置是否正确。如果你配置成功的话,你会做VIM窗口的右下角看到提示信息如下:

bap-LISN-9009

它表示VIM目前正在监听9009端口,bap说明它只会在断点处停下,其他提示信息格式如下:

<bae|bap>-<LISN|PENDn|CONN|CLSD>

断点状态

bae Break At Entry,在入口处停下
bap Break only At breakPoints,只在断点处停下

调试器状态

LISN 调试器已启动,正处于监听状态。
PEND-n  调试器已捕捉到连接请求,可以按F5进入调试模式了。
CONN    VIM正处于调试模式中。
CLSD    调试器已停止。

2、Xdebug远程连接配置

想要在Zend Studio中使用Xdebug,就需要启用Xdebug的远程调试功能。

Xdebug与远程调试相关的参数,见下表。

配置参数选项 参数值类型与默认值 参数选项描述
xdebug.remote_enable boolean类型,默认值=0 是否启用Xdebug的远程调试功能(默认:未启用)
xdebug.remote_host string类型,默认值=localhost 指定远程调试的主机地址(可以为域名、主机名或IP地址)
xdebug.remote_port integer类型,默认值=9000 指定远程调试的端口号
xdebug.remote_handler string类型,默认值=dbgp 指定远程调试的处理协议,值可以为"php3"、"gdb"、"dbgp"。其中,dbgp是唯一受支持的协议。php3可以选择旧版本PHP 3样式的调试器输出;gdb可以像dbgp一样地使用GDB调试器。Xdebug 2.1及以后版本只支持dbgp协议。
xdebug.remote_autostart boolean类型,默认值=0 通常情况下,你需要使用一个指定的HTTP GET/POST 变量来启动远程调试。如果该参数设为1,即使没有指定的变量,Xdebug也将一直尝试开始一个远程调试会话,并与客户端保持连接。
xdebug.remote_connect_back boolean类型,默认值=0 该参数自2.2版本开始引入。如果启用该参数选项,xdebug.remote_host参数将会被忽略。Xdebug将会尝试和发送请求到PHP服务器的所有客户端建立连接。Xdebug将通过$_SERVER['REMOTE_ADDR']来获取客户端所使用的IP地址。只要对方能够连接到服务器,就可以开启一个远程调试会话。
xdebug.remote_cookie_expire_time integer类型,默认值=3600 该参数自2.2版本开始引入。指定远程调试的有效期限(单位:秒)。
xdebug.remote_log string类型,默认值= 指定远程调试的日志文件路径,用于记录远程调试的日志信息,该文件在调试过程将会一直以追加模式保持打开,所以默认情况下,文件内容不会被覆盖。
xdebug.remote_mode string类型,默认值=req 指定远程调试的连接模式,值可以为"req"或"jit"。req表示一旦运行脚本就立即连接调试客户端。jit表示当错误发生时才立即连接调试客户端。

简而言之,如果保持其他参数默认(有些参数官方也不建议修改),我们只需要在php.ini中接着Xdebug原来的配置添加如下一行代码,即可启用远程调试功能。

xdebug.remote_enable=On

最终配置如下图所示。

图片 2

图片 3

在Apache环境下调试PHP

  1. 现在确认配置正确后,可以用VIM打开你需要调试的文件,跳到你需要调试的行,按F10设置当前行为断点,并按F5启动调试器。
  2. 用浏览器访问会调用相应PHP文件的URL,你会看到VIM状态栏里的的提示信息变成:

     bap-PEND-1
    

  1. 它告诉你已经有一个连接被拦截,可以按F5开始调试了。图片 4
  2. 按F5进入调试模式,你会看到VIM窗口被分成三部分:左上为源码窗口,右上为变量查看窗口,下方为调用堆栈窗口。图片 5在源码窗口里,把光标定位到某一个变量上面按F12,在变量查看窗口就能看到该变量的值,如果该变量不是简单变量,其成员也会显示出来。如果该变量的某个成员仍不是简单变量,该行后面会出现一个加号,在该行按回车键,该成员的值将被继续展开。如果你想直接查看某个变量的成员变量,可以按v切换到visual模式,选中该成员再按F12,比如$this->login。在堆栈窗口,当你在某一行按回车,将跳到该层。最上面一行是最底层,最下面一行是最顶层。切换调用堆栈的层次,可以帮助你查看各个层次的变量,比如有些全局变量只有在最顶层才能看到。对于源码中没有出现的变量,你可以通过命令:Pg来查看,比如:

      g $this->memberShip
    

  1. 你可以开始你的调试了,随时按F1可调出帮助窗口,再次F1就关闭帮助窗口。图片 6

3、配置Zend Studio

点击Zend
Studio菜单栏的【Window】->【Preferences】。如下图所示,在首选项窗口中依次找到【PHP】->【Debug】的右侧面板。

在旧版本的Zend Studio中,菜单名直接为【PHP Debug】。

首先我们对PHP Server进行配置,也就是将PHP Server的调试器类型从默认的Zend
Debugger改为Xdebug。点击图中编号①处的链接。

图片 7

在PHP Server中对当前项目指定的Server进行编辑【Edit】。

笔者的abc.com是本地的虚拟主机配置,以便于直接映射到当前项目的根目录。

图片 8

将Debugger类型改为Xdebug。

图片 9

接着,我们配置PHP执行环境。点击前面图中编号②的链接,进入PHP的执行环境配置页面。如下图所示,Zend
Studio为我们自带了几个采用Zend
Debugger的执行环境,由于我们的PHP是自己独立安装的,而不是采用Zend
Studio自身集成的。因此,我们将自己安装的PHP执行环境添加进来。点击【Add】按钮。

图片 10

输入执行环境的名称,点击【Browse】按钮浏览我们自己安装的php.exe和php.ini的文件路径,并将PHP
Debugger改为Xdebug类型,然后点击【Finish】。

图片 11

此时,我们就可以看到PHP Server和PHP
Executable的调试器类型都已经改为了Xdebug。面板下方还有一个默认勾选的【Break
at First
Line】,表示自动在第一行代码处添加断点(当然,你也可以取消【Break at
First Line】选项,然后在调试之前根据需要添加断点)。

图片 12

由于我们的Xdebug远程调试配置参数均为默认值,而Zend
Studio为我们的Xdebug默认设置的参数也与之相同,因此我们不需要在【PHP】->【Debug】->【Installed
Debuggers】中对Xdebug的参数进行修改(其默认参数如下图所示)。

图片 13

由于我们更改了php.ini配置文件,因此需要重启服务器使其生效。

接着,如下图所示,我们就在指定的PHP文件中添加断点,并进行断点调试(由于我们刚才勾选了【Break
at First Line】选项,因此这里可以不加断点,当我们进行调试时,Zend
Studio会自动在第一行代码的位置进入断点调试模式)。

图片 14

添加好断点后,我们就在该文件中点击右键,在弹出的关联菜单中点击【Debug
As】->【PHP Web Application】(有些旧版本为【PHP Web Page】)。

图片 15

接着在弹出的下列对话框中输入用于调试的URL。

图片 16

接着,Zend Studio会提示我们是否进入调试透透视图,点击【Yes】。

图片 17

最后,Zend Studio就自动进入了断点调试模式,如下图所示。

这个时候,我们就可以像使用Eclipse的调试快捷键来对PHP文件进行调试了。

Eclipse调试快捷键:F5(单步跳入)、F6(单步跳过)、F7(单步返回)、F8(跳过调试继续执行)。

图片 18

 

下一篇:Xdebug断点调试的工作原理详解

 

调试命令行启动的PHP程序

如果你需要调试命令行启动的PHP程序,也需要保证PHP程序端的设置是正确的。这些设置可以像前面一样在php.ini中设定,也可以通过命令行参数来设定。比如:

php -dxdebug.remote_autostart=1 -dxdebug.remote_port=9009 test.php

如果你的命令行使用的ini和apache中php5_module使用的ini是一样的(通常情况是这样的),你不需要在参数中再来做这些设置。但如果你在ini中的设置是放在某个virtualhost段里,你仍然需要加上这些设置。
你可以通过命令行:

php --ini

来查看你的命令行用的是哪个ini。

接着你可以使用命令:

php -r "phpinfo();"|grep xdebug.remote_

来检查你的XDebug设置。

基本步骤如下:

  1. 用VIM打开你需要调试的PHP文件,F10设置断点,F5启动调试监听。
  2. 从命令行运行php程序如上。
  3. 回到你的VIM窗口,将看到提示信息为PEND-1。
  4. 按F5进入调试模式。

DBGPavim提供一个:Dp命令简化命令行程序的调试。只需打开你的PHP文件,输入命令:Dp即可。

1.
进入File>Settings>PHP>Servers,这里要填写服务器端的相关信息:
name: localhost,
host: localhost,
port: 80,
debugger: XDebug

调试Python程序

前面说过VIM +
DBGPavim作为DBGp协议的服务器,可以与XDebug协同工作,也可以与ActiveState提供的Komodo
Python Remote Debugging
Client协同工作,实现Python程序的调试,具体步骤如下:

  1. 从这里下载安装Komodo
    Python Remote Debugging
    Client,把解压后的bin目录加到你的PATH路径中,注意bin目录下的pydbgp文件。
  2. 用VIM打开你需要调试的Python文件,F10设置断点,F5启动调试监听。
  3. 通过pydbgp运行你的Python程序,如

     pydbgp -d 127.0.0.1:9009 test.py
    
    1. 注:这里的9009端口就相当于上面为PHP调试时设置的xdebug.remote_port,需要和dbgPavimPort保持一致。
    2. 回到你的VIM窗口,将看到提示信息为PEND-1。
    3. 按F5进入调试模式。

    上面的:Dp命令同样适用于Python调试,下图为Windows 7下用GVIM +
    pydbgp调试Python的截图。 图片 19

    ### VIM + DBGPavim相对于Eclipse + XDebug的优势

    大多数服务器不会启动XServer,无法在服务器上启动Eclipse。如果在开发人员工作机上启动Eclipse +
    XDebug,就相当于把DBGp服务器在工作机上运行,你需要设置路径映射,也就是HTTP
    Server执行的一份代码在服务器上,Eclipse调试时打开的是一份代码,在工作机上,要保证这两份代码能对应上需要映射路径。当程序规模不大时,问题不大,当程序规模大时,会比较麻烦,而且要保证代码的同步,否则会串行。

    同时可以遭遇网络防火墙之类的问题。

    VIM +
    DBGPavim也是支持远程调试的,但同样避免不了路径映射的设置,如下:

    let g:dbgPavimPathMap = [['D:/works/php','/var/www'],]
    

如果是自定域名则host设置自定域名, 如laravel5.io

DBGPavim相对于其他插件的优势

DBGPavim源于VIM早期的一个DBGp插件

DBGPavim会监听所有来自DBGp客户端如XDebug、pydbgp的DBGp连接,不像其它插件只能捕获第一个连接。这对于大规模的WEB程序是必须的,因为现在的一次网页加载通常会触发多个HTTP请求,而我们需要调试的可能来自其中的任何一个。
同时DBGPavim支持只在断点处停下,其它的插件都是在入口处停下,需要程序员一步步跟踪进去。这省了开发人员很大的麻烦,而且避免出错后一次次的重启调试。

相信你也已经发现,DBGPavim可以与Windows下的GVIM一起工作,并且工作的很好。

图片 20

DBGPavim的详细使用参考

VIM normal模式下

F5   启动调试监听,或者有可调试连接时进入调试模式。
F6  停止调试监听。
F8  切换dbgPavimBreakAtEntry的值,按这个键你可以看到状态栏提示信息在bae和bap之间切换,即是否在PHP程序入口处停下。
F10 在当前行设置或删除断点,在调试模式下同样适用。

调试模式下

F1   打开或关闭帮助窗口
F2  单步进入
F3  单步跳过
F4  单步退出
F5  继续执行直到下一个断点,如果后续没有断点就退出调试模式。
F6  停止调试,这个按键就导致VIM退出调试模式,并且停止调试监听。
F7  调试时执行php语句,按下F7后,用户可在变量查看窗口输入php语句,回车后执行。
F9  最大化某个子窗口,或者重置窗口布局。
F11 查看当前执行环境下的所有变量的值,在不同的堆栈层次,会有不同的结果。
F12 查看光标下的变量的值。

以上功能键为默认配置,你如果习惯多数浏览器的按键设置,可以把下面的代码加入你的.vimrc中:

let g:dbgPavimKeyRun = '<F8>'
let g:dbgPavimKeyStepOver = '<F10>'
let g:dbgPavimKeyStepInto = '<F11>'
let g:dbgPavimKeyStepOut = '<F12>'
let g:dbgPavimKeyPropertyGet = '<F3>'
let g:dbgPavimKeyContextGet = '<F4>'
let g:dbgPavimKeyToggleBp = '<F9>'
let g:dbgPavimKeyToggleBae = '<F5>'
let g:dbgPavimKeyRelayout = '<F2>'

VIM命令,所有命令只有第一个字母为大写。

:Bl  列出所有断点
:Bp 与F10功能相同  p   这个命令可用于快速调试当前文件,它实现了如下功能:

    1. 检查命令行下XDebug/pydbgp的设置是否正确
    2. 启动调试器监听
    3. 用php/pydbgp执行当前文件
  g <longfoo> 查看较长变量的值,比如:Pg $this->savings[3]
:Up 调用堆栈往上一级  n  调用堆栈往下一级
:Wc [$foo]  打开/关闭对变量$foo的监视。如果没有参数,就监视当前执行环境下的所有变量。
:We <foo> 打开/关闭对语句foo的监视,即每一单步后自动执行foo语句。
:Wl 列出所有被监视的变量或语句。
:Children <n> 对于数组默认显示前1024个元素,这个命令可以修改。  epth <n> 对于复杂变量,默认只显示下一层成员,这个命令可以设置限制多层。
:Length <n>   对于字符串变量,默认执行显示前1024个字符,这个命令可以设置显示长度。
  1. 进入File>Settings>PHP>Debug,找到XDebug选项卡,port填9000
    进入File>Settings>PHP>Debug>DBGp Proxy 填写:
    IDE key: phpStorm
    host: localhost
    port: 80

图片 21

图片 22
设置完毕,点OK退出。

 

点菜单栏的Run>Edit Configurations… 在弹出的窗口中添加一个调试配置:

点击左上角加号,选择PHP Web Application

图片 23

填写完毕后,在代码里设置断点, 再开启电话icno监听, 点小甲壳虫启动调试

图片 24

图片 25

再下个浏览器插件, xdebug helper, 下载好之后点选项, IDE选PHPSTORM,
不想让所以网页显示小甲虫, 可以设置domain filter

图片 26

基本完事了, 调试就点开电话图标监听, 设置好断点, 点小甲虫开启调试了,
刷新页面可见结果

图片 27

发表评论

电子邮件地址不会被公开。 必填项已用*标注