PHP 程序员的调试技术小结


Posted in PHP onNovember 15, 2009

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

设置
要学习本文描述的概念,需要 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 扩展的行。在需要使用调试器的时候,再取消注释。
请参阅 参考资料 获得下载信息。现在介绍出错消息。

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

display_errors = Off 
error_reporting = E_ALL

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

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

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

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

第一个 print() 语句会向 Web 浏览器显示它的内容。但是第二个语句会生成错误并在 Web 页面上显示。这造成最后一个 print() 语句不起作用,如图 1 所示。
图 1. 生成错误
PHP 程序员的调试技术小结

现在开启了错误报告!接下来,用 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 所示的那样定义它。

清单 2. 显示通过 GET 提交的所有变量

<?php 
$j = ""; 
print("Lets retrieve all the variables submitted to this "); 
print("script via a GET request:<br>"); 
foreach($_GET as $key => $i){ 
print("$key=$j<br>"); 
} 
if($_GET['Submit'] == "Send GET Request") 
$j = "done!<br>"; 
?> 
<form method="GET"> 
Name: <input name="name"><br> 
Email: <input name="email" size="25"><br> 
<input name="Submit" type="submit" value="Send GET Request"> 
</form>

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

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

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

放进去的 print 语句是粗体。注意,现在已经知道在 Web 浏览器上显示的 $key 值是正确的,但是由于某些原因,值没有正确地显示。请看新的输出,如图 3 所示。
图 3. 修改后的 test2.php 的输出
PHP 程序员的调试技术小结

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

图 4. 修正后的 test2.php 的输出
PHP 程序员的调试技术小结

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

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

学习

获得产品和技术

讨论

关于作者

Tyler Anderson 2004 年从 Brigham Young 大学毕业,获得计算机科学学位。现在是他作为计算机工程硕士生的最后一学期。过去,他作为数据库程序员为 DPMG.com 工作,现在他是位于 Beaverton, Ore 的 Stexar 公司的工程师。
原文地址 http://www.ibm.com/developerworks/cn/opensource/os-debug/
PHP 相关文章推荐
建立文件交换功能的脚本(二)
Oct 09 PHP
require(),include(),require_once()和include_once()区别
Mar 27 PHP
PHP 命名空间实例说明
Jan 27 PHP
php文档更新介绍
Jul 22 PHP
PHP防CC攻击实现代码
Dec 29 PHP
PHP基础知识回顾
Aug 16 PHP
使用php将某个目录下面的所有文件罗列出来的方法详解
Jun 21 PHP
PHP中使用addslashes函数转义的安全性原理分析
Nov 03 PHP
php通过记录IP来防止表单重复提交方法分析
Dec 16 PHP
php判断当前用户已在别处登录的方法
Jan 06 PHP
php自定义hash函数实例
May 05 PHP
phpcms手机内容页面添加上一篇和下一篇
Jun 05 PHP
PHP 配置open_basedir 让各虚拟站点独立运行
Nov 12 #PHP
php $_SERVER当前完整url的写法
Nov 12 #PHP
php利用header函数实现文件下载时直接提示保存
Nov 12 #PHP
计算一段日期内的周末天数的php代码(星期六,星期日总和)
Nov 12 #PHP
php 分库分表hash算法
Nov 12 #PHP
PHP 面向对象实现代码
Nov 11 #PHP
超级简单的php+mysql留言本源码
Nov 11 #PHP
You might like
openPNE常用方法分享
2011/11/29 PHP
PHP crypt()函数的用法讲解
2019/02/15 PHP
PHP使用HTML5 FileApi实现Ajax上传文件功能示例
2019/07/01 PHP
从阶乘函数对比Javascript和C#的异同
2012/05/31 Javascript
js异步加载的三种解决方案
2013/03/04 Javascript
jQuery操作元素css样式的三种方法
2014/06/04 Javascript
Bootstrap三种表单布局的使用方法
2016/06/21 Javascript
webpack打包后直接访问页面图片路径错误的解决方法
2017/06/17 Javascript
JavaScript实现简单的双色球(实例讲解)
2017/07/31 Javascript
vue router嵌套路由在history模式下刷新无法渲染页面问题的解决方法
2018/01/25 Javascript
Nodejs对postgresql基本操作的封装方法
2019/02/20 NodeJs
监控微信小程序中的慢HTTP请求过程详解
2019/07/05 Javascript
vue 微信分享回调iOS和安卓回调出现错误的解决
2020/09/07 Javascript
[47:43]完美世界DOTA2联赛PWL S3 Magama vs GXR 第二场 12.19
2020/12/24 DOTA
在Python中使用mechanize模块模拟浏览器功能
2015/05/05 Python
python递归删除指定目录及其所有内容的方法
2017/01/13 Python
python3+PyQt5实现拖放功能
2018/04/24 Python
基于随机梯度下降的矩阵分解推荐算法(python)
2018/08/31 Python
selenium+python自动化测试之页面元素定位
2019/01/23 Python
解决python中用matplotlib画多幅图时出现图形部分重叠的问题
2019/07/07 Python
python gdal安装与简单使用
2019/08/01 Python
在PyCharm的 Terminal(终端)切换Python版本的方法
2019/08/02 Python
Django DRF APIView源码运行流程详解
2020/08/17 Python
pycharm 多行批量缩进和反向缩进快捷键介绍
2021/01/15 Python
一款基于css3的列表toggle特效实例教程
2015/01/04 HTML / CSS
南非领先的在线旅行社:Travelstart南非
2016/09/04 全球购物
nohup的用法
2014/08/10 面试题
2014年公司庆元旦活动方案
2014/03/05 职场文书
实验室标语
2014/06/21 职场文书
不服从上级领导安排的检讨书
2014/09/14 职场文书
台风停课通知
2015/04/24 职场文书
2016党员干部廉洁自律心得体会
2016/01/13 职场文书
为什么你写的height:100%不起作用
2021/05/10 HTML / CSS
SpringRetry重试框架的具体使用
2021/07/25 Java/Android
SpringCloud Function SpEL注入漏洞分析及环境搭建
2022/04/08 Java/Android
Spring Data JPA框架的核心概念和Repository接口
2022/04/28 Java/Android