用DBGPavim在Vim中调试PHP/Python程序

澳门新葡亰网址 12

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

本文介绍调试 PHP 应用程序的各种方法,包括在 Apache and PHP
中打开错误报告,以及通过在一个简单的 PHP 脚本中放置策略性的 print
语句,找到更困难的 bug 的源头。还会介绍用于 Eclipse 的 PHPEclipse
插件,这是一个灵活的开发环境,具有实时语法解析能力,还会介绍 PHPEclipse
的 DBG 调试器扩展。
简介
有许多 PHP
调试技术可以在编码的时候节约大量时间。一个有效却很基本的调试技术就是打开错误报告。另一个略微高级一点的技术包括使用
print 语句,通过显示在屏幕上实际出现的内容,有助于精确地找出更难发现的
bug。PHPEclipse 是一个 Eclipse
插件,能够强调常见的语法错误,可以与调试器结合起来用于设置断点。

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

设置
要学习本文描述的概念,需要 PHP、Web 服务器和 Eclipse。调试器扩展支持的
PHP 版本是 V5.0.3。
我们需要一个 Web 服务器来解析用 PHP
创建的页面并把它们显示到浏览器。本文中使用的是 Apache2。但是,任何 Web
服务器都可以满足要求。
要利用本文中介绍的一些调试技术,需要安装 Eclipse V3.1.1 和插件
PHPEclipse V1.1.8。由于 Eclipse 要求 Java™ 技术,所以还要下载它。
还需要 PHP
的调试器扩展模块。安装它略有些麻烦。请仔细跟随安装调试器扩展的操作说明。现在,先在
php.ini 文件中注释掉那些要求装入和配置 PHP
扩展的行。在需要使用调试器的时候,再取消注释。
请参阅 参考资料 获得下载信息。现在介绍出错消息。

实现原理

澳门新葡亰网址 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等脚本语言。

出错消息
出错消息是作为开发人员的第一道防线。谁都不想在一台没有配置成显示出错消息的服务器上用
PHP
开发代码。但是,请记住,当代码调试完成,准备运行的时候,应当确保关闭了错误报告,因为不希望站点的访问者看到出错消息,因为这会给他们提供足够的信息来利用站点的弱点并黑掉站点。
也可以用出错消息为自己服务,因为它们会显示抛出或生成错误的正确代码行。这样,调试就变成在浏览器上查看生成的错误所显示的行号,并在代码中检查这一行。稍后,将会看到
PHPEclipse 插件通过即时地给语法错误加下划线并在保存文件时用红色 “x”
标注语法错误,可在开发和调试过程中提供极大的帮助。
先来看如何在 php.ini
文件中开启错误报告并设置错误报告的级别。然后将学习如何在 Apache
的配置文件中覆盖这些设置。
PHP 的错误报告
php.ini 文件中有许多配置设置。您应当已经设置好自己的 php.ini
文件并把它放在合适的目录中,就像在 Linux 上安装 PHP 和 Apache 2
的文档说明中所示的那样(请参阅 参考资料)。在调试 PHP
应用程序时,应当知道两个配置变量。下面是这两个变量及其默认值:
复制代码 代码如下:
display_errors = Off
error_reporting = E_ALL

配置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();
 ?>

通过在 php.ini
文件中搜索它们,可以发现这两个变量当前的默认值。display_errors
变量的目的很明显 —— 它告诉 PHP 是否显示错误。默认值是
Off。但是,要让开发过程更加轻松,请把这个值设为 On:
复制代码 代码如下:
display_errors = On

配置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    调试器已停止。

error_reporting 变量的默认值是
E_ALL。这个设置会显示从不良编码实践到无害提示到出错的所有信息。E_ALL
对于开发过程来说有点太细,因为它在屏幕上为一些小事(例如变量未初始化)也显示提示,会搞糟浏览器的输出。我只想看到错误和不良编码实践,但是不想看到无害的提示。所以,请用以下值代替
error_reporting 的默认值:
复制代码 代码如下:
error_reporting = E_ALL & ~E_NOTICE

在Apache环境下调试PHP

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

     bap-PEND-1
    

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

      g $this->memberShip
    

  1. 你可以开始你的调试了,随时按F1可调出帮助窗口,再次F1就关闭帮助窗口。澳门新葡亰网址 4

重新启动 Apache,就全部设置好了。接下来,将学习如何在 Apache
上做同样的事。
服务器上的错误报告
依赖于 Apache 正在做的工作,在 PHP
中打开错误报告可能没法工作,因为在计算机上可能有多个 PHP
版本。有时很难区分 Apache 正在使用哪个 PHP 版本,因为 Apache
只能查看一个 php.ini 文件。不知道 Apache 正在使用哪个 php.ini
文件配置自己是一个安全问题。但是,有一种方法可以在 Apache 中配置 PHP
变量,从而保证设置了正确的出错级别。
而且,最好知道如何在服务器端设置这些配置变量,以否决或抢占 php.ini
文件,从而提供更高级别的安全性。
在配置 Apache 时,应该已经接触过 /conf/httpd.conf 中 http.conf
文件中的基本配置。
要做在 php.ini 文件中已经做过的事,请把下列各行添加到
httpd.conf,覆盖任何 php.ini 文件:
复制代码 代码如下:
php_flag display_errors on
php_value error_reporting 2039

调试命令行启动的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即可。

这会覆盖在 php.ini 文件中为 display_errors 已经设置的标志,以及
error_reporting 的值。值 2039 代表 E_ALL & ~E_NOTICE。如果愿意采用
E_ALL,请把值设为 2047。同样,还是要重启 Apache。
接下来,要在服务器上测试错误报告。
测试错误报告
如果启动了错误报告,会节约许多时间。PHP
中的错误会指向代码中的错误。请创建一个简单的 PHP 文件 test.php,并像清单
1 所示一样定义它。
清单 1. 一个生成错误的简单 PHP
复制代码 代码如下:
print(“The next line generates an error.
“);
printaline(“PLEASE?”);
print(“This will not be displayed due to the above error.”);
?>

调试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的截图。 澳门新葡亰网址 5

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

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

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

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

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

第一个 print() 语句会向 Web
浏览器显示它的内容。但是第二个语句会生成错误并在 Web
页面上显示。这造成最后一个 print() 语句不起作用,如图 1 所示。
图 1. 生成错误
澳门新葡亰网址 6

DBGPavim相对于其他插件的优势

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

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

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

现在开启了错误报告!接下来,用 print 语句帮助调试应用程序。
介绍 print 语句
因为应用程序中的功能性 bug
不会产生错误,所以在所有调试策略中,关于如何正确地放置和使用 print 或
die 语句来调试 PHP 应用程序的知识是一种很好的资产。可以用 print
语句在代码中缩小对问题语句的定位,这些语句在语法上没有错误,也不是
bug,但是从代码的功能上看是 bug。这些是最难发现和调试的
bug,因为它们不会抛出错误。惟一知道的就是在浏览器上显示的内容不是想要的内容,或者想要保存在数据库中的内容根本没有保存。
假设正在处理通过 GET
请求发送过来的表单数据,想向浏览器显示信息,但是出于某种原因,数据没有正确地提交,或者不能正确地从
GET 请求中读出。要调试这类问题,重要的是用 print() 或 die()
语句知道变量的值是什么。
die() 语句会中止程序执行,并在 Web
浏览器上显示文本。如果不想注释掉代码,而且只想显示到出错之前的信息和出错信息,不想显示后面的信息,那么
die() 语句特别有用。
让我们在 PHP 中用 print 语句来测试这个概念
使用 print 语句进行调试
在我作程序员的那些时候,当我在 Linux® 上开发应用程序时,没有方便的 GUI
可以告诉我 bug 在哪,我迅速地发现我在程序中放的 print
语句越多,我在应用程序中把 bug 的范围缩小到一行的机会越大。请创建另一个
PHP 文件 test2.php,并像清单 2 所示的那样定义它。

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个字符,这个命令可以设置显示长度。

清单 2. 显示通过 GET 提交的所有变量
复制代码 代码如下:
$j = “”;
print(“Lets retrieve all the variables submitted to this “);
print(“script via a GET request:
“);
foreach($_GET as $key => $i){
print(“$key=$j
“);
}
if($_GET[‘Submit’] == “Send GET Request”)
$j = “done!
“;
?>

Name:

Email:

您可能会非常容易地发现清单 2 中的
bug!您很棒!但请注意这是一个非常简单的脚本,只是作为使用 print
语句进行调试而展示的一个例子而已。这个脚本只是提取 GET
请求中的所有变量,如果有,就把它们显示在浏览器上。还提供了一个表单,用
GET 请求向服务器发送变量以进行测试。请看输出,如图 2 所示。
图 2. test2.php 的输出
澳门新葡亰网址 7

现在单击 Send GET Request 按钮,请注意只有 $_GET
请求的键显示在浏览器上,而正确的值都没显示。可以在循环中放一个 print
语句,检验在 foreach 循环中每个元素中是否确实存在数据。请参阅清单
3。
清单 3. 用 print 语句验证代码的功能
复制代码 代码如下:

foreach($_GET as $key => $i){
print(“Correct data? ” . $_GET[$key] . “
“);
print(“$key=$j
“);
}

放进去的 print 语句是粗体。注意,现在已经知道在 Web 浏览器上显示的 $key
值是正确的,但是由于某些原因,值没有正确地显示。请看新的输出,如图 3
所示。
图 3. 修改后的 test2.php 的输出
澳门新葡亰网址 8

现在已经知道应用程序正确地从 GET
请求接收到了变量,那么肯定是在代码中有
bug。查看之后注意到,用来显示值的变量 $j 是错误的。在 foreach
语句中指定的是 $i,所以它肯定会有正确的值,但是无意之中输入了
$j。所以通过把 $j 替换成
$i,迅速地修正了错误,重新载入页面之后,就看到了正确的输出,如图 4
所示。

图 4. 修正后的 test2.php 的输出
澳门新葡亰网址 9

现在可以删除或注释掉刚才添加的 print 语句了,因为已经发现了代码中的
bug。注意,这只是在调试应用程序时可能遇到的许多错误中的一个很小的子集。对于使用数据库时可能遇到的问题,一个好的解决方案是输出
SQL 语句,以确保执行的 SQL 就是想要执行的。

现在要来看看如何使用 Eclipse IDE 和 PHPEclipse
插件及调试器扩展进一步在调试历程中提供帮助。

使用 PHPEclipse

您可能用过 Eclipse,但是可能不熟悉它。请参阅
参考资料
获得 Eclipse 平台的介绍。

用于 Eclipse 的 PHPEclipse 插件是用来开发 PHP
应用程序的一个流行工具。请启动 Eclipse 并把工作区目录指定为 Apache 的
www 目录(在我的机器上是 c:www)。现在单击 File > New >
Project
。会弹出 New Project 向导。双击 PHP 文件夹并选择 PHP
Project。单击 Next,输入项目名称 debugArticle,并单击 Finish

如果把 Web 服务器设置为在端口 80
上侦听,那么不需要做任何修改。否则,请转到 Navigator 窗口,在 PHP 项目
debugArticle 上右击,选择 Properties,然后单击 PHP Project
Settings
。单击 Configure Workspace Settings 然后修改合适的
localhost 或者添加 Web 服务器侦听的端口(例如
Apply 完成设置。

Navigator 窗口应当显示项目和一个 .project
文件。在项目上右击,就像前面做的那样,只是这次选择 New > PHP
File
。用想要创建的 PHP 文件的名称 test3.php 替换 *.php,然后单击
Finish。在 Eclipse IDE
中应当出现一个新文件。可能需要导航到窗口底部的 PHP 浏览器来查看 PHP
文件的当前输出(参见图 5)。

图 5. Eclipse 的 PHPEclipse 插件
澳门新葡亰网址 10

注意,只有 Windows® 的用户可以像清单 5 所示的那样使用 PHP
浏览器。通过打开独立浏览器窗口并把浏览器指向测试脚本所在目录,也可以使用同样的功能。

现在来演示这个应用程序,证明它的强大能力。

在 “使用调试器” 一节中,将学习如何用 Eclipse、PHPEclipse
和前面下载的调试器 PHP 扩展来调试 PHP
应用程序。先从学习如何使用它的语法解析功能开始。

语法解析和加下划线

先从查看 PHPEclipse 如何提供帮助调试 PHP
应用程序的实时语法解析功能开始。要看这个特性的实际应用,先从在 Eclipse
中定义 test3.php 开始,如下所示。

注意,在清单 4 中加下划线的两个字符在 Eclipse
中加了下划线,提示语法不正确。按 Ctrl+S 保存文件,会在 Eclipse
中显示解析错误:在代码中与解析错误对应的行上会加上红 “x”,如图 6 所示。

图 6. 语法错误强调
澳门新葡亰网址 11

现在演示 PHP 浏览器。这个窗口提供了当前 PHP 脚本的预览,如图 6 所示。

从上面定义的 test3.php 中删除逗号(,)。按 Ctrl+S
保存文件,然后观察 PHP 浏览器窗口的更新,显示了 Hello World(参见图
7)。

图 7. 在 PHPEclipse 中预览 PHP 脚本
澳门新葡亰网址 12

发表评论

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

相关文章

网站地图xml地图